Mercurial > sdl-ios-xcode

comparison docs/html/sdlpeepevents.html @ 803:355632dca928

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated SDL HTML documentation
author Sam Lantinga <slouken@libsdl.org>
date Tue, 10 Feb 2004 15:15:40 +0000
parents e5bc29de3f0a
children
comparison
equal deleted inserted replaced
802:3c609d54f100 803:355632dca928
2 ><HEAD 2 ><HEAD
3 ><TITLE 3 ><TITLE
4 >SDL_PeepEvents</TITLE 4 >SDL_PeepEvents</TITLE
5 ><META 5 ><META
6 NAME="GENERATOR" 6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK 8 "><LINK
9 REL="HOME" 9 REL="HOME"
10 TITLE="SDL Library Documentation" 10 TITLE="SDL Library Documentation"
11 HREF="index.html"><LINK 11 HREF="index.html"><LINK
12 REL="UP" 12 REL="UP"
26 VLINK="#551a8b" 26 VLINK="#551a8b"
27 ALINK="#ff0000" 27 ALINK="#ff0000"
28 ><DIV 28 ><DIV
29 CLASS="NAVHEADER" 29 CLASS="NAVHEADER"
30 ><TABLE 30 ><TABLE
31 SUMMARY="Header navigation table"
31 WIDTH="100%" 32 WIDTH="100%"
32 BORDER="0" 33 BORDER="0"
33 CELLPADDING="0" 34 CELLPADDING="0"
34 CELLSPACING="0" 35 CELLSPACING="0"
35 ><TR 36 ><TR
43 WIDTH="10%" 44 WIDTH="10%"
44 ALIGN="left" 45 ALIGN="left"
45 VALIGN="bottom" 46 VALIGN="bottom"
46 ><A 47 ><A
47 HREF="sdlpumpevents.html" 48 HREF="sdlpumpevents.html"
49 ACCESSKEY="P"
48 >Prev</A 50 >Prev</A
49 ></TD 51 ></TD
50 ><TD 52 ><TD
51 WIDTH="80%" 53 WIDTH="80%"
52 ALIGN="center" 54 ALIGN="center"
56 WIDTH="10%" 58 WIDTH="10%"
57 ALIGN="right" 59 ALIGN="right"
58 VALIGN="bottom" 60 VALIGN="bottom"
59 ><A 61 ><A
60 HREF="sdlpollevent.html" 62 HREF="sdlpollevent.html"
63 ACCESSKEY="N"
61 >Next</A 64 >Next</A
62 ></TD 65 ></TD
63 ></TR 66 ></TR
64 ></TABLE 67 ></TABLE
65 ><HR 68 ><HR
66 ALIGN="LEFT" 69 ALIGN="LEFT"
67 WIDTH="100%"></DIV 70 WIDTH="100%"></DIV
68 ><H1 71 ><H1
69 ><A 72 ><A
70 NAME="SDLPEEPEVENTS" 73 NAME="SDLPEEPEVENTS"
71 >SDL_PeepEvents</A 74 ></A
72 ></H1 75 >SDL_PeepEvents</H1
73 ><DIV 76 ><DIV
74 CLASS="REFNAMEDIV" 77 CLASS="REFNAMEDIV"
75 ><A 78 ><A
76 NAME="AEN5037" 79 NAME="AEN5421"
77 ></A 80 ></A
78 ><H2 81 ><H2
79 >Name</H2 82 >Name</H2
80 >SDL_PeepEvents&nbsp;--&nbsp;Checks the event queue for messages and optionally returns them.</DIV 83 >SDL_PeepEvents&nbsp;--&nbsp;Checks the event queue for messages and optionally returns them.</DIV
81 ><DIV 84 ><DIV
82 CLASS="REFSYNOPSISDIV" 85 CLASS="REFSYNOPSISDIV"
83 ><A 86 ><A
84 NAME="AEN5040" 87 NAME="AEN5424"
85 ></A 88 ></A
86 ><H2 89 ><H2
87 >Synopsis</H2 90 >Synopsis</H2
88 ><DIV 91 ><DIV
89 CLASS="FUNCSYNOPSIS" 92 CLASS="FUNCSYNOPSIS"
90 ><A 93 ><A
91 NAME="AEN5041" 94 NAME="AEN5425"
92 ></A 95 ></A
93 ><P 96 ><P
94 ></P 97 ></P
95 ><PRE 98 ><PRE
96 CLASS="FUNCSYNOPSISINFO" 99 CLASS="FUNCSYNOPSISINFO"
110 ></DIV 113 ></DIV
111 ></DIV 114 ></DIV
112 ><DIV 115 ><DIV
113 CLASS="REFSECT1" 116 CLASS="REFSECT1"
114 ><A 117 ><A
115 NAME="AEN5047" 118 NAME="AEN5431"
116 ></A 119 ></A
117 ><H2 120 ><H2
118 >Description</H2 121 >Description</H2
119 ><P 122 ><P
120 >Checks the event queue for messages and optionally returns them.</P 123 >Checks the event queue for messages and optionally returns them.</P
186 ></TT 189 ></TT
187 ></A 190 ></A
188 >, 191 >,
189 will be returned and will be removed from the queue.</P 192 will be returned and will be removed from the queue.</P
190 ><P 193 ><P
194 >The <TT
195 CLASS="PARAMETER"
196 ><I
197 >mask</I
198 ></TT
199 > parameter is an bitwise OR of
200 <TT
201 CLASS="LITERAL"
202 >SDL_EVENTMASK</TT
203 >(<TT
204 CLASS="PARAMETER"
205 ><I
206 >event_type</I
207 ></TT
208 >), for all
209 event types you are interested in.</P
210 ><P
191 >This function is thread-safe.</P 211 >This function is thread-safe.</P
192 ></DIV 212 ></DIV
193 ><DIV 213 ><DIV
194 CLASS="REFSECT1" 214 CLASS="REFSECT1"
195 ><A 215 ><A
196 NAME="AEN5067" 216 NAME="AEN5455"
197 ></A 217 ></A
198 ><H2 218 ><H2
199 >Return Value</H2 219 >Return Value</H2
200 ><P 220 ><P
201 >This function returns the number of events actually stored, or 221 >This function returns the number of events actually stored, or
205 > if there was an error. </P 225 > if there was an error. </P
206 ></DIV 226 ></DIV
207 ><DIV 227 ><DIV
208 CLASS="REFSECT1" 228 CLASS="REFSECT1"
209 ><A 229 ><A
210 NAME="AEN5071" 230 NAME="AEN5459"
211 ></A 231 ></A
212 ><H2 232 ><H2
213 >See Also</H2 233 >See Also</H2
214 ><P 234 ><P
215 ><A 235 ><A
237 ><DIV 257 ><DIV
238 CLASS="NAVFOOTER" 258 CLASS="NAVFOOTER"
239 ><HR 259 ><HR
240 ALIGN="LEFT" 260 ALIGN="LEFT"
241 WIDTH="100%"><TABLE 261 WIDTH="100%"><TABLE
262 SUMMARY="Footer navigation table"
242 WIDTH="100%" 263 WIDTH="100%"
243 BORDER="0" 264 BORDER="0"
244 CELLPADDING="0" 265 CELLPADDING="0"
245 CELLSPACING="0" 266 CELLSPACING="0"
246 ><TR 267 ><TR
248 WIDTH="33%" 269 WIDTH="33%"
249 ALIGN="left" 270 ALIGN="left"
250 VALIGN="top" 271 VALIGN="top"
251 ><A 272 ><A
252 HREF="sdlpumpevents.html" 273 HREF="sdlpumpevents.html"
274 ACCESSKEY="P"
253 >Prev</A 275 >Prev</A
254 ></TD 276 ></TD
255 ><TD 277 ><TD
256 WIDTH="34%" 278 WIDTH="34%"
257 ALIGN="center" 279 ALIGN="center"
258 VALIGN="top" 280 VALIGN="top"
259 ><A 281 ><A
260 HREF="index.html" 282 HREF="index.html"
283 ACCESSKEY="H"
261 >Home</A 284 >Home</A
262 ></TD 285 ></TD
263 ><TD 286 ><TD
264 WIDTH="33%" 287 WIDTH="33%"
265 ALIGN="right" 288 ALIGN="right"
266 VALIGN="top" 289 VALIGN="top"
267 ><A 290 ><A
268 HREF="sdlpollevent.html" 291 HREF="sdlpollevent.html"
292 ACCESSKEY="N"
269 >Next</A 293 >Next</A
270 ></TD 294 ></TD
271 ></TR 295 ></TR
272 ><TR 296 ><TR
273 ><TD 297 ><TD
279 WIDTH="34%" 303 WIDTH="34%"
280 ALIGN="center" 304 ALIGN="center"
281 VALIGN="top" 305 VALIGN="top"
282 ><A 306 ><A
283 HREF="eventfunctions.html" 307 HREF="eventfunctions.html"
308 ACCESSKEY="U"
284 >Up</A 309 >Up</A
285 ></TD 310 ></TD
286 ><TD 311 ><TD
287 WIDTH="33%" 312 WIDTH="33%"
288 ALIGN="right" 313 ALIGN="right"