1<HTML 2><HEAD 3><TITLE 4>SDL_PushEvent</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_WaitEvent" 17HREF="sdlwaitevent.html"><LINK 18REL="NEXT" 19TITLE="SDL_SetEventFilter" 20HREF="sdlseteventfilter.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="sdlwaitevent.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="sdlseteventfilter.html" 63ACCESSKEY="N" 64>Next</A 65></TD 66></TR 67></TABLE 68><HR 69ALIGN="LEFT" 70WIDTH="100%"></DIV 71><H1 72><A 73NAME="SDLPUSHEVENT" 74></A 75>SDL_PushEvent</H1 76><DIV 77CLASS="REFNAMEDIV" 78><A 79NAME="AEN5536" 80></A 81><H2 82>Name</H2 83>SDL_PushEvent -- Pushes an event onto the event queue</DIV 84><DIV 85CLASS="REFSYNOPSISDIV" 86><A 87NAME="AEN5539" 88></A 89><H2 90>Synopsis</H2 91><DIV 92CLASS="FUNCSYNOPSIS" 93><A 94NAME="AEN5540" 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_PushEvent</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="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 124CLASS="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 130CLASS="NOTE" 131><BLOCKQUOTE 132CLASS="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 141CLASS="REFSECT1" 142><A 143NAME="AEN5552" 144></A 145><H2 146>Return Value</H2 147><P 148>Returns <SPAN 149CLASS="RETURNVALUE" 150>0</SPAN 151> on success or <SPAN 152CLASS="RETURNVALUE" 153>-1</SPAN 154> if the event couldn't be pushed.</P 155></DIV 156><DIV 157CLASS="REFSECT1" 158><A 159NAME="AEN5557" 160></A 161><H2 162>Examples</H2 163><P 164>See <A 165HREF="sdlevent.html" 166><SPAN 167CLASS="STRUCTNAME" 168>SDL_Event</SPAN 169></A 170>.</P 171></DIV 172><DIV 173CLASS="REFSECT1" 174><A 175NAME="AEN5562" 176></A 177><H2 178>See Also</H2 179><P 180><A 181HREF="sdlpollevent.html" 182><TT 183CLASS="FUNCTION" 184>SDL_PollEvent</TT 185></A 186>, 187<A 188HREF="sdlpeepevents.html" 189><TT 190CLASS="FUNCTION" 191>SDL_PeepEvents</TT 192></A 193>, 194<A 195HREF="sdlevent.html" 196><SPAN 197CLASS="STRUCTNAME" 198>SDL_Event</SPAN 199></A 200></P 201></DIV 202><DIV 203CLASS="NAVFOOTER" 204><HR 205ALIGN="LEFT" 206WIDTH="100%"><TABLE 207SUMMARY="Footer navigation table" 208WIDTH="100%" 209BORDER="0" 210CELLPADDING="0" 211CELLSPACING="0" 212><TR 213><TD 214WIDTH="33%" 215ALIGN="left" 216VALIGN="top" 217><A 218HREF="sdlwaitevent.html" 219ACCESSKEY="P" 220>Prev</A 221></TD 222><TD 223WIDTH="34%" 224ALIGN="center" 225VALIGN="top" 226><A 227HREF="index.html" 228ACCESSKEY="H" 229>Home</A 230></TD 231><TD 232WIDTH="33%" 233ALIGN="right" 234VALIGN="top" 235><A 236HREF="sdlseteventfilter.html" 237ACCESSKEY="N" 238>Next</A 239></TD 240></TR 241><TR 242><TD 243WIDTH="33%" 244ALIGN="left" 245VALIGN="top" 246>SDL_WaitEvent</TD 247><TD 248WIDTH="34%" 249ALIGN="center" 250VALIGN="top" 251><A 252HREF="eventfunctions.html" 253ACCESSKEY="U" 254>Up</A 255></TD 256><TD 257WIDTH="33%" 258ALIGN="right" 259VALIGN="top" 260>SDL_SetEventFilter</TD 261></TR 262></TABLE 263></DIV 264></BODY 265></HTML 266>