[sdl_omap.git] / docs / man3 / SDL_JoystickEventState.3

.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
Commit	Line	Data
e14743d1	1	.TH "SDL_JoystickEventState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
	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
	24	.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59