docs/html/sdljoystickeventstate.html
changeset 3352 6dc250ebdd80
parent 3351 8e0182c236d8
child 3353 6b14223dd5c7
     1.1 --- a/docs/html/sdljoystickeventstate.html	Wed Oct 07 06:11:53 2009 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,290 +0,0 @@
     1.4 -<HTML
     1.5 -><HEAD
     1.6 -><TITLE
     1.7 ->SDL_JoystickEventState</TITLE
     1.8 -><META
     1.9 -NAME="GENERATOR"
    1.10 -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
    1.11 -"><LINK
    1.12 -REL="HOME"
    1.13 -TITLE="SDL Library Documentation"
    1.14 -HREF="index.html"><LINK
    1.15 -REL="UP"
    1.16 -TITLE="Event Functions."
    1.17 -HREF="eventfunctions.html"><LINK
    1.18 -REL="PREVIOUS"
    1.19 -TITLE="SDL_GetAppState"
    1.20 -HREF="sdlgetappstate.html"><LINK
    1.21 -REL="NEXT"
    1.22 -TITLE="Joystick"
    1.23 -HREF="joystick.html"></HEAD
    1.24 -><BODY
    1.25 -CLASS="REFENTRY"
    1.26 -BGCOLOR="#FFF8DC"
    1.27 -TEXT="#000000"
    1.28 -LINK="#0000ee"
    1.29 -VLINK="#551a8b"
    1.30 -ALINK="#ff0000"
    1.31 -><DIV
    1.32 -CLASS="NAVHEADER"
    1.33 -><TABLE
    1.34 -SUMMARY="Header navigation table"
    1.35 -WIDTH="100%"
    1.36 -BORDER="0"
    1.37 -CELLPADDING="0"
    1.38 -CELLSPACING="0"
    1.39 -><TR
    1.40 -><TH
    1.41 -COLSPAN="3"
    1.42 -ALIGN="center"
    1.43 ->SDL Library Documentation</TH
    1.44 -></TR
    1.45 -><TR
    1.46 -><TD
    1.47 -WIDTH="10%"
    1.48 -ALIGN="left"
    1.49 -VALIGN="bottom"
    1.50 -><A
    1.51 -HREF="sdlgetappstate.html"
    1.52 -ACCESSKEY="P"
    1.53 ->Prev</A
    1.54 -></TD
    1.55 -><TD
    1.56 -WIDTH="80%"
    1.57 -ALIGN="center"
    1.58 -VALIGN="bottom"
    1.59 -></TD
    1.60 -><TD
    1.61 -WIDTH="10%"
    1.62 -ALIGN="right"
    1.63 -VALIGN="bottom"
    1.64 -><A
    1.65 -HREF="joystick.html"
    1.66 -ACCESSKEY="N"
    1.67 ->Next</A
    1.68 -></TD
    1.69 -></TR
    1.70 -></TABLE
    1.71 -><HR
    1.72 -ALIGN="LEFT"
    1.73 -WIDTH="100%"></DIV
    1.74 -><H1
    1.75 -><A
    1.76 -NAME="SDLJOYSTICKEVENTSTATE"
    1.77 -></A
    1.78 ->SDL_JoystickEventState</H1
    1.79 -><DIV
    1.80 -CLASS="REFNAMEDIV"
    1.81 -><A
    1.82 -NAME="AEN5969"
    1.83 -></A
    1.84 -><H2
    1.85 ->Name</H2
    1.86 ->SDL_JoystickEventState&nbsp;--&nbsp;Enable/disable joystick event polling</DIV
    1.87 -><DIV
    1.88 -CLASS="REFSYNOPSISDIV"
    1.89 -><A
    1.90 -NAME="AEN5972"
    1.91 -></A
    1.92 -><H2
    1.93 ->Synopsis</H2
    1.94 -><DIV
    1.95 -CLASS="FUNCSYNOPSIS"
    1.96 -><A
    1.97 -NAME="AEN5973"
    1.98 -></A
    1.99 -><P
   1.100 -></P
   1.101 -><PRE
   1.102 -CLASS="FUNCSYNOPSISINFO"
   1.103 ->#include "SDL.h"</PRE
   1.104 -><P
   1.105 -><CODE
   1.106 -><CODE
   1.107 -CLASS="FUNCDEF"
   1.108 ->int <B
   1.109 -CLASS="FSFUNC"
   1.110 ->SDL_JoystickEventState</B
   1.111 -></CODE
   1.112 ->(int state);</CODE
   1.113 -></P
   1.114 -><P
   1.115 -></P
   1.116 -></DIV
   1.117 -></DIV
   1.118 -><DIV
   1.119 -CLASS="REFSECT1"
   1.120 -><A
   1.121 -NAME="AEN5979"
   1.122 -></A
   1.123 -><H2
   1.124 ->Description</H2
   1.125 -><P
   1.126 ->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
   1.127 -HREF="sdljoystickupdate.html"
   1.128 -><TT
   1.129 -CLASS="FUNCTION"
   1.130 ->SDL_JoystickUpdate</TT
   1.131 -></A
   1.132 -> and read the joystick information manually. <TT
   1.133 -CLASS="PARAMETER"
   1.134 -><I
   1.135 ->state</I
   1.136 -></TT
   1.137 -> is either <TT
   1.138 -CLASS="LITERAL"
   1.139 ->SDL_QUERY</TT
   1.140 ->, <TT
   1.141 -CLASS="LITERAL"
   1.142 ->SDL_ENABLE</TT
   1.143 -> or <TT
   1.144 -CLASS="LITERAL"
   1.145 ->SDL_IGNORE</TT
   1.146 ->.</P
   1.147 -><DIV
   1.148 -CLASS="NOTE"
   1.149 -><BLOCKQUOTE
   1.150 -CLASS="NOTE"
   1.151 -><P
   1.152 -><B
   1.153 ->Note: </B
   1.154 ->Joystick event handling is prefered</P
   1.155 -></BLOCKQUOTE
   1.156 -></DIV
   1.157 -></DIV
   1.158 -><DIV
   1.159 -CLASS="REFSECT1"
   1.160 -><A
   1.161 -NAME="AEN5990"
   1.162 -></A
   1.163 -><H2
   1.164 ->Return Value</H2
   1.165 -><P
   1.166 ->If <TT
   1.167 -CLASS="PARAMETER"
   1.168 -><I
   1.169 ->state</I
   1.170 -></TT
   1.171 -> is <TT
   1.172 -CLASS="LITERAL"
   1.173 ->SDL_QUERY</TT
   1.174 -> then the current state is returned, otherwise the new processing <TT
   1.175 -CLASS="PARAMETER"
   1.176 -><I
   1.177 ->state</I
   1.178 -></TT
   1.179 -> is returned.</P
   1.180 -></DIV
   1.181 -><DIV
   1.182 -CLASS="REFSECT1"
   1.183 -><A
   1.184 -NAME="AEN5996"
   1.185 -></A
   1.186 -><H2
   1.187 ->See Also</H2
   1.188 -><P
   1.189 -><A
   1.190 -HREF="joystick.html"
   1.191 ->SDL Joystick Functions</A
   1.192 ->,
   1.193 -<A
   1.194 -HREF="sdljoystickupdate.html"
   1.195 -><TT
   1.196 -CLASS="FUNCTION"
   1.197 ->SDL_JoystickUpdate</TT
   1.198 -></A
   1.199 ->,
   1.200 -<A
   1.201 -HREF="sdljoyaxisevent.html"
   1.202 -><SPAN
   1.203 -CLASS="STRUCTNAME"
   1.204 ->SDL_JoyAxisEvent</SPAN
   1.205 -></A
   1.206 ->,
   1.207 -<A
   1.208 -HREF="sdljoyballevent.html"
   1.209 -><SPAN
   1.210 -CLASS="STRUCTNAME"
   1.211 ->SDL_JoyBallEvent</SPAN
   1.212 -></A
   1.213 ->,
   1.214 -<A
   1.215 -HREF="sdljoybuttonevent.html"
   1.216 -><SPAN
   1.217 -CLASS="STRUCTNAME"
   1.218 ->SDL_JoyButtonEvent</SPAN
   1.219 -></A
   1.220 ->,
   1.221 -<A
   1.222 -HREF="sdljoyhatevent.html"
   1.223 -><SPAN
   1.224 -CLASS="STRUCTNAME"
   1.225 ->SDL_JoyHatEvent</SPAN
   1.226 -></A
   1.227 -></P
   1.228 -></DIV
   1.229 -><DIV
   1.230 -CLASS="NAVFOOTER"
   1.231 -><HR
   1.232 -ALIGN="LEFT"
   1.233 -WIDTH="100%"><TABLE
   1.234 -SUMMARY="Footer navigation table"
   1.235 -WIDTH="100%"
   1.236 -BORDER="0"
   1.237 -CELLPADDING="0"
   1.238 -CELLSPACING="0"
   1.239 -><TR
   1.240 -><TD
   1.241 -WIDTH="33%"
   1.242 -ALIGN="left"
   1.243 -VALIGN="top"
   1.244 -><A
   1.245 -HREF="sdlgetappstate.html"
   1.246 -ACCESSKEY="P"
   1.247 ->Prev</A
   1.248 -></TD
   1.249 -><TD
   1.250 -WIDTH="34%"
   1.251 -ALIGN="center"
   1.252 -VALIGN="top"
   1.253 -><A
   1.254 -HREF="index.html"
   1.255 -ACCESSKEY="H"
   1.256 ->Home</A
   1.257 -></TD
   1.258 -><TD
   1.259 -WIDTH="33%"
   1.260 -ALIGN="right"
   1.261 -VALIGN="top"
   1.262 -><A
   1.263 -HREF="joystick.html"
   1.264 -ACCESSKEY="N"
   1.265 ->Next</A
   1.266 -></TD
   1.267 -></TR
   1.268 -><TR
   1.269 -><TD
   1.270 -WIDTH="33%"
   1.271 -ALIGN="left"
   1.272 -VALIGN="top"
   1.273 ->SDL_GetAppState</TD
   1.274 -><TD
   1.275 -WIDTH="34%"
   1.276 -ALIGN="center"
   1.277 -VALIGN="top"
   1.278 -><A
   1.279 -HREF="eventfunctions.html"
   1.280 -ACCESSKEY="U"
   1.281 ->Up</A
   1.282 -></TD
   1.283 -><TD
   1.284 -WIDTH="33%"
   1.285 -ALIGN="right"
   1.286 -VALIGN="top"
   1.287 ->Joystick</TD
   1.288 -></TR
   1.289 -></TABLE
   1.290 -></DIV
   1.291 -></BODY
   1.292 -></HTML
   1.293 ->
   1.294 \ No newline at end of file