2001-04-26 16:45:43 +00:00
< HTML
>< HEAD
>< TITLE
>SDL_PushEvent< /TITLE
>< META
NAME="GENERATOR"
2001-06-10 19:31:57 +00:00
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
2001-04-26 16:45:43 +00:00
">< LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html">< LINK
REL="UP"
TITLE="Event Functions."
HREF="eventfunctions.html">< LINK
REL="PREVIOUS"
TITLE="SDL_WaitEvent"
HREF="sdlwaitevent.html">< LINK
REL="NEXT"
TITLE="SDL_SetEventFilter"
HREF="sdlseteventfilter.html">< /HEAD
>< BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
>< DIV
CLASS="NAVHEADER"
>< TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
>< TR
>< TH
COLSPAN="3"
ALIGN="center"
>SDL Library Documentation< /TH
>< /TR
>< TR
>< TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
>< A
HREF="sdlwaitevent.html"
>Prev< /A
>< /TD
>< TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>< /TD
>< TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
>< A
HREF="sdlseteventfilter.html"
>Next< /A
>< /TD
>< /TR
>< /TABLE
>< HR
ALIGN="LEFT"
WIDTH="100%">< /DIV
>< H1
>< A
NAME="SDLPUSHEVENT"
>SDL_PushEvent< /A
>< /H1
>< DIV
CLASS="REFNAMEDIV"
>< A
2001-09-14 02:41:09 +00:00
NAME="AEN5148"
2001-04-26 16:45:43 +00:00
>< /A
>< H2
>Name< /H2
>SDL_PushEvent -- Pushes an event onto the event queue< /DIV
>< DIV
CLASS="REFSYNOPSISDIV"
>< A
2001-09-14 02:41:09 +00:00
NAME="AEN5151"
2001-04-26 16:45:43 +00:00
>< /A
>< H2
>Synopsis< /H2
>< DIV
CLASS="FUNCSYNOPSIS"
>< A
2001-09-14 02:41:09 +00:00
NAME="AEN5152"
2001-04-26 16:45:43 +00:00
>< /A
>< P
>< /P
>< PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"< /PRE
>< P
>< CODE
>< CODE
CLASS="FUNCDEF"
>int < B
CLASS="FSFUNC"
>SDL_PushEvent< /B
>< /CODE
>(SDL_Event *event);< /CODE
>< /P
>< P
>< /P
>< /DIV
>< /DIV
>< DIV
CLASS="REFSECT1"
>< A
2001-09-14 02:41:09 +00:00
NAME="AEN5158"
2001-04-26 16:45:43 +00:00
>< /A
>< H2
>Description< /H2
>< P
>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
CLASS="PARAMETER"
>< I
>event< /I
>< /TT
> is a pointer to the event structure you wish to push onto the queue.< /P
>< DIV
CLASS="NOTE"
>< BLOCKQUOTE
CLASS="NOTE"
>< P
>< B
>Note: < /B
>Pushing device input events onto the queue doesn't modify the state of the device within SDL.< /P
>< /BLOCKQUOTE
>< /DIV
>< /DIV
>< DIV
CLASS="REFSECT1"
>< A
2001-09-14 02:41:09 +00:00
NAME="AEN5164"
2001-04-26 16:45:43 +00:00
>< /A
>< H2
>Return Value< /H2
>< P
>Returns < SPAN
CLASS="RETURNVALUE"
>0< /SPAN
> on success or < SPAN
CLASS="RETURNVALUE"
>-1< /SPAN
> if the event couldn't be pushed.< /P
>< /DIV
>< DIV
CLASS="REFSECT1"
>< A
2001-09-14 02:41:09 +00:00
NAME="AEN5169"
2001-04-26 16:45:43 +00:00
>< /A
>< H2
>Examples< /H2
>< P
>See < A
HREF="sdlevent.html"
>< SPAN
CLASS="STRUCTNAME"
>SDL_Event< /SPAN
>< /A
>.< /P
>< /DIV
>< DIV
CLASS="REFSECT1"
>< A
2001-09-14 02:41:09 +00:00
NAME="AEN5174"
2001-04-26 16:45:43 +00:00
>< /A
>< H2
>See Also< /H2
>< P
>< A
HREF="sdlpollevent.html"
>< TT
CLASS="FUNCTION"
>SDL_PollEvent< /TT
>< /A
>,
< A
HREF="sdlpeepevents.html"
>< TT
CLASS="FUNCTION"
>SDL_PeepEvents< /TT
>< /A
>,
< A
HREF="sdlevent.html"
>< SPAN
CLASS="STRUCTNAME"
>SDL_Event< /SPAN
>< /A
>< /P
>< /DIV
>< DIV
CLASS="NAVFOOTER"
>< HR
ALIGN="LEFT"
WIDTH="100%">< TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
>< TR
>< TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>< A
HREF="sdlwaitevent.html"
>Prev< /A
>< /TD
>< TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>< A
HREF="index.html"
>Home< /A
>< /TD
>< TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>< A
HREF="sdlseteventfilter.html"
>Next< /A
>< /TD
>< /TR
>< TR
>< TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_WaitEvent< /TD
>< TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>< A
HREF="eventfunctions.html"
>Up< /A
>< /TD
>< TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_SetEventFilter< /TD
>< /TR
>< /TABLE
>< /DIV
>< /BODY
>< /HTML
>
