Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_JoyButtonEvent.3 @ 55:55f1f1b3e27d
Added new docs for SDL 1.2.1
| author | Sam Lantinga <slouken@lokigames.com> |
|---|---|
| date | Sun, 10 Jun 2001 19:31:57 +0000 |
| parents | 74212992fb08 |
| children | e5bc29de3f0a |
| rev | line source |
|---|---|
|
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
1 .TH "SDL_JoyButtonEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" |
| 0 | 2 .SH "NAME" |
| 3 SDL_JoyButtonEvent\- Joystick button event structure | |
| 4 .SH "STRUCTURE DEFINITION" | |
| 5 .PP | |
| 6 .nf | |
| 7 \f(CWtypedef struct{ | |
| 8 Uint8 type; | |
| 9 Uint8 which; | |
| 10 Uint8 button; | |
| 11 Uint8 state; | |
| 12 } SDL_JoyButtonEvent;\fR | |
| 13 .fi | |
| 14 .PP | |
| 15 .SH "STRUCTURE DATA" | |
| 16 .TP 20 | |
| 17 \fBtype\fR | |
| 18 \fBSDL_JOYBUTTONDOWN\fP or \fBSDL_JOYBUTTONUP\fP | |
| 19 .TP 20 | |
| 20 \fBwhich\fR | |
| 21 Joystick device index | |
| 22 .TP 20 | |
| 23 \fBbutton\fR | |
| 24 Joystick button index | |
| 25 .TP 20 | |
| 26 \fBstate\fR | |
| 27 \fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP | |
| 28 .SH "DESCRIPTION" | |
| 29 .PP | |
| 30 \fBSDL_JoyButtonEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_JOYBUTTONDOWN\fP or \fBSDL_JOYBUTTONUP\fP is reported\&. | |
| 31 .PP | |
| 32 A \fBSDL_JOYBUTTONDOWN\fP or \fBSDL_JOYBUTTONUP\fP event occurs when ever a user presses or releases a button on a joystick\&. The field \fBwhich\fR is the index of the joystick that reported the event and \fBbutton\fR is the index of the button (for a more detailed explaination see the \fIJoystick section\fR)\&. \fBstate\fR is the current state or the button which is either \fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP\&. | |
| 33 .SH "SEE ALSO" | |
| 34 .PP | |
| 35 \fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetButton\fP\fR | |
|
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
36 ...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 |