X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..65baafba0e8cd74f2264b7e2f7625ff5bea84864:/docs/latex/wx/joystick.tex diff --git a/docs/latex/wx/joystick.tex b/docs/latex/wx/joystick.tex index f9c03f49fb..4f92e49a41 100644 --- a/docs/latex/wx/joystick.tex +++ b/docs/latex/wx/joystick.tex @@ -16,14 +16,14 @@ wxJoystick allows an application to control one or more joysticks. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxJoystick::wxJoystick}\label{wxjoystickconstr} +\membersection{wxJoystick::wxJoystick}\label{wxjoystickctor} \func{}{wxJoystick}{\param{int}{ joystick = wxJOYSTICK1}} Constructor. {\it joystick} may be one of wxJOYSTICK1, wxJOYSTICK2, indicating the joystick controller of interest. -\membersection{wxJoystick::\destruct{wxJoystick}} +\membersection{wxJoystick::\destruct{wxJoystick}}\label{wxjoystickdtor} \func{}{\destruct{wxJoystick}}{\void} @@ -33,8 +33,11 @@ Destroys the wxJoystick object. \constfunc{int}{GetButtonState}{\void} -Returns the state of the joystick buttons. A bitlist of wxJOY\_BUTTONn identifiers, -where n is 1, 2, 3 or 4. +Returns the state of the joystick buttons. Every button is mapped to a single +bit in the returned integer, with the first button being mapped to the least +significant bit, and so on. +A bitlist of wxJOY\_BUTTONn identifiers, where n is 1, 2, 3 or 4 +is available for historical reasons. \membersection{wxJoystick::GetManufacturerId}\label{wxjoystickgetmanufacturerid} @@ -101,13 +104,16 @@ Returns the x, y position of the joystick. \constfunc{int}{GetPOVPosition}{\void} -Returns the point-of-view position, expressed in discrete units. +Returns the point-of-view position, expressed in continuous, one-hundredth of a degree units, +but limited to return 0, 9000, 18000 or 27000. +Returns -1 on error. \membersection{wxJoystick::GetPOVCTSPosition}\label{wxjoystickgetpovctsposition} \constfunc{int}{GetPOVCTSPosition}{\void} Returns the point-of-view position, expressed in continuous, one-hundredth of a degree units. +Returns -1 on error. \membersection{wxJoystick::GetRudderMax}\label{wxjoystickgetruddermax} @@ -195,7 +201,7 @@ Returns the maximum z position. \membersection{wxJoystick::GetZMin}\label{wxjoystickgetzmin} -\constfunc{int}{GetXMin}{\void} +\constfunc{int}{GetZMin}{\void} Returns the minimum z position. @@ -209,49 +215,49 @@ Returns the z position of the joystick. \constfunc{bool}{HasPOV}{\void} -Returns TRUE if the joystick has a point of view control. +Returns true if the joystick has a point of view control. \membersection{wxJoystick::HasPOV4Dir}\label{wxjoystickhaspovfdir} \constfunc{bool}{HasPOV4Dir}{\void} -Returns TRUE if the joystick point-of-view supports discrete values (centered, forward, backward, left, and right). +Returns true if the joystick point-of-view supports discrete values (centered, forward, backward, left, and right). \membersection{wxJoystick::HasPOVCTS}\label{wxjoystickhaspovcts} \constfunc{bool}{HasPOVCTS}{\void} -Returns TRUE if the joystick point-of-view supports continuous degree bearings. +Returns true if the joystick point-of-view supports continuous degree bearings. \membersection{wxJoystick::HasRudder}\label{wxjoystickhasrudder} \constfunc{bool}{HasRudder}{\void} -Returns TRUE if there is a rudder attached to the computer. +Returns true if there is a rudder attached to the computer. \membersection{wxJoystick::HasU}\label{wxjoystickhasu} \constfunc{bool}{HasU}{\void} -Returns TRUE if the joystick has a U axis. +Returns true if the joystick has a U axis. \membersection{wxJoystick::HasV}\label{wxjoystickhasv} \constfunc{bool}{HasV}{\void} -Returns TRUE if the joystick has a V axis. +Returns true if the joystick has a V axis. \membersection{wxJoystick::HasZ}\label{wxjoystickhasz} \constfunc{bool}{HasZ}{\void} -Returns TRUE if the joystick has a Z axis. +Returns true if the joystick has a Z axis. \membersection{wxJoystick::IsOk}\label{wxjoystickisok} \constfunc{bool}{IsOk}{\void} -Returns TRUE if the joystick is functioning. +Returns true if the joystick is functioning. \membersection{wxJoystick::ReleaseCapture}\label{wxjoystickreleasecapture} @@ -261,7 +267,7 @@ Releases the capture set by {\bf SetCapture}. \wxheading{Return value} -TRUE if the capture release succeeded. +true if the capture release succeeded. \wxheading{See also} @@ -282,7 +288,7 @@ threshold. If greater than zero, events are received every {\it pollingFreq} mil \wxheading{Return value} -TRUE if the capture succeeded. +true if the capture succeeded. \wxheading{See also}