docs/html/sdljoystickeventstate.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >SDL_JoystickEventState</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
   8 "><LINK
   9 REL="HOME"
  10 TITLE="SDL Library Documentation"
  11 HREF="index.html"><LINK
  12 REL="UP"
  13 TITLE="Event Functions."
  14 HREF="eventfunctions.html"><LINK
  15 REL="PREVIOUS"
  16 TITLE="SDL_GetAppState"
  17 HREF="sdlgetappstate.html"><LINK
  18 REL="NEXT"
  19 TITLE="Joystick"
  20 HREF="joystick.html"></HEAD
  21 ><BODY
  22 CLASS="REFENTRY"
  23 BGCOLOR="#FFF8DC"
  24 TEXT="#000000"
  25 LINK="#0000ee"
  26 VLINK="#551a8b"
  27 ALINK="#ff0000"
  28 ><DIV
  29 CLASS="NAVHEADER"
  30 ><TABLE
  31 SUMMARY="Header navigation table"
  32 WIDTH="100%"
  33 BORDER="0"
  34 CELLPADDING="0"
  35 CELLSPACING="0"
  36 ><TR
  37 ><TH
  38 COLSPAN="3"
  39 ALIGN="center"
  40 >SDL Library Documentation</TH
  41 ></TR
  42 ><TR
  43 ><TD
  44 WIDTH="10%"
  45 ALIGN="left"
  46 VALIGN="bottom"
  47 ><A
  48 HREF="sdlgetappstate.html"
  49 ACCESSKEY="P"
  50 >Prev</A
  51 ></TD
  52 ><TD
  53 WIDTH="80%"
  54 ALIGN="center"
  55 VALIGN="bottom"
  56 ></TD
  57 ><TD
  58 WIDTH="10%"
  59 ALIGN="right"
  60 VALIGN="bottom"
  61 ><A
  62 HREF="joystick.html"
  63 ACCESSKEY="N"
  64 >Next</A
  65 ></TD
  66 ></TR
  67 ></TABLE
  68 ><HR
  69 ALIGN="LEFT"
  70 WIDTH="100%"></DIV
  71 ><H1
  72 ><A
  73 NAME="SDLJOYSTICKEVENTSTATE"
  74 ></A
  75 >SDL_JoystickEventState</H1
  76 ><DIV
  77 CLASS="REFNAMEDIV"
  78 ><A
  79 NAME="AEN5969"
  80 ></A
  81 ><H2
  82 >Name</H2
  83 >SDL_JoystickEventState&nbsp;--&nbsp;Enable/disable joystick event polling</DIV
  84 ><DIV
  85 CLASS="REFSYNOPSISDIV"
  86 ><A
  87 NAME="AEN5972"
  88 ></A
  89 ><H2
  90 >Synopsis</H2
  91 ><DIV
  92 CLASS="FUNCSYNOPSIS"
  93 ><A
  94 NAME="AEN5973"
  95 ></A
  96 ><P
  97 ></P
  98 ><PRE
  99 CLASS="FUNCSYNOPSISINFO"
 100 >#include "SDL.h"</PRE
 101 ><P
 102 ><CODE
 103 ><CODE
 104 CLASS="FUNCDEF"
 105 >int <B
 106 CLASS="FSFUNC"
 107 >SDL_JoystickEventState</B
 108 ></CODE
 109 >(int state);</CODE
 110 ></P
 111 ><P
 112 ></P
 113 ></DIV
 114 ></DIV
 115 ><DIV
 116 CLASS="REFSECT1"
 117 ><A
 118 NAME="AEN5979"
 119 ></A
 120 ><H2
 121 >Description</H2
 122 ><P
 123 >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
 124 HREF="sdljoystickupdate.html"
 125 ><TT
 126 CLASS="FUNCTION"
 127 >SDL_JoystickUpdate</TT
 128 ></A
 129 > and read the joystick information manually. <TT
 130 CLASS="PARAMETER"
 131 ><I
 132 >state</I
 133 ></TT
 134 > is either <TT
 135 CLASS="LITERAL"
 136 >SDL_QUERY</TT
 137 >, <TT
 138 CLASS="LITERAL"
 139 >SDL_ENABLE</TT
 140 > or <TT
 141 CLASS="LITERAL"
 142 >SDL_IGNORE</TT
 143 >.</P
 144 ><DIV
 145 CLASS="NOTE"
 146 ><BLOCKQUOTE
 147 CLASS="NOTE"
 148 ><P
 149 ><B
 150 >Note: </B
 151 >Joystick event handling is prefered</P
 152 ></BLOCKQUOTE
 153 ></DIV
 154 ></DIV
 155 ><DIV
 156 CLASS="REFSECT1"
 157 ><A
 158 NAME="AEN5990"
 159 ></A
 160 ><H2
 161 >Return Value</H2
 162 ><P
 163 >If <TT
 164 CLASS="PARAMETER"
 165 ><I
 166 >state</I
 167 ></TT
 168 > is <TT
 169 CLASS="LITERAL"
 170 >SDL_QUERY</TT
 171 > then the current state is returned, otherwise the new processing <TT
 172 CLASS="PARAMETER"
 173 ><I
 174 >state</I
 175 ></TT
 176 > is returned.</P
 177 ></DIV
 178 ><DIV
 179 CLASS="REFSECT1"
 180 ><A
 181 NAME="AEN5996"
 182 ></A
 183 ><H2
 184 >See Also</H2
 185 ><P
 186 ><A
 187 HREF="joystick.html"
 188 >SDL Joystick Functions</A
 189 >,
 190 <A
 191 HREF="sdljoystickupdate.html"
 192 ><TT
 193 CLASS="FUNCTION"
 194 >SDL_JoystickUpdate</TT
 195 ></A
 196 >,
 197 <A
 198 HREF="sdljoyaxisevent.html"
 199 ><SPAN
 200 CLASS="STRUCTNAME"
 201 >SDL_JoyAxisEvent</SPAN
 202 ></A
 203 >,
 204 <A
 205 HREF="sdljoyballevent.html"
 206 ><SPAN
 207 CLASS="STRUCTNAME"
 208 >SDL_JoyBallEvent</SPAN
 209 ></A
 210 >,
 211 <A
 212 HREF="sdljoybuttonevent.html"
 213 ><SPAN
 214 CLASS="STRUCTNAME"
 215 >SDL_JoyButtonEvent</SPAN
 216 ></A
 217 >,
 218 <A
 219 HREF="sdljoyhatevent.html"
 220 ><SPAN
 221 CLASS="STRUCTNAME"
 222 >SDL_JoyHatEvent</SPAN
 223 ></A
 224 ></P
 225 ></DIV
 226 ><DIV
 227 CLASS="NAVFOOTER"
 228 ><HR
 229 ALIGN="LEFT"
 230 WIDTH="100%"><TABLE
 231 SUMMARY="Footer navigation table"
 232 WIDTH="100%"
 233 BORDER="0"
 234 CELLPADDING="0"
 235 CELLSPACING="0"
 236 ><TR
 237 ><TD
 238 WIDTH="33%"
 239 ALIGN="left"
 240 VALIGN="top"
 241 ><A
 242 HREF="sdlgetappstate.html"
 243 ACCESSKEY="P"
 244 >Prev</A
 245 ></TD
 246 ><TD
 247 WIDTH="34%"
 248 ALIGN="center"
 249 VALIGN="top"
 250 ><A
 251 HREF="index.html"
 252 ACCESSKEY="H"
 253 >Home</A
 254 ></TD
 255 ><TD
 256 WIDTH="33%"
 257 ALIGN="right"
 258 VALIGN="top"
 259 ><A
 260 HREF="joystick.html"
 261 ACCESSKEY="N"
 262 >Next</A
 263 ></TD
 264 ></TR
 265 ><TR
 266 ><TD
 267 WIDTH="33%"
 268 ALIGN="left"
 269 VALIGN="top"
 270 >SDL_GetAppState</TD
 271 ><TD
 272 WIDTH="34%"
 273 ALIGN="center"
 274 VALIGN="top"
 275 ><A
 276 HREF="eventfunctions.html"
 277 ACCESSKEY="U"
 278 >Up</A
 279 ></TD
 280 ><TD
 281 WIDTH="33%"
 282 ALIGN="right"
 283 VALIGN="top"
 284 >Joystick</TD
 285 ></TR
 286 ></TABLE
 287 ></DIV
 288 ></BODY
 289 ></HTML
 290 >