Mercurial > sdl-ios-xcode
annotate docs/html/sdlpumpevents.html @ 584:365ed14a882a
*** empty log message ***
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sat, 01 Feb 2003 19:27:05 +0000 |
parents | e5bc29de3f0a |
children | 355632dca928 |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_PumpEvents</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="Event Functions." | |
17 HREF="eventfunctions.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_PeepEvents" | |
20 HREF="sdlpeepevents.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="eventfunctions.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="sdlpeepevents.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="SDLPUMPEVENTS" | |
71 >SDL_PumpEvents</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="AEN5003" |
0 | 77 ></A |
78 ><H2 | |
79 >Name</H2 | |
80 >SDL_PumpEvents -- Pumps the event loop, gathering events from the input devices.</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="AEN5006" |
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="AEN5007" |
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 >void <B | |
103 CLASS="FSFUNC" | |
104 >SDL_PumpEvents</B | |
105 ></CODE | |
106 >(void);</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="AEN5013" |
0 | 116 ></A |
117 ><H2 | |
118 >Description</H2 | |
119 ><P | |
120 >Pumps the event loop, gathering events from the input devices.</P | |
121 ><P | |
122 ><TT | |
123 CLASS="FUNCTION" | |
124 >SDL_PumpEvents</TT | |
125 > gathers all the pending input information from devices and places it on the event queue. Without calls to <TT | |
126 CLASS="FUNCTION" | |
127 >SDL_PumpEvents</TT | |
128 > no events would ever be placed on the queue. Often calls the need for <TT | |
129 CLASS="FUNCTION" | |
130 >SDL_PumpEvents</TT | |
131 > is hidden from the user since <A | |
132 HREF="sdlpollevent.html" | |
133 ><TT | |
134 CLASS="FUNCTION" | |
135 >SDL_PollEvent</TT | |
136 ></A | |
137 > and <A | |
138 HREF="sdlwaitevent.html" | |
139 ><TT | |
140 CLASS="FUNCTION" | |
141 >SDL_WaitEvent</TT | |
142 ></A | |
143 > implicitly call <TT | |
144 CLASS="FUNCTION" | |
145 >SDL_PumpEvents</TT | |
146 >. However, if you are not polling or waiting for events (e.g. your filtering them), then you must call <TT | |
147 CLASS="FUNCTION" | |
148 >SDL_PumpEvents</TT | |
149 > to force an event queue update.</P | |
150 ><DIV | |
151 CLASS="NOTE" | |
152 ><BLOCKQUOTE | |
153 CLASS="NOTE" | |
154 ><P | |
155 ><B | |
156 >Note: </B | |
157 >You can only call this function in the thread that set the video mode.</P | |
158 ></BLOCKQUOTE | |
159 ></DIV | |
160 ></DIV | |
161 ><DIV | |
162 CLASS="REFSECT1" | |
163 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
164 NAME="AEN5028" |
0 | 165 ></A |
166 ><H2 | |
167 >See Also</H2 | |
168 ><P | |
169 ><A | |
170 HREF="sdlpollevent.html" | |
171 ><TT | |
172 CLASS="FUNCTION" | |
173 >SDL_PollEvent</TT | |
174 ></A | |
175 ></P | |
176 ></DIV | |
177 ><DIV | |
178 CLASS="NAVFOOTER" | |
179 ><HR | |
180 ALIGN="LEFT" | |
181 WIDTH="100%"><TABLE | |
182 WIDTH="100%" | |
183 BORDER="0" | |
184 CELLPADDING="0" | |
185 CELLSPACING="0" | |
186 ><TR | |
187 ><TD | |
188 WIDTH="33%" | |
189 ALIGN="left" | |
190 VALIGN="top" | |
191 ><A | |
192 HREF="eventfunctions.html" | |
193 >Prev</A | |
194 ></TD | |
195 ><TD | |
196 WIDTH="34%" | |
197 ALIGN="center" | |
198 VALIGN="top" | |
199 ><A | |
200 HREF="index.html" | |
201 >Home</A | |
202 ></TD | |
203 ><TD | |
204 WIDTH="33%" | |
205 ALIGN="right" | |
206 VALIGN="top" | |
207 ><A | |
208 HREF="sdlpeepevents.html" | |
209 >Next</A | |
210 ></TD | |
211 ></TR | |
212 ><TR | |
213 ><TD | |
214 WIDTH="33%" | |
215 ALIGN="left" | |
216 VALIGN="top" | |
217 >Event Functions.</TD | |
218 ><TD | |
219 WIDTH="34%" | |
220 ALIGN="center" | |
221 VALIGN="top" | |
222 ><A | |
223 HREF="eventfunctions.html" | |
224 >Up</A | |
225 ></TD | |
226 ><TD | |
227 WIDTH="33%" | |
228 ALIGN="right" | |
229 VALIGN="top" | |
230 >SDL_PeepEvents</TD | |
231 ></TR | |
232 ></TABLE | |
233 ></DIV | |
234 ></BODY | |
235 ></HTML | |
236 > |