use the pandora's vsync ioctl when available
[sdl_omap.git] / docs / html / sdlpushevent.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >SDL_PushEvent</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
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_WaitEvent"
17 HREF="sdlwaitevent.html"><LINK
18 REL="NEXT"
19 TITLE="SDL_SetEventFilter"
20 HREF="sdlseteventfilter.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 SUMMARY="Header navigation table"
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="sdlwaitevent.html"
49 ACCESSKEY="P"
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="sdlseteventfilter.html"
63 ACCESSKEY="N"
64 >Next</A
65 ></TD
66 ></TR
67 ></TABLE
68 ><HR
69 ALIGN="LEFT"
70 WIDTH="100%"></DIV
71 ><H1
72 ><A
73 NAME="SDLPUSHEVENT"
74 ></A
75 >SDL_PushEvent</H1
76 ><DIV
77 CLASS="REFNAMEDIV"
78 ><A
79 NAME="AEN5536"
80 ></A
81 ><H2
82 >Name</H2
83 >SDL_PushEvent&nbsp;--&nbsp;Pushes an event onto the event queue</DIV
84 ><DIV
85 CLASS="REFSYNOPSISDIV"
86 ><A
87 NAME="AEN5539"
88 ></A
89 ><H2
90 >Synopsis</H2
91 ><DIV
92 CLASS="FUNCSYNOPSIS"
93 ><A
94 NAME="AEN5540"
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_PushEvent</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
118 NAME="AEN5546"
119 ></A
120 ><H2
121 >Description</H2
122 ><P
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
124 CLASS="PARAMETER"
125 ><I
126 >event</I
127 ></TT
128 > is a pointer to the event structure you wish to push onto the queue.</P
129 ><DIV
130 CLASS="NOTE"
131 ><BLOCKQUOTE
132 CLASS="NOTE"
133 ><P
134 ><B
135 >Note: </B
136 >Pushing device input events onto the queue doesn't modify the state of the device within SDL.</P
137 ></BLOCKQUOTE
138 ></DIV
139 ></DIV
140 ><DIV
141 CLASS="REFSECT1"
142 ><A
143 NAME="AEN5552"
144 ></A
145 ><H2
146 >Return Value</H2
147 ><P
148 >Returns <SPAN
149 CLASS="RETURNVALUE"
150 >0</SPAN
151 > on success or <SPAN
152 CLASS="RETURNVALUE"
153 >-1</SPAN
154 > if the event couldn't be pushed.</P
155 ></DIV
156 ><DIV
157 CLASS="REFSECT1"
158 ><A
159 NAME="AEN5557"
160 ></A
161 ><H2
162 >Examples</H2
163 ><P
164 >See <A
165 HREF="sdlevent.html"
166 ><SPAN
167 CLASS="STRUCTNAME"
168 >SDL_Event</SPAN
169 ></A
170 >.</P
171 ></DIV
172 ><DIV
173 CLASS="REFSECT1"
174 ><A
175 NAME="AEN5562"
176 ></A
177 ><H2
178 >See Also</H2
179 ><P
180 ><A
181 HREF="sdlpollevent.html"
182 ><TT
183 CLASS="FUNCTION"
184 >SDL_PollEvent</TT
185 ></A
186 >,
187 <A
188 HREF="sdlpeepevents.html"
189 ><TT
190 CLASS="FUNCTION"
191 >SDL_PeepEvents</TT
192 ></A
193 >,
194 <A
195 HREF="sdlevent.html"
196 ><SPAN
197 CLASS="STRUCTNAME"
198 >SDL_Event</SPAN
199 ></A
200 ></P
201 ></DIV
202 ><DIV
203 CLASS="NAVFOOTER"
204 ><HR
205 ALIGN="LEFT"
206 WIDTH="100%"><TABLE
207 SUMMARY="Footer navigation table"
208 WIDTH="100%"
209 BORDER="0"
210 CELLPADDING="0"
211 CELLSPACING="0"
212 ><TR
213 ><TD
214 WIDTH="33%"
215 ALIGN="left"
216 VALIGN="top"
217 ><A
218 HREF="sdlwaitevent.html"
219 ACCESSKEY="P"
220 >Prev</A
221 ></TD
222 ><TD
223 WIDTH="34%"
224 ALIGN="center"
225 VALIGN="top"
226 ><A
227 HREF="index.html"
228 ACCESSKEY="H"
229 >Home</A
230 ></TD
231 ><TD
232 WIDTH="33%"
233 ALIGN="right"
234 VALIGN="top"
235 ><A
236 HREF="sdlseteventfilter.html"
237 ACCESSKEY="N"
238 >Next</A
239 ></TD
240 ></TR
241 ><TR
242 ><TD
243 WIDTH="33%"
244 ALIGN="left"
245 VALIGN="top"
246 >SDL_WaitEvent</TD
247 ><TD
248 WIDTH="34%"
249 ALIGN="center"
250 VALIGN="top"
251 ><A
252 HREF="eventfunctions.html"
253 ACCESSKEY="U"
254 >Up</A
255 ></TD
256 ><TD
257 WIDTH="33%"
258 ALIGN="right"
259 VALIGN="top"
260 >SDL_SetEventFilter</TD
261 ></TR
262 ></TABLE
263 ></DIV
264 ></BODY
265 ></HTML
266 >