Mercurial > sdl-ios-xcode
annotate docs/html/sdleventstate.html @ 181:e5bc29de3f0a
Updated from the SDL Documentation Project
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 14 Sep 2001 02:41:09 +0000 |
parents | 55f1f1b3e27d |
children | 355632dca928 |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_EventState</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
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_GetEventFilter" | |
17 HREF="sdlgeteventfilter.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_GetKeyState" | |
20 HREF="sdlgetkeystate.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="sdlgeteventfilter.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="sdlgetkeystate.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="SDLEVENTSTATE" | |
71 >SDL_EventState</A | |
72 ></H1 | |
73 ><DIV | |
74 CLASS="REFNAMEDIV" | |
75 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
76 NAME="AEN5258" |
0 | 77 ></A |
78 ><H2 | |
79 >Name</H2 | |
80 >SDL_EventState -- This function allows you to set the state of processing certain events.</DIV | |
81 ><DIV | |
82 CLASS="REFSYNOPSISDIV" | |
83 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
84 NAME="AEN5261" |
0 | 85 ></A |
86 ><H2 | |
87 >Synopsis</H2 | |
88 ><DIV | |
89 CLASS="FUNCSYNOPSIS" | |
90 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
91 NAME="AEN5262" |
0 | 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 >Uint8 <B | |
103 CLASS="FSFUNC" | |
104 >SDL_EventState</B | |
105 ></CODE | |
106 >(Uint8 type, int state);</CODE | |
107 ></P | |
108 ><P | |
109 ></P | |
110 ></DIV | |
111 ></DIV | |
112 ><DIV | |
113 CLASS="REFSECT1" | |
114 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
115 NAME="AEN5268" |
0 | 116 ></A |
117 ><H2 | |
118 >Description</H2 | |
119 ><P | |
120 >This function allows you to set the state of processing certain event <TT | |
121 CLASS="PARAMETER" | |
122 ><I | |
123 >type</I | |
124 ></TT | |
125 >'s.</P | |
126 ><P | |
127 >If <TT | |
128 CLASS="PARAMETER" | |
129 ><I | |
130 >state</I | |
131 ></TT | |
132 > is set to <TT | |
133 CLASS="LITERAL" | |
134 >SDL_IGNORE</TT | |
135 >, | |
136 that event <TT | |
137 CLASS="PARAMETER" | |
138 ><I | |
139 >type</I | |
140 ></TT | |
141 > will be automatically dropped from the event queue and will | |
142 not be filtered.</P | |
143 ><P | |
144 >If <TT | |
145 CLASS="PARAMETER" | |
146 ><I | |
147 >state</I | |
148 ></TT | |
149 > is set to <TT | |
150 CLASS="LITERAL" | |
151 >SDL_ENABLE</TT | |
152 >, | |
153 that event <TT | |
154 CLASS="PARAMETER" | |
155 ><I | |
156 >type</I | |
157 ></TT | |
158 > will be processed normally.</P | |
159 ><P | |
160 >If <TT | |
161 CLASS="PARAMETER" | |
162 ><I | |
163 >state</I | |
164 ></TT | |
165 > is set to <TT | |
166 CLASS="LITERAL" | |
167 >SDL_QUERY</TT | |
168 >, | |
169 <TT | |
170 CLASS="FUNCTION" | |
171 >SDL_EventState</TT | |
172 > will return the current processing | |
173 state of the specified event <TT | |
174 CLASS="PARAMETER" | |
175 ><I | |
176 >type</I | |
177 ></TT | |
178 >.</P | |
179 ><P | |
180 >A list of event <TT | |
181 CLASS="PARAMETER" | |
182 ><I | |
183 >type</I | |
184 ></TT | |
185 >'s can be found in the <A | |
186 HREF="sdlevent.html" | |
187 ><SPAN | |
188 CLASS="STRUCTNAME" | |
189 >SDL_Event</SPAN | |
190 ></A | |
191 > section.</P | |
192 ></DIV | |
193 ><DIV | |
194 CLASS="REFSECT1" | |
195 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
196 NAME="AEN5289" |
0 | 197 ></A |
198 ><H2 | |
199 >See Also</H2 | |
200 ><P | |
201 ><A | |
202 HREF="sdlevent.html" | |
203 ><SPAN | |
204 CLASS="STRUCTNAME" | |
205 >SDL_Event</SPAN | |
206 ></A | |
207 ></P | |
208 ></DIV | |
209 ><DIV | |
210 CLASS="NAVFOOTER" | |
211 ><HR | |
212 ALIGN="LEFT" | |
213 WIDTH="100%"><TABLE | |
214 WIDTH="100%" | |
215 BORDER="0" | |
216 CELLPADDING="0" | |
217 CELLSPACING="0" | |
218 ><TR | |
219 ><TD | |
220 WIDTH="33%" | |
221 ALIGN="left" | |
222 VALIGN="top" | |
223 ><A | |
224 HREF="sdlgeteventfilter.html" | |
225 >Prev</A | |
226 ></TD | |
227 ><TD | |
228 WIDTH="34%" | |
229 ALIGN="center" | |
230 VALIGN="top" | |
231 ><A | |
232 HREF="index.html" | |
233 >Home</A | |
234 ></TD | |
235 ><TD | |
236 WIDTH="33%" | |
237 ALIGN="right" | |
238 VALIGN="top" | |
239 ><A | |
240 HREF="sdlgetkeystate.html" | |
241 >Next</A | |
242 ></TD | |
243 ></TR | |
244 ><TR | |
245 ><TD | |
246 WIDTH="33%" | |
247 ALIGN="left" | |
248 VALIGN="top" | |
249 >SDL_GetEventFilter</TD | |
250 ><TD | |
251 WIDTH="34%" | |
252 ALIGN="center" | |
253 VALIGN="top" | |
254 ><A | |
255 HREF="eventfunctions.html" | |
256 >Up</A | |
257 ></TD | |
258 ><TD | |
259 WIDTH="33%" | |
260 ALIGN="right" | |
261 VALIGN="top" | |
262 >SDL_GetKeyState</TD | |
263 ></TR | |
264 ></TABLE | |
265 ></DIV | |
266 ></BODY | |
267 ></HTML | |
268 > |