Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_JoystickEventState.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_JoystickEventState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" |
| 0 | 2 .SH "NAME" |
| 3 SDL_JoystickEventState\- Enable/disable joystick event polling | |
| 4 .SH "SYNOPSIS" | |
| 5 .PP | |
| 6 \fB#include "SDL\&.h" | |
| 7 .sp | |
| 8 \fBint \fBSDL_JoystickEventState\fP\fR(\fBint state\fR); | |
| 9 .SH "DESCRIPTION" | |
| 10 .PP | |
| 11 This function is used to enable or disable joystick event processing\&. With joystick event processing disabled you will have to update joystick states with \fI\fBSDL_JoystickUpdate\fP\fR and read the joystick information manually\&. \fBstate\fR is either \fBSDL_QUERY\fP, \fBSDL_ENABLE\fP or \fBSDL_IGNORE\fP\&. | |
| 12 .PP | |
| 13 .RS | |
| 14 \fBNote: | |
| 15 .PP | |
| 16 Joystick event handling is prefered | |
| 17 .RE | |
| 18 .SH "RETURN VALUE" | |
| 19 .PP | |
| 20 If \fBstate\fR is \fBSDL_QUERY\fP then the current state is returned, otherwise the new processing \fBstate\fR is returned\&. | |
| 21 .SH "SEE ALSO" | |
| 22 .PP | |
| 23 \fISDL Joystick Functions\fR, \fI\fBSDL_JoystickUpdate\fP\fR, \fI\fBSDL_JoyAxisEvent\fR\fR, \fI\fBSDL_JoyBallEvent\fR\fR, \fI\fBSDL_JoyButtonEvent\fR\fR, \fI\fBSDL_JoyHatEvent\fR\fR | |
|
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
24 ...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 |