• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_WaitEvent</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_PollEvent"
17HREF="sdlpollevent.html"><LINK
18REL="NEXT"
19TITLE="SDL_PushEvent"
20HREF="sdlpushevent.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="sdlpollevent.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="sdlpushevent.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLWAITEVENT"
74></A
75>SDL_WaitEvent</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN5507"
80></A
81><H2
82>Name</H2
83>SDL_WaitEvent&nbsp;--&nbsp;Waits indefinitely for the next available event.</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN5510"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN5511"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>int <B
106CLASS="FSFUNC"
107>SDL_WaitEvent</B
108></CODE
109>(SDL_Event *event);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN5517"
119></A
120><H2
121>Description</H2
122><P
123>Waits indefinitely for the next available event, returning
124<SPAN
125CLASS="RETURNVALUE"
126>1</SPAN
127>, or <SPAN
128CLASS="RETURNVALUE"
129>0</SPAN
130> if there was
131an error while waiting for events.  </P
132><P
133>If <TT
134CLASS="PARAMETER"
135><I
136>event</I
137></TT
138> is not <TT
139CLASS="LITERAL"
140>NULL</TT
141>, the next
142event is removed from the queue and stored in that area.</P
143></DIV
144><DIV
145CLASS="REFSECT1"
146><A
147NAME="AEN5525"
148></A
149><H2
150>See Also</H2
151><P
152><A
153HREF="sdlevent.html"
154><SPAN
155CLASS="STRUCTNAME"
156>SDL_Event</SPAN
157></A
158>,
159<A
160HREF="sdlpollevent.html"
161><TT
162CLASS="FUNCTION"
163>SDL_PollEvent</TT
164></A
165></P
166></DIV
167><DIV
168CLASS="NAVFOOTER"
169><HR
170ALIGN="LEFT"
171WIDTH="100%"><TABLE
172SUMMARY="Footer navigation table"
173WIDTH="100%"
174BORDER="0"
175CELLPADDING="0"
176CELLSPACING="0"
177><TR
178><TD
179WIDTH="33%"
180ALIGN="left"
181VALIGN="top"
182><A
183HREF="sdlpollevent.html"
184ACCESSKEY="P"
185>Prev</A
186></TD
187><TD
188WIDTH="34%"
189ALIGN="center"
190VALIGN="top"
191><A
192HREF="index.html"
193ACCESSKEY="H"
194>Home</A
195></TD
196><TD
197WIDTH="33%"
198ALIGN="right"
199VALIGN="top"
200><A
201HREF="sdlpushevent.html"
202ACCESSKEY="N"
203>Next</A
204></TD
205></TR
206><TR
207><TD
208WIDTH="33%"
209ALIGN="left"
210VALIGN="top"
211>SDL_PollEvent</TD
212><TD
213WIDTH="34%"
214ALIGN="center"
215VALIGN="top"
216><A
217HREF="eventfunctions.html"
218ACCESSKEY="U"
219>Up</A
220></TD
221><TD
222WIDTH="33%"
223ALIGN="right"
224VALIGN="top"
225>SDL_PushEvent</TD
226></TR
227></TABLE
228></DIV
229></BODY
230></HTML
231>