Mercurial > sdl-ios-xcode

comparison docs/html/sdljoystickeventstate.html @ 0:74212992fb08

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
comparison
equal deleted inserted replaced
-1:000000000000 0:74212992fb08
1 <HTML
2 ><HEAD
3 ><TITLE
4 >SDL_JoystickEventState</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.61
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 WIDTH="100%"
32 BORDER="0"
33 CELLPADDING="0"
34 CELLSPACING="0"
35 ><TR
36 ><TH
37 COLSPAN="3"
38 ALIGN="center"
39 >SDL Library Documentation</TH
40 ></TR
41 ><TR
42 ><TD
43 WIDTH="10%"
44 ALIGN="left"
45 VALIGN="bottom"
46 ><A
47 HREF="sdlgetappstate.html"
48 >Prev</A
49 ></TD
50 ><TD
51 WIDTH="80%"
52 ALIGN="center"
53 VALIGN="bottom"
54 ></TD
55 ><TD
56 WIDTH="10%"
57 ALIGN="right"
58 VALIGN="bottom"
59 ><A
60 HREF="joystick.html"
61 >Next</A
62 ></TD
63 ></TR
64 ></TABLE
65 ><HR
66 ALIGN="LEFT"
67 WIDTH="100%"></DIV
68 ><H1
69 ><A
70 NAME="SDLJOYSTICKEVENTSTATE"
71 >SDL_JoystickEventState</A
72 ></H1
73 ><DIV
74 CLASS="REFNAMEDIV"
75 ><A
76 NAME="AEN5347"
77 ></A
78 ><H2
79 >Name</H2
80 >SDL_JoystickEventState&nbsp;--&nbsp;Enable/disable joystick event polling</DIV
81 ><DIV
82 CLASS="REFSYNOPSISDIV"
83 ><A
84 NAME="AEN5350"
85 ></A
86 ><H2
87 >Synopsis</H2
88 ><DIV
89 CLASS="FUNCSYNOPSIS"
90 ><A
91 NAME="AEN5351"
92 ></A
93 ><P
94 ></P
95 ><PRE
96 CLASS="FUNCSYNOPSISINFO"
97 >#include "SDL.h"</PRE
98 ><P
99 ><CODE
100 ><CODE
101 CLASS="FUNCDEF"
102 >int <B
103 CLASS="FSFUNC"
104 >SDL_JoystickEventState</B
105 ></CODE
106 >(int state);</CODE
107 ></P
108 ><P
109 ></P
110 ></DIV
111 ></DIV
112 ><DIV
113 CLASS="REFSECT1"
114 ><A
115 NAME="AEN5357"
116 ></A
117 ><H2
118 >Description</H2
119 ><P
120 >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
121 HREF="sdljoystickupdate.html"
122 ><TT
123 CLASS="FUNCTION"
124 >SDL_JoystickUpdate</TT
125 ></A
126 > and read the joystick information manually. <TT
127 CLASS="PARAMETER"
128 ><I
129 >state</I
130 ></TT
131 > is either <TT
132 CLASS="LITERAL"
133 >SDL_QUERY</TT
134 >, <TT
135 CLASS="LITERAL"
136 >SDL_ENABLE</TT
137 > or <TT
138 CLASS="LITERAL"
139 >SDL_IGNORE</TT
140 >.</P
141 ><DIV
142 CLASS="NOTE"
143 ><BLOCKQUOTE
144 CLASS="NOTE"
145 ><P
146 ><B
147 >Note: </B
148 >Joystick event handling is prefered</P
149 ></BLOCKQUOTE
150 ></DIV
151 ></DIV
152 ><DIV
153 CLASS="REFSECT1"
154 ><A
155 NAME="AEN5368"
156 ></A
157 ><H2
158 >Return Value</H2
159 ><P
160 >If <TT
161 CLASS="PARAMETER"
162 ><I
163 >state</I
164 ></TT
165 > is <TT
166 CLASS="LITERAL"
167 >SDL_QUERY</TT
168 > then the current state is returned, otherwise the new processing <TT
169 CLASS="PARAMETER"
170 ><I
171 >state</I
172 ></TT
173 > is returned.</P
174 ></DIV
175 ><DIV
176 CLASS="REFSECT1"
177 ><A
178 NAME="AEN5374"
179 ></A
180 ><H2
181 >See Also</H2
182 ><P
183 ><A
184 HREF="joystick.html"
185 >SDL Joystick Functions</A
186 >,
187 <A
188 HREF="sdljoystickupdate.html"
189 ><TT
190 CLASS="FUNCTION"
191 >SDL_JoystickUpdate</TT
192 ></A
193 >,
194 <A
195 HREF="sdljoyaxisevent.html"
196 ><SPAN
197 CLASS="STRUCTNAME"
198 >SDL_JoyAxisEvent</SPAN
199 ></A
200 >,
201 <A
202 HREF="sdljoyballevent.html"
203 ><SPAN
204 CLASS="STRUCTNAME"
205 >SDL_JoyBallEvent</SPAN
206 ></A
207 >,
208 <A
209 HREF="sdljoybuttonevent.html"
210 ><SPAN
211 CLASS="STRUCTNAME"
212 >SDL_JoyButtonEvent</SPAN
213 ></A
214 >,
215 <A
216 HREF="sdljoyhatevent.html"
217 ><SPAN
218 CLASS="STRUCTNAME"
219 >SDL_JoyHatEvent</SPAN
220 ></A
221 ></P
222 ></DIV
223 ><DIV
224 CLASS="NAVFOOTER"
225 ><HR
226 ALIGN="LEFT"
227 WIDTH="100%"><TABLE
228 WIDTH="100%"
229 BORDER="0"
230 CELLPADDING="0"
231 CELLSPACING="0"
232 ><TR
233 ><TD
234 WIDTH="33%"
235 ALIGN="left"
236 VALIGN="top"
237 ><A
238 HREF="sdlgetappstate.html"
239 >Prev</A
240 ></TD
241 ><TD
242 WIDTH="34%"
243 ALIGN="center"
244 VALIGN="top"
245 ><A
246 HREF="index.html"
247 >Home</A
248 ></TD
249 ><TD
250 WIDTH="33%"
251 ALIGN="right"
252 VALIGN="top"
253 ><A
254 HREF="joystick.html"
255 >Next</A
256 ></TD
257 ></TR
258 ><TR
259 ><TD
260 WIDTH="33%"
261 ALIGN="left"
262 VALIGN="top"
263 >SDL_GetAppState</TD
264 ><TD
265 WIDTH="34%"
266 ALIGN="center"
267 VALIGN="top"
268 ><A
269 HREF="eventfunctions.html"
270 >Up</A
271 ></TD
272 ><TD
273 WIDTH="33%"
274 ALIGN="right"
275 VALIGN="top"
276 >Joystick</TD
277 ></TR
278 ></TABLE
279 ></DIV
280 ></BODY
281 ></HTML
282 >