aboutsummaryrefslogtreecommitdiffstats
path: root/distrib/sdl-1.2.15/docs/man3/SDL_JoystickGetAxis.3
diff options
context:
space:
mode:
authorSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
committerSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
commita546c7006355a7bd1df4267ee53d0bfa2c017c8c (patch)
tree01be0bf6c0d6968e1468ec9661fd52110f9b05a7 /distrib/sdl-1.2.15/docs/man3/SDL_JoystickGetAxis.3
parentbaf3d7830396202df5cc47bd7bcee109c319cdb3 (diff)
parent0f809250987b64f491bd3b4b73c0f0d33036a786 (diff)
downloadexternal_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.zip
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.gz
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.bz2
Merge branch 'jb-mr1-release' of https://android.googlesource.com/platform/external/qemu into mr1-staging
Change-Id: I8a4a71ac65b08e6e17f26c942f67a15b85211115
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_JoystickGetAxis.3')
-rw-r--r--distrib/sdl-1.2.15/docs/man3/SDL_JoystickGetAxis.332
1 files changed, 32 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_JoystickGetAxis.3 b/distrib/sdl-1.2.15/docs/man3/SDL_JoystickGetAxis.3
new file mode 100644
index 0000000..0a80b34
--- /dev/null
+++ b/distrib/sdl-1.2.15/docs/man3/SDL_JoystickGetAxis.3
@@ -0,0 +1,32 @@
+.TH "SDL_JoystickGetAxis" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
+.SH "NAME"
+SDL_JoystickGetAxis \- Get the current state of an axis
+.SH "SYNOPSIS"
+.PP
+\fB#include "SDL\&.h"
+.sp
+\fBSint16 \fBSDL_JoystickGetAxis\fP\fR(\fBSDL_Joystick *joystick, int axis\fR);
+.SH "DESCRIPTION"
+.PP
+\fBSDL_JoystickGetAxis\fP returns the current state of the given \fBaxis\fR on the given \fBjoystick\fR\&.
+.PP
+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\&.
+.SH "RETURN VALUE"
+.PP
+Returns a 16-bit signed integer representing the current position of the \fBaxis\fR\&.
+.SH "EXAMPLES"
+.PP
+.PP
+.nf
+\f(CWSint16 x_move, y_move;
+SDL_Joystick *joy1;
+\&.
+\&.
+x_move=SDL_JoystickGetAxis(joy1, 0);
+y_move=SDL_JoystickGetAxis(joy1, 1);\fR
+.fi
+.PP
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_JoystickNumAxes\fP\fR
+.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00