• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_PumpEvents</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="Event Functions."
17HREF="eventfunctions.html"><LINK
18REL="NEXT"
19TITLE="SDL_PeepEvents"
20HREF="sdlpeepevents.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="eventfunctions.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="sdlpeepevents.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLPUMPEVENTS"
74></A
75>SDL_PumpEvents</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN5387"
80></A
81><H2
82>Name</H2
83>SDL_PumpEvents&nbsp;--&nbsp;Pumps the event loop, gathering events from the input devices.</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN5390"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN5391"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>void <B
106CLASS="FSFUNC"
107>SDL_PumpEvents</B
108></CODE
109>(void);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN5397"
119></A
120><H2
121>Description</H2
122><P
123>Pumps the event loop, gathering events from the input devices.</P
124><P
125><TT
126CLASS="FUNCTION"
127>SDL_PumpEvents</TT
128> gathers all the pending input information from devices and places it on the event queue. Without calls to <TT
129CLASS="FUNCTION"
130>SDL_PumpEvents</TT
131> no events would ever be placed on the queue. Often calls the need for <TT
132CLASS="FUNCTION"
133>SDL_PumpEvents</TT
134> is hidden from the user since <A
135HREF="sdlpollevent.html"
136><TT
137CLASS="FUNCTION"
138>SDL_PollEvent</TT
139></A
140> and <A
141HREF="sdlwaitevent.html"
142><TT
143CLASS="FUNCTION"
144>SDL_WaitEvent</TT
145></A
146> implicitly call <TT
147CLASS="FUNCTION"
148>SDL_PumpEvents</TT
149>. However, if you are not polling or waiting for events (e.g. you are filtering them), then you must call <TT
150CLASS="FUNCTION"
151>SDL_PumpEvents</TT
152> to force an event queue update.</P
153><DIV
154CLASS="NOTE"
155><BLOCKQUOTE
156CLASS="NOTE"
157><P
158><B
159>Note: </B
160>You can only call this function in the thread that set the video mode.</P
161></BLOCKQUOTE
162></DIV
163></DIV
164><DIV
165CLASS="REFSECT1"
166><A
167NAME="AEN5412"
168></A
169><H2
170>See Also</H2
171><P
172><A
173HREF="sdlpollevent.html"
174><TT
175CLASS="FUNCTION"
176>SDL_PollEvent</TT
177></A
178></P
179></DIV
180><DIV
181CLASS="NAVFOOTER"
182><HR
183ALIGN="LEFT"
184WIDTH="100%"><TABLE
185SUMMARY="Footer navigation table"
186WIDTH="100%"
187BORDER="0"
188CELLPADDING="0"
189CELLSPACING="0"
190><TR
191><TD
192WIDTH="33%"
193ALIGN="left"
194VALIGN="top"
195><A
196HREF="eventfunctions.html"
197ACCESSKEY="P"
198>Prev</A
199></TD
200><TD
201WIDTH="34%"
202ALIGN="center"
203VALIGN="top"
204><A
205HREF="index.html"
206ACCESSKEY="H"
207>Home</A
208></TD
209><TD
210WIDTH="33%"
211ALIGN="right"
212VALIGN="top"
213><A
214HREF="sdlpeepevents.html"
215ACCESSKEY="N"
216>Next</A
217></TD
218></TR
219><TR
220><TD
221WIDTH="33%"
222ALIGN="left"
223VALIGN="top"
224>Event Functions.</TD
225><TD
226WIDTH="34%"
227ALIGN="center"
228VALIGN="top"
229><A
230HREF="eventfunctions.html"
231ACCESSKEY="U"
232>Up</A
233></TD
234><TD
235WIDTH="33%"
236ALIGN="right"
237VALIGN="top"
238>SDL_PeepEvents</TD
239></TR
240></TABLE
241></DIV
242></BODY
243></HTML
244>