• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_EventState</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8"><LINK
9REL="HOME"
10TITLE="SDL Library Documentation"
11HREF="index.html"><LINK
12REL="UP"
13TITLE="Event Functions."
14HREF="eventfunctions.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_GetEventFilter"
17HREF="sdlgeteventfilter.html"><LINK
18REL="NEXT"
19TITLE="SDL_GetKeyState"
20HREF="sdlgetkeystate.html"></HEAD
21><BODY
22CLASS="REFENTRY"
23BGCOLOR="#FFF8DC"
24TEXT="#000000"
25LINK="#0000ee"
26VLINK="#551a8b"
27ALINK="#ff0000"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31SUMMARY="Header navigation table"
32WIDTH="100%"
33BORDER="0"
34CELLPADDING="0"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="3"
39ALIGN="center"
40>SDL Library Documentation</TH
41></TR
42><TR
43><TD
44WIDTH="10%"
45ALIGN="left"
46VALIGN="bottom"
47><A
48HREF="sdlgeteventfilter.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="sdlgetkeystate.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLEVENTSTATE"
74></A
75>SDL_EventState</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN5646"
80></A
81><H2
82>Name</H2
83>SDL_EventState&nbsp;--&nbsp;This function allows you to set the state of processing certain events.</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN5649"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN5650"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>Uint8 <B
106CLASS="FSFUNC"
107>SDL_EventState</B
108></CODE
109>(Uint8 type, int state);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN5656"
119></A
120><H2
121>Description</H2
122><P
123>This function allows you to set the state of processing certain event <TT
124CLASS="PARAMETER"
125><I
126>type</I
127></TT
128>'s.</P
129><P
130>If <TT
131CLASS="PARAMETER"
132><I
133>state</I
134></TT
135> is set to <TT
136CLASS="LITERAL"
137>SDL_IGNORE</TT
138>,
139that event <TT
140CLASS="PARAMETER"
141><I
142>type</I
143></TT
144> will be automatically dropped from the event queue and will
145not be filtered.</P
146><P
147>If <TT
148CLASS="PARAMETER"
149><I
150>state</I
151></TT
152> is set to <TT
153CLASS="LITERAL"
154>SDL_ENABLE</TT
155>,
156that event <TT
157CLASS="PARAMETER"
158><I
159>type</I
160></TT
161> will be processed normally.</P
162><P
163>If <TT
164CLASS="PARAMETER"
165><I
166>state</I
167></TT
168> is set to <TT
169CLASS="LITERAL"
170>SDL_QUERY</TT
171>,
172<TT
173CLASS="FUNCTION"
174>SDL_EventState</TT
175> will return the current processing
176state of the specified event <TT
177CLASS="PARAMETER"
178><I
179>type</I
180></TT
181>.</P
182><P
183>A list of event <TT
184CLASS="PARAMETER"
185><I
186>type</I
187></TT
188>'s can be found in the <A
189HREF="sdlevent.html"
190><SPAN
191CLASS="STRUCTNAME"
192>SDL_Event</SPAN
193></A
194> section.</P
195></DIV
196><DIV
197CLASS="REFSECT1"
198><A
199NAME="AEN5677"
200></A
201><H2
202>See Also</H2
203><P
204><A
205HREF="sdlevent.html"
206><SPAN
207CLASS="STRUCTNAME"
208>SDL_Event</SPAN
209></A
210></P
211></DIV
212><DIV
213CLASS="NAVFOOTER"
214><HR
215ALIGN="LEFT"
216WIDTH="100%"><TABLE
217SUMMARY="Footer navigation table"
218WIDTH="100%"
219BORDER="0"
220CELLPADDING="0"
221CELLSPACING="0"
222><TR
223><TD
224WIDTH="33%"
225ALIGN="left"
226VALIGN="top"
227><A
228HREF="sdlgeteventfilter.html"
229ACCESSKEY="P"
230>Prev</A
231></TD
232><TD
233WIDTH="34%"
234ALIGN="center"
235VALIGN="top"
236><A
237HREF="index.html"
238ACCESSKEY="H"
239>Home</A
240></TD
241><TD
242WIDTH="33%"
243ALIGN="right"
244VALIGN="top"
245><A
246HREF="sdlgetkeystate.html"
247ACCESSKEY="N"
248>Next</A
249></TD
250></TR
251><TR
252><TD
253WIDTH="33%"
254ALIGN="left"
255VALIGN="top"
256>SDL_GetEventFilter</TD
257><TD
258WIDTH="34%"
259ALIGN="center"
260VALIGN="top"
261><A
262HREF="eventfunctions.html"
263ACCESSKEY="U"
264>Up</A
265></TD
266><TD
267WIDTH="33%"
268ALIGN="right"
269VALIGN="top"
270>SDL_GetKeyState</TD
271></TR
272></TABLE
273></DIV
274></BODY
275></HTML
276>