docs/man3/SDL_JoystickGetAxis.3
changeset 0 74212992fb08
child 55 55f1f1b3e27d
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/man3/SDL_JoystickGetAxis.3	Thu Apr 26 16:45:43 2001 +0000
     1.3 @@ -0,0 +1,32 @@
     1.4 +.TH "SDL_JoystickGetAxis" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" 
     1.5 +.SH "NAME"
     1.6 +SDL_JoystickGetAxis\- Get the current state of an axis
     1.7 +.SH "SYNOPSIS"
     1.8 +.PP
     1.9 +\fB#include "SDL\&.h"
    1.10 +.sp
    1.11 +\fBSint16 \fBSDL_JoystickGetAxis\fP\fR(\fBSDL_Joystick *joystick, int axis\fR);
    1.12 +.SH "DESCRIPTION"
    1.13 +.PP
    1.14 +\fBSDL_JoystickGetAxis\fP returns the current state of the given \fBaxis\fR on the given \fBjoystick\fR\&.
    1.15 +.PP
    1.16 +On most modern joysticks the X axis is usually represented by \fBaxis\fR 0 and the Y axis by \fBaxis\fR 1\&. The value returned by \fBSDL_JoystickGetAxis\fP is a signed integer (-32768 to 32768) representing the current position of the \fBaxis\fR, it maybe necessary to impose certain tolerances on these values to account for jitter\&. It is worth noting that some joysticks use axes 2 and 3 for extra buttons\&.
    1.17 +.SH "RETURN VALUE"
    1.18 +.PP
    1.19 +Returns a 16-bit signed integer representing the current position of the \fBaxis\fR\&.
    1.20 +.SH "EXAMPLES"
    1.21 +.PP
    1.22 +.PP
    1.23 +.nf
    1.24 +\f(CWSint16 x_move, y_move;
    1.25 +SDL_Joystick *joy1;
    1.26 +\&.
    1.27 +\&.
    1.28 +x_move=SDL_JoystickGetAxis(joy1, 0);
    1.29 +y_move=SDL_JoystickGetAxis(joy1, 1);\fR
    1.30 +.fi
    1.31 +.PP
    1.32 +.SH "SEE ALSO"
    1.33 +.PP
    1.34 +\fI\fBSDL_JoystickNumAxes\fP\fR
    1.35 +...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03