view docs/man3/SDL_JoystickEventState.3 @ 2459:c330dcd78e3a gsoc2008_iphone

Grammar, spelling, clarity.
author Holmes Futrell <hfutrell@umail.ucsb.edu>
date Mon, 18 Aug 2008 18:01:24 +0000
parents 546f7c1eb755
children 1238da4a7112
line wrap: on
line source

.TH "SDL_JoystickEventState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_JoystickEventState \- Enable/disable joystick event polling
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBint \fBSDL_JoystickEventState\fP\fR(\fBint state\fR);
.SH "DESCRIPTION"
.PP
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\&.
.PP
.RS
\fBNote:  
.PP
Joystick event handling is prefered
.RE
.SH "RETURN VALUE"
.PP
If \fBstate\fR is \fBSDL_QUERY\fP then the current state is returned, otherwise the new processing \fBstate\fR is returned\&.
.SH "SEE ALSO"
.PP
\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
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59