Mercurial > sdl-ios-xcode
annotate docs/html/sdlwaitevent.html @ 4928:930614179450 SDL-1.2
Patch from Haiku's Google Code-In student Daniel Marth, fixes an off-by-one issue in bwindow.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 03 Dec 2010 16:55:25 -0800 |
parents | 355632dca928 |
children |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_WaitEvent</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
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="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 | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
31 SUMMARY="Header navigation table" |
0 | 32 WIDTH="100%" |
33 BORDER="0" | |
34 CELLPADDING="0" | |
35 CELLSPACING="0" | |
36 ><TR | |
37 ><TH | |
38 COLSPAN="3" | |
39 ALIGN="center" | |
40 >SDL Library Documentation</TH | |
41 ></TR | |
42 ><TR | |
43 ><TD | |
44 WIDTH="10%" | |
45 ALIGN="left" | |
46 VALIGN="bottom" | |
47 ><A | |
48 HREF="sdlpollevent.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
49 ACCESSKEY="P" |
0 | 50 >Prev</A |
51 ></TD | |
52 ><TD | |
53 WIDTH="80%" | |
54 ALIGN="center" | |
55 VALIGN="bottom" | |
56 ></TD | |
57 ><TD | |
58 WIDTH="10%" | |
59 ALIGN="right" | |
60 VALIGN="bottom" | |
61 ><A | |
62 HREF="sdlpushevent.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
63 ACCESSKEY="N" |
0 | 64 >Next</A |
65 ></TD | |
66 ></TR | |
67 ></TABLE | |
68 ><HR | |
69 ALIGN="LEFT" | |
70 WIDTH="100%"></DIV | |
71 ><H1 | |
72 ><A | |
73 NAME="SDLWAITEVENT" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
74 ></A |
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
75 >SDL_WaitEvent</H1 |
0 | 76 ><DIV |
77 CLASS="REFNAMEDIV" | |
78 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
79 NAME="AEN5507" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
83 >SDL_WaitEvent -- Waits indefinitely for the next available event.</DIV | |
84 ><DIV | |
85 CLASS="REFSYNOPSISDIV" | |
86 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
87 NAME="AEN5510" |
0 | 88 ></A |
89 ><H2 | |
90 >Synopsis</H2 | |
91 ><DIV | |
92 CLASS="FUNCSYNOPSIS" | |
93 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
94 NAME="AEN5511" |
0 | 95 ></A |
96 ><P | |
97 ></P | |
98 ><PRE | |
99 CLASS="FUNCSYNOPSISINFO" | |
100 >#include "SDL.h"</PRE | |
101 ><P | |
102 ><CODE | |
103 ><CODE | |
104 CLASS="FUNCDEF" | |
105 >int <B | |
106 CLASS="FSFUNC" | |
107 >SDL_WaitEvent</B | |
108 ></CODE | |
109 >(SDL_Event *event);</CODE | |
110 ></P | |
111 ><P | |
112 ></P | |
113 ></DIV | |
114 ></DIV | |
115 ><DIV | |
116 CLASS="REFSECT1" | |
117 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
118 NAME="AEN5517" |
0 | 119 ></A |
120 ><H2 | |
121 >Description</H2 | |
122 ><P | |
123 >Waits indefinitely for the next available event, returning | |
124 <SPAN | |
125 CLASS="RETURNVALUE" | |
126 >1</SPAN | |
127 >, or <SPAN | |
128 CLASS="RETURNVALUE" | |
129 >0</SPAN | |
130 > if there was | |
131 an error while waiting for events. </P | |
132 ><P | |
133 >If <TT | |
134 CLASS="PARAMETER" | |
135 ><I | |
136 >event</I | |
137 ></TT | |
138 > is not <TT | |
139 CLASS="LITERAL" | |
140 >NULL</TT | |
141 >, the next | |
142 event is removed from the queue and stored in that area.</P | |
143 ></DIV | |
144 ><DIV | |
145 CLASS="REFSECT1" | |
146 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
147 NAME="AEN5525" |
0 | 148 ></A |
149 ><H2 | |
150 >See Also</H2 | |
151 ><P | |
152 ><A | |
153 HREF="sdlevent.html" | |
154 ><SPAN | |
155 CLASS="STRUCTNAME" | |
156 >SDL_Event</SPAN | |
157 ></A | |
158 >, | |
159 <A | |
160 HREF="sdlpollevent.html" | |
161 ><TT | |
162 CLASS="FUNCTION" | |
163 >SDL_PollEvent</TT | |
164 ></A | |
165 ></P | |
166 ></DIV | |
167 ><DIV | |
168 CLASS="NAVFOOTER" | |
169 ><HR | |
170 ALIGN="LEFT" | |
171 WIDTH="100%"><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
172 SUMMARY="Footer navigation table" |
0 | 173 WIDTH="100%" |
174 BORDER="0" | |
175 CELLPADDING="0" | |
176 CELLSPACING="0" | |
177 ><TR | |
178 ><TD | |
179 WIDTH="33%" | |
180 ALIGN="left" | |
181 VALIGN="top" | |
182 ><A | |
183 HREF="sdlpollevent.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
184 ACCESSKEY="P" |
0 | 185 >Prev</A |
186 ></TD | |
187 ><TD | |
188 WIDTH="34%" | |
189 ALIGN="center" | |
190 VALIGN="top" | |
191 ><A | |
192 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
193 ACCESSKEY="H" |
0 | 194 >Home</A |
195 ></TD | |
196 ><TD | |
197 WIDTH="33%" | |
198 ALIGN="right" | |
199 VALIGN="top" | |
200 ><A | |
201 HREF="sdlpushevent.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
202 ACCESSKEY="N" |
0 | 203 >Next</A |
204 ></TD | |
205 ></TR | |
206 ><TR | |
207 ><TD | |
208 WIDTH="33%" | |
209 ALIGN="left" | |
210 VALIGN="top" | |
211 >SDL_PollEvent</TD | |
212 ><TD | |
213 WIDTH="34%" | |
214 ALIGN="center" | |
215 VALIGN="top" | |
216 ><A | |
217 HREF="eventfunctions.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
218 ACCESSKEY="U" |
0 | 219 >Up</A |
220 ></TD | |
221 ><TD | |
222 WIDTH="33%" | |
223 ALIGN="right" | |
224 VALIGN="top" | |
225 >SDL_PushEvent</TD | |
226 ></TR | |
227 ></TABLE | |
228 ></DIV | |
229 ></BODY | |
230 ></HTML | |
231 > |