Mercurial > sdl-ios-xcode
annotate docs/html/sdljoystickeventstate.html @ 3261:72b542f34739
The new, cleaner, version of the atomic operations. The dummy code is what you should start working with to port atomic ops.
The linux code appears to be complete and *should* be the base of all Unix and GCC based versions. The macosx and win32 versions
are currently just copies of the dummy code. I will begin working on the windows version as soon as this check in is done. I
need someone to work on the Mac OS X version.
I'm afraid that this check in will break QNX (Sorry!)
author | Bob Pendleton <bob@pendleton.com> |
---|---|
date | Thu, 17 Sep 2009 20:35:12 +0000 |
parents | 355632dca928 |
children |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_JoystickEventState</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
0 | 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 | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
31 SUMMARY="Header navigation table" |
0 | 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" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
49 ACCESSKEY="P" |
0 | 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" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
63 ACCESSKEY="N" |
0 | 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" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
74 ></A |
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
75 >SDL_JoystickEventState</H1 |
0 | 76 ><DIV |
77 CLASS="REFNAMEDIV" | |
78 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
79 NAME="AEN5969" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
83 >SDL_JoystickEventState -- Enable/disable joystick event polling</DIV | |
84 ><DIV | |
85 CLASS="REFSYNOPSISDIV" | |
86 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
87 NAME="AEN5972" |
0 | 88 ></A |
89 ><H2 | |
90 >Synopsis</H2 | |
91 ><DIV | |
92 CLASS="FUNCSYNOPSIS" | |
93 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
94 NAME="AEN5973" |
0 | 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 | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
118 NAME="AEN5979" |
0 | 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 | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
158 NAME="AEN5990" |
0 | 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 | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
181 NAME="AEN5996" |
0 | 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 | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
231 SUMMARY="Footer navigation table" |
0 | 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" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
243 ACCESSKEY="P" |
0 | 244 >Prev</A |
245 ></TD | |
246 ><TD | |
247 WIDTH="34%" | |
248 ALIGN="center" | |
249 VALIGN="top" | |
250 ><A | |
251 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
252 ACCESSKEY="H" |
0 | 253 >Home</A |
254 ></TD | |
255 ><TD | |
256 WIDTH="33%" | |
257 ALIGN="right" | |
258 VALIGN="top" | |
259 ><A | |
260 HREF="joystick.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
261 ACCESSKEY="N" |
0 | 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" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
277 ACCESSKEY="U" |
0 | 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 > |