diff docs/man3/SDL_JoystickEventState.3 @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man3/SDL_JoystickEventState.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,24 @@
+.TH "SDL_JoystickEventState" "3" "Mon 12 Mar 2001, 01:03" "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, Mon 12 Mar 2001, 01:03