Initial bulk commit for "Git on MSys"
[msysgit/historical-msysgit.git] / mingw / man / man3 / SDL_JoyAxisEvent.3
blobe2e783d7cec832332ebcabeaca862908fc34fa82
1 .TH "SDL_JoyAxisEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
2 .SH "NAME"
3 SDL_JoyAxisEvent\- Joystick axis motion event structure
4 .SH "STRUCTURE DEFINITION"
5 .PP
6 .nf
7 \f(CWtypedef struct{
8   Uint8 type;
9   Uint8 which;
10   Uint8 axis;
11   Sint16 value;
12 } SDL_JoyAxisEvent;\fR
13 .fi
14 .PP
15 .SH "STRUCTURE DATA"
16 .TP 20
17 \fBtype\fR
18 \fBSDL_JOYAXISMOTION\fP
19 .TP 20
20 \fBwhich\fR
21 Joystick device index
22 .TP 20
23 \fBaxis\fR
24 Joystick axis index
25 .TP 20
26 \fBvalue\fR
27 Axis value (range: -32768 to 32767)
28 .SH "DESCRIPTION"
29 .PP
30 \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\&.
31 .PP
32 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\&.
33 .SH "SEE ALSO"
34 .PP
35 \fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetAxis\fP\fR
36 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59