comparison docs/html/sdlpushevent.html @ 803:355632dca928

Updated SDL HTML documentation
author Sam Lantinga <slouken@libsdl.org>
date Tue, 10 Feb 2004 15:15:40 +0000
parents e5bc29de3f0a
children
comparison
equal deleted inserted replaced
802:3c609d54f100 803:355632dca928
2 ><HEAD 2 ><HEAD
3 ><TITLE 3 ><TITLE
4 >SDL_PushEvent</TITLE 4 >SDL_PushEvent</TITLE
5 ><META 5 ><META
6 NAME="GENERATOR" 6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK 8 "><LINK
9 REL="HOME" 9 REL="HOME"
10 TITLE="SDL Library Documentation" 10 TITLE="SDL Library Documentation"
11 HREF="index.html"><LINK 11 HREF="index.html"><LINK
12 REL="UP" 12 REL="UP"
26 VLINK="#551a8b" 26 VLINK="#551a8b"
27 ALINK="#ff0000" 27 ALINK="#ff0000"
28 ><DIV 28 ><DIV
29 CLASS="NAVHEADER" 29 CLASS="NAVHEADER"
30 ><TABLE 30 ><TABLE
31 SUMMARY="Header navigation table"
31 WIDTH="100%" 32 WIDTH="100%"
32 BORDER="0" 33 BORDER="0"
33 CELLPADDING="0" 34 CELLPADDING="0"
34 CELLSPACING="0" 35 CELLSPACING="0"
35 ><TR 36 ><TR
43 WIDTH="10%" 44 WIDTH="10%"
44 ALIGN="left" 45 ALIGN="left"
45 VALIGN="bottom" 46 VALIGN="bottom"
46 ><A 47 ><A
47 HREF="sdlwaitevent.html" 48 HREF="sdlwaitevent.html"
49 ACCESSKEY="P"
48 >Prev</A 50 >Prev</A
49 ></TD 51 ></TD
50 ><TD 52 ><TD
51 WIDTH="80%" 53 WIDTH="80%"
52 ALIGN="center" 54 ALIGN="center"
56 WIDTH="10%" 58 WIDTH="10%"
57 ALIGN="right" 59 ALIGN="right"
58 VALIGN="bottom" 60 VALIGN="bottom"
59 ><A 61 ><A
60 HREF="sdlseteventfilter.html" 62 HREF="sdlseteventfilter.html"
63 ACCESSKEY="N"
61 >Next</A 64 >Next</A
62 ></TD 65 ></TD
63 ></TR 66 ></TR
64 ></TABLE 67 ></TABLE
65 ><HR 68 ><HR
66 ALIGN="LEFT" 69 ALIGN="LEFT"
67 WIDTH="100%"></DIV 70 WIDTH="100%"></DIV
68 ><H1 71 ><H1
69 ><A 72 ><A
70 NAME="SDLPUSHEVENT" 73 NAME="SDLPUSHEVENT"
71 >SDL_PushEvent</A 74 ></A
72 ></H1 75 >SDL_PushEvent</H1
73 ><DIV 76 ><DIV
74 CLASS="REFNAMEDIV" 77 CLASS="REFNAMEDIV"
75 ><A 78 ><A
76 NAME="AEN5148" 79 NAME="AEN5536"
77 ></A 80 ></A
78 ><H2 81 ><H2
79 >Name</H2 82 >Name</H2
80 >SDL_PushEvent&nbsp;--&nbsp;Pushes an event onto the event queue</DIV 83 >SDL_PushEvent&nbsp;--&nbsp;Pushes an event onto the event queue</DIV
81 ><DIV 84 ><DIV
82 CLASS="REFSYNOPSISDIV" 85 CLASS="REFSYNOPSISDIV"
83 ><A 86 ><A
84 NAME="AEN5151" 87 NAME="AEN5539"
85 ></A 88 ></A
86 ><H2 89 ><H2
87 >Synopsis</H2 90 >Synopsis</H2
88 ><DIV 91 ><DIV
89 CLASS="FUNCSYNOPSIS" 92 CLASS="FUNCSYNOPSIS"
90 ><A 93 ><A
91 NAME="AEN5152" 94 NAME="AEN5540"
92 ></A 95 ></A
93 ><P 96 ><P
94 ></P 97 ></P
95 ><PRE 98 ><PRE
96 CLASS="FUNCSYNOPSISINFO" 99 CLASS="FUNCSYNOPSISINFO"
110 ></DIV 113 ></DIV
111 ></DIV 114 ></DIV
112 ><DIV 115 ><DIV
113 CLASS="REFSECT1" 116 CLASS="REFSECT1"
114 ><A 117 ><A
115 NAME="AEN5158" 118 NAME="AEN5546"
116 ></A 119 ></A
117 ><H2 120 ><H2
118 >Description</H2 121 >Description</H2
119 ><P 122 ><P
120 >The event queue can actually be used as a two way communication channel. Not only can events be read from the queue, but the user can also push their own events onto it. <TT 123 >The event queue can actually be used as a two way communication channel. Not only can events be read from the queue, but the user can also push their own events onto it. <TT
135 ></DIV 138 ></DIV
136 ></DIV 139 ></DIV
137 ><DIV 140 ><DIV
138 CLASS="REFSECT1" 141 CLASS="REFSECT1"
139 ><A 142 ><A
140 NAME="AEN5164" 143 NAME="AEN5552"
141 ></A 144 ></A
142 ><H2 145 ><H2
143 >Return Value</H2 146 >Return Value</H2
144 ><P 147 ><P
145 >Returns <SPAN 148 >Returns <SPAN
151 > if the event couldn't be pushed.</P 154 > if the event couldn't be pushed.</P
152 ></DIV 155 ></DIV
153 ><DIV 156 ><DIV
154 CLASS="REFSECT1" 157 CLASS="REFSECT1"
155 ><A 158 ><A
156 NAME="AEN5169" 159 NAME="AEN5557"
157 ></A 160 ></A
158 ><H2 161 ><H2
159 >Examples</H2 162 >Examples</H2
160 ><P 163 ><P
161 >See <A 164 >See <A
167 >.</P 170 >.</P
168 ></DIV 171 ></DIV
169 ><DIV 172 ><DIV
170 CLASS="REFSECT1" 173 CLASS="REFSECT1"
171 ><A 174 ><A
172 NAME="AEN5174" 175 NAME="AEN5562"
173 ></A 176 ></A
174 ><H2 177 ><H2
175 >See Also</H2 178 >See Also</H2
176 ><P 179 ><P
177 ><A 180 ><A
199 ><DIV 202 ><DIV
200 CLASS="NAVFOOTER" 203 CLASS="NAVFOOTER"
201 ><HR 204 ><HR
202 ALIGN="LEFT" 205 ALIGN="LEFT"
203 WIDTH="100%"><TABLE 206 WIDTH="100%"><TABLE
207 SUMMARY="Footer navigation table"
204 WIDTH="100%" 208 WIDTH="100%"
205 BORDER="0" 209 BORDER="0"
206 CELLPADDING="0" 210 CELLPADDING="0"
207 CELLSPACING="0" 211 CELLSPACING="0"
208 ><TR 212 ><TR
210 WIDTH="33%" 214 WIDTH="33%"
211 ALIGN="left" 215 ALIGN="left"
212 VALIGN="top" 216 VALIGN="top"
213 ><A 217 ><A
214 HREF="sdlwaitevent.html" 218 HREF="sdlwaitevent.html"
219 ACCESSKEY="P"
215 >Prev</A 220 >Prev</A
216 ></TD 221 ></TD
217 ><TD 222 ><TD
218 WIDTH="34%" 223 WIDTH="34%"
219 ALIGN="center" 224 ALIGN="center"
220 VALIGN="top" 225 VALIGN="top"
221 ><A 226 ><A
222 HREF="index.html" 227 HREF="index.html"
228 ACCESSKEY="H"
223 >Home</A 229 >Home</A
224 ></TD 230 ></TD
225 ><TD 231 ><TD
226 WIDTH="33%" 232 WIDTH="33%"
227 ALIGN="right" 233 ALIGN="right"
228 VALIGN="top" 234 VALIGN="top"
229 ><A 235 ><A
230 HREF="sdlseteventfilter.html" 236 HREF="sdlseteventfilter.html"
237 ACCESSKEY="N"
231 >Next</A 238 >Next</A
232 ></TD 239 ></TD
233 ></TR 240 ></TR
234 ><TR 241 ><TR
235 ><TD 242 ><TD
241 WIDTH="34%" 248 WIDTH="34%"
242 ALIGN="center" 249 ALIGN="center"
243 VALIGN="top" 250 VALIGN="top"
244 ><A 251 ><A
245 HREF="eventfunctions.html" 252 HREF="eventfunctions.html"
253 ACCESSKEY="U"
246 >Up</A 254 >Up</A
247 ></TD 255 ></TD
248 ><TD 256 ><TD
249 WIDTH="33%" 257 WIDTH="33%"
250 ALIGN="right" 258 ALIGN="right"