X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..a607d8d633e055fc5cea22c0b829cd65b5c3dbfb:/docs/latex/wx/joystick.tex?ds=sidebyside diff --git a/docs/latex/wx/joystick.tex b/docs/latex/wx/joystick.tex index 72c473017f..1b1ca2cb85 100644 --- a/docs/latex/wx/joystick.tex +++ b/docs/latex/wx/joystick.tex @@ -10,20 +10,24 @@ wxJoystick allows an application to control one or more joysticks. +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + \wxheading{See also} \helpref{wxJoystickEvent}{wxjoystickevent} \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} @@ -39,6 +43,14 @@ significant bit, and so on. A bitlist of wxJOY\_BUTTONn identifiers, where n is 1, 2, 3 or 4 is available for historical reasons. +\constfunc{bool}{GetButtonState}{\param{unsigned}{ id}} + +Returns the state of the specified joystick button. + +\wxheading{Parameters} + +\docparam{id}{The button id to report, from 0 to \helpref{GetNumberButtons()}{wxjoystickgetnumberbuttons} - 1} + \membersection{wxJoystick::GetManufacturerId}\label{wxjoystickgetmanufacturerid} \constfunc{int}{GetManufacturerId}{\void} @@ -66,7 +78,7 @@ Returns the number of buttons for this joystick. \membersection{wxJoystick::GetNumberJoysticks}\label{wxjoystickgetnumberjoysticks} -\constfunc{int}{GetNumberJoysticks}{\void} +\func{static int}{GetNumberJoysticks}{\void} Returns the number of joysticks currently attached to the computer. @@ -100,6 +112,14 @@ Returns the product name for the joystick. Returns the x, y position of the joystick. +\constfunc{int}{GetPosition}{\param{unsigned}{ axis}} + +Returns the position of the specified joystick axis. + +\wxheading{Parameters} + +\docparam{axis}{The joystick axis to report, from 0 to \helpref{GetNumberAxes()}{wxjoystickgetnumberaxes} - 1.} + \membersection{wxJoystick::GetPOVPosition}\label{wxjoystickgetpovposition} \constfunc{int}{GetPOVPosition}{\void} @@ -201,7 +221,7 @@ Returns the maximum z position. \membersection{wxJoystick::GetZMin}\label{wxjoystickgetzmin} -\constfunc{int}{GetXMin}{\void} +\constfunc{int}{GetZMin}{\void} Returns the minimum z position.