aboutsummaryrefslogtreecommitdiffstats
path: root/distrib/sdl-1.2.15/docs/man3/SDL_JoyAxisEvent.3
diff options
context:
space:
mode:
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_JoyAxisEvent.3')
-rw-r--r--distrib/sdl-1.2.15/docs/man3/SDL_JoyAxisEvent.336
1 files changed, 36 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_JoyAxisEvent.3 b/distrib/sdl-1.2.15/docs/man3/SDL_JoyAxisEvent.3
new file mode 100644
index 0000000..f8301fd
--- /dev/null
+++ b/distrib/sdl-1.2.15/docs/man3/SDL_JoyAxisEvent.3
@@ -0,0 +1,36 @@
+.TH "SDL_JoyAxisEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
+.SH "NAME"
+SDL_JoyAxisEvent \- Joystick axis motion event structure
+.SH "STRUCTURE DEFINITION"
+.PP
+.nf
+\f(CWtypedef struct{
+ Uint8 type;
+ Uint8 which;
+ Uint8 axis;
+ Sint16 value;
+} SDL_JoyAxisEvent;\fR
+.fi
+.PP
+.SH "STRUCTURE DATA"
+.TP 20
+\fBtype\fR
+\fBSDL_JOYAXISMOTION\fP
+.TP 20
+\fBwhich\fR
+Joystick device index
+.TP 20
+\fBaxis\fR
+Joystick axis index
+.TP 20
+\fBvalue\fR
+Axis value (range: -32768 to 32767)
+.SH "DESCRIPTION"
+.PP
+\fBSDL_JoyAxisEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_JOYAXISMOTION\fP is reported\&.
+.PP
+A \fBSDL_JOYAXISMOTION\fP event occurs when ever a user moves an axis on the joystick\&. The field \fBwhich\fR is the index of the joystick that reported the event and \fBaxis\fR is the index of the axis (for a more detailed explaination see the \fIJoystick section\fR)\&. \fBvalue\fR is the current position of the axis\&.
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetAxis\fP\fR
+.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59