Mercurial > sdl-ios-xcode
diff docs/html/sdljoystickeventstate.html @ 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/html/sdljoystickeventstate.html Thu Apr 26 16:45:43 2001 +0000 @@ -0,0 +1,282 @@ +<HTML +><HEAD +><TITLE +>SDL_JoystickEventState</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.61 +"><LINK +REL="HOME" +TITLE="SDL Library Documentation" +HREF="index.html"><LINK +REL="UP" +TITLE="Event Functions." +HREF="eventfunctions.html"><LINK +REL="PREVIOUS" +TITLE="SDL_GetAppState" +HREF="sdlgetappstate.html"><LINK +REL="NEXT" +TITLE="Joystick" +HREF="joystick.html"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFF8DC" +TEXT="#000000" +LINK="#0000ee" +VLINK="#551a8b" +ALINK="#ff0000" +><DIV +CLASS="NAVHEADER" +><TABLE +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>SDL Library Documentation</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="sdlgetappstate.html" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +></TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="joystick.html" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><H1 +><A +NAME="SDLJOYSTICKEVENTSTATE" +>SDL_JoystickEventState</A +></H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN5347" +></A +><H2 +>Name</H2 +>SDL_JoystickEventState -- Enable/disable joystick event polling</DIV +><DIV +CLASS="REFSYNOPSISDIV" +><A +NAME="AEN5350" +></A +><H2 +>Synopsis</H2 +><DIV +CLASS="FUNCSYNOPSIS" +><A +NAME="AEN5351" +></A +><P +></P +><PRE +CLASS="FUNCSYNOPSISINFO" +>#include "SDL.h"</PRE +><P +><CODE +><CODE +CLASS="FUNCDEF" +>int <B +CLASS="FSFUNC" +>SDL_JoystickEventState</B +></CODE +>(int state);</CODE +></P +><P +></P +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN5357" +></A +><H2 +>Description</H2 +><P +>This function is used to enable or disable joystick event processing. With joystick event processing disabled you will have to update joystick states with <A +HREF="sdljoystickupdate.html" +><TT +CLASS="FUNCTION" +>SDL_JoystickUpdate</TT +></A +> and read the joystick information manually. <TT +CLASS="PARAMETER" +><I +>state</I +></TT +> is either <TT +CLASS="LITERAL" +>SDL_QUERY</TT +>, <TT +CLASS="LITERAL" +>SDL_ENABLE</TT +> or <TT +CLASS="LITERAL" +>SDL_IGNORE</TT +>.</P +><DIV +CLASS="NOTE" +><BLOCKQUOTE +CLASS="NOTE" +><P +><B +>Note: </B +>Joystick event handling is prefered</P +></BLOCKQUOTE +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN5368" +></A +><H2 +>Return Value</H2 +><P +>If <TT +CLASS="PARAMETER" +><I +>state</I +></TT +> is <TT +CLASS="LITERAL" +>SDL_QUERY</TT +> then the current state is returned, otherwise the new processing <TT +CLASS="PARAMETER" +><I +>state</I +></TT +> is returned.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN5374" +></A +><H2 +>See Also</H2 +><P +><A +HREF="joystick.html" +>SDL Joystick Functions</A +>, +<A +HREF="sdljoystickupdate.html" +><TT +CLASS="FUNCTION" +>SDL_JoystickUpdate</TT +></A +>, +<A +HREF="sdljoyaxisevent.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_JoyAxisEvent</SPAN +></A +>, +<A +HREF="sdljoyballevent.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_JoyBallEvent</SPAN +></A +>, +<A +HREF="sdljoybuttonevent.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_JoyButtonEvent</SPAN +></A +>, +<A +HREF="sdljoyhatevent.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_JoyHatEvent</SPAN +></A +></P +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="sdlgetappstate.html" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="joystick.html" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>SDL_GetAppState</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="eventfunctions.html" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>Joystick</TD +></TR +></TABLE +></DIV +></BODY +></HTML +> \ No newline at end of file