comparison docs/html/sdlwaitevent.html @ 0:74212992fb08

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_WaitEvent</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_PollEvent"
17 HREF="sdlpollevent.html"><LINK
18 REL="NEXT"
19 TITLE="SDL_PushEvent"
20 HREF="sdlpushevent.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="sdlpollevent.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="sdlpushevent.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="SDLWAITEVENT"
71 >SDL_WaitEvent</A
72 ></H1
73 ><DIV
74 CLASS="REFNAMEDIV"
75 ><A
76 NAME="AEN4889"
77 ></A
78 ><H2
79 >Name</H2
80 >SDL_WaitEvent&nbsp;--&nbsp;Waits indefinitely for the next available event.</DIV
81 ><DIV
82 CLASS="REFSYNOPSISDIV"
83 ><A
84 NAME="AEN4892"
85 ></A
86 ><H2
87 >Synopsis</H2
88 ><DIV
89 CLASS="FUNCSYNOPSIS"
90 ><A
91 NAME="AEN4893"
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_WaitEvent</B
105 ></CODE
106 >(SDL_Event *event);</CODE
107 ></P
108 ><P
109 ></P
110 ></DIV
111 ></DIV
112 ><DIV
113 CLASS="REFSECT1"
114 ><A
115 NAME="AEN4899"
116 ></A
117 ><H2
118 >Description</H2
119 ><P
120 >Waits indefinitely for the next available event, returning
121 <SPAN
122 CLASS="RETURNVALUE"
123 >1</SPAN
124 >, or <SPAN
125 CLASS="RETURNVALUE"
126 >0</SPAN
127 > if there was
128 an error while waiting for events. </P
129 ><P
130 >If <TT
131 CLASS="PARAMETER"
132 ><I
133 >event</I
134 ></TT
135 > is not <TT
136 CLASS="LITERAL"
137 >NULL</TT
138 >, the next
139 event is removed from the queue and stored in that area.</P
140 ></DIV
141 ><DIV
142 CLASS="REFSECT1"
143 ><A
144 NAME="AEN4907"
145 ></A
146 ><H2
147 >See Also</H2
148 ><P
149 ><A
150 HREF="sdlevent.html"
151 ><SPAN
152 CLASS="STRUCTNAME"
153 >SDL_Event</SPAN
154 ></A
155 >,
156 <A
157 HREF="sdlpollevent.html"
158 ><TT
159 CLASS="FUNCTION"
160 >SDL_PollEvent</TT
161 ></A
162 ></P
163 ></DIV
164 ><DIV
165 CLASS="NAVFOOTER"
166 ><HR
167 ALIGN="LEFT"
168 WIDTH="100%"><TABLE
169 WIDTH="100%"
170 BORDER="0"
171 CELLPADDING="0"
172 CELLSPACING="0"
173 ><TR
174 ><TD
175 WIDTH="33%"
176 ALIGN="left"
177 VALIGN="top"
178 ><A
179 HREF="sdlpollevent.html"
180 >Prev</A
181 ></TD
182 ><TD
183 WIDTH="34%"
184 ALIGN="center"
185 VALIGN="top"
186 ><A
187 HREF="index.html"
188 >Home</A
189 ></TD
190 ><TD
191 WIDTH="33%"
192 ALIGN="right"
193 VALIGN="top"
194 ><A
195 HREF="sdlpushevent.html"
196 >Next</A
197 ></TD
198 ></TR
199 ><TR
200 ><TD
201 WIDTH="33%"
202 ALIGN="left"
203 VALIGN="top"
204 >SDL_PollEvent</TD
205 ><TD
206 WIDTH="34%"
207 ALIGN="center"
208 VALIGN="top"
209 ><A
210 HREF="eventfunctions.html"
211 >Up</A
212 ></TD
213 ><TD
214 WIDTH="33%"
215 ALIGN="right"
216 VALIGN="top"
217 >SDL_PushEvent</TD
218 ></TR
219 ></TABLE
220 ></DIV
221 ></BODY
222 ></HTML
223 >