Mercurial > sdl-ios-xcode

comparison docs/html/sdlpeepevents.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_PeepEvents</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_PumpEvents"
17 HREF="sdlpumpevents.html"><LINK
18 REL="NEXT"
19 TITLE="SDL_PollEvent"
20 HREF="sdlpollevent.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="sdlpumpevents.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="sdlpollevent.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="SDLPEEPEVENTS"
71 >SDL_PeepEvents</A
72 ></H1
73 ><DIV
74 CLASS="REFNAMEDIV"
75 ><A
76 NAME="AEN4807"
77 ></A
78 ><H2
79 >Name</H2
80 >SDL_PeepEvents&nbsp;--&nbsp;Checks the event queue for messages and optionally returns them.</DIV
81 ><DIV
82 CLASS="REFSYNOPSISDIV"
83 ><A
84 NAME="AEN4810"
85 ></A
86 ><H2
87 >Synopsis</H2
88 ><DIV
89 CLASS="FUNCSYNOPSIS"
90 ><A
91 NAME="AEN4811"
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_PeepEvents</B
105 ></CODE
106 >(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask);</CODE
107 ></P
108 ><P
109 ></P
110 ></DIV
111 ></DIV
112 ><DIV
113 CLASS="REFSECT1"
114 ><A
115 NAME="AEN4817"
116 ></A
117 ><H2
118 >Description</H2
119 ><P
120 >Checks the event queue for messages and optionally returns them.</P
121 ><P
122 >If <TT
123 CLASS="PARAMETER"
124 ><I
125 >action</I
126 ></TT
127 > is <TT
128 CLASS="LITERAL"
129 >SDL_ADDEVENT</TT
130 >, up to
131 <TT
132 CLASS="PARAMETER"
133 ><I
134 >numevents</I
135 ></TT
136 > events will be added to the back of the event
137 queue.</P
138 ><P
139 >If <TT
140 CLASS="PARAMETER"
141 ><I
142 >action</I
143 ></TT
144 > is <TT
145 CLASS="LITERAL"
146 >SDL_PEEKEVENT</TT
147 >, up to
148 <TT
149 CLASS="PARAMETER"
150 ><I
151 >numevents</I
152 ></TT
153 > events at the front of the event queue,
154 matching <A
155 HREF="sdlevent.html"
156 ><TT
157 CLASS="PARAMETER"
158 ><I
159 >mask</I
160 ></TT
161 ></A
162 >,
163 will be returned and will not be removed from the queue.</P
164 ><P
165 >If <TT
166 CLASS="PARAMETER"
167 ><I
168 >action</I
169 ></TT
170 > is <TT
171 CLASS="LITERAL"
172 >SDL_GETEVENT</TT
173 >, up to
174 <TT
175 CLASS="PARAMETER"
176 ><I
177 >numevents</I
178 ></TT
179 > events at the front of the event queue,
180 matching <A
181 HREF="sdlevent.html"
182 ><TT
183 CLASS="PARAMETER"
184 ><I
185 >mask</I
186 ></TT
187 ></A
188 >,
189 will be returned and will be removed from the queue.</P
190 ><P
191 >This function is thread-safe.</P
192 ></DIV
193 ><DIV
194 CLASS="REFSECT1"
195 ><A
196 NAME="AEN4837"
197 ></A
198 ><H2
199 >Return Value</H2
200 ><P
201 >This function returns the number of events actually stored, or
202 <SPAN
203 CLASS="RETURNVALUE"
204 >-1</SPAN
205 > if there was an error. </P
206 ></DIV
207 ><DIV
208 CLASS="REFSECT1"
209 ><A
210 NAME="AEN4841"
211 ></A
212 ><H2
213 >See Also</H2
214 ><P
215 ><A
216 HREF="sdlevent.html"
217 ><SPAN
218 CLASS="STRUCTNAME"
219 >SDL_Event</SPAN
220 ></A
221 >,
222 <A
223 HREF="sdlpollevent.html"
224 ><TT
225 CLASS="FUNCTION"
226 >SDL_PollEvent</TT
227 ></A
228 >,
229 <A
230 HREF="sdlpushevent.html"
231 ><TT
232 CLASS="FUNCTION"
233 >SDL_PushEvent</TT
234 ></A
235 ></P
236 ></DIV
237 ><DIV
238 CLASS="NAVFOOTER"
239 ><HR
240 ALIGN="LEFT"
241 WIDTH="100%"><TABLE
242 WIDTH="100%"
243 BORDER="0"
244 CELLPADDING="0"
245 CELLSPACING="0"
246 ><TR
247 ><TD
248 WIDTH="33%"
249 ALIGN="left"
250 VALIGN="top"
251 ><A
252 HREF="sdlpumpevents.html"
253 >Prev</A
254 ></TD
255 ><TD
256 WIDTH="34%"
257 ALIGN="center"
258 VALIGN="top"
259 ><A
260 HREF="index.html"
261 >Home</A
262 ></TD
263 ><TD
264 WIDTH="33%"
265 ALIGN="right"
266 VALIGN="top"
267 ><A
268 HREF="sdlpollevent.html"
269 >Next</A
270 ></TD
271 ></TR
272 ><TR
273 ><TD
274 WIDTH="33%"
275 ALIGN="left"
276 VALIGN="top"
277 >SDL_PumpEvents</TD
278 ><TD
279 WIDTH="34%"
280 ALIGN="center"
281 VALIGN="top"
282 ><A
283 HREF="eventfunctions.html"
284 >Up</A
285 ></TD
286 ><TD
287 WIDTH="33%"
288 ALIGN="right"
289 VALIGN="top"
290 >SDL_PollEvent</TD
291 ></TR
292 ></TABLE
293 ></DIV
294 ></BODY
295 ></HTML
296 >