| <HTML |
| ><HEAD |
| ><TITLE |
| >SDL_PeepEvents</TITLE |
| ><META |
| NAME="GENERATOR" |
| CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
| "><LINK |
| REL="HOME" |
| TITLE="SDL Library Documentation" |
| HREF="index.html"><LINK |
| REL="UP" |
| TITLE="Event Functions." |
| HREF="eventfunctions.html"><LINK |
| REL="PREVIOUS" |
| TITLE="SDL_PumpEvents" |
| HREF="sdlpumpevents.html"><LINK |
| REL="NEXT" |
| TITLE="SDL_PollEvent" |
| HREF="sdlpollevent.html"></HEAD |
| ><BODY |
| CLASS="REFENTRY" |
| BGCOLOR="#FFF8DC" |
| TEXT="#000000" |
| LINK="#0000ee" |
| VLINK="#551a8b" |
| ALINK="#ff0000" |
| ><DIV |
| CLASS="NAVHEADER" |
| ><TABLE |
| SUMMARY="Header navigation 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="sdlpumpevents.html" |
| ACCESSKEY="P" |
| >Prev</A |
| ></TD |
| ><TD |
| WIDTH="80%" |
| ALIGN="center" |
| VALIGN="bottom" |
| ></TD |
| ><TD |
| WIDTH="10%" |
| ALIGN="right" |
| VALIGN="bottom" |
| ><A |
| HREF="sdlpollevent.html" |
| ACCESSKEY="N" |
| >Next</A |
| ></TD |
| ></TR |
| ></TABLE |
| ><HR |
| ALIGN="LEFT" |
| WIDTH="100%"></DIV |
| ><H1 |
| ><A |
| NAME="SDLPEEPEVENTS" |
| ></A |
| >SDL_PeepEvents</H1 |
| ><DIV |
| CLASS="REFNAMEDIV" |
| ><A |
| NAME="AEN5421" |
| ></A |
| ><H2 |
| >Name</H2 |
| >SDL_PeepEvents -- Checks the event queue for messages and optionally returns them.</DIV |
| ><DIV |
| CLASS="REFSYNOPSISDIV" |
| ><A |
| NAME="AEN5424" |
| ></A |
| ><H2 |
| >Synopsis</H2 |
| ><DIV |
| CLASS="FUNCSYNOPSIS" |
| ><A |
| NAME="AEN5425" |
| ></A |
| ><P |
| ></P |
| ><PRE |
| CLASS="FUNCSYNOPSISINFO" |
| >#include "SDL.h"</PRE |
| ><P |
| ><CODE |
| ><CODE |
| CLASS="FUNCDEF" |
| >int <B |
| CLASS="FSFUNC" |
| >SDL_PeepEvents</B |
| ></CODE |
| >(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask);</CODE |
| ></P |
| ><P |
| ></P |
| ></DIV |
| ></DIV |
| ><DIV |
| CLASS="REFSECT1" |
| ><A |
| NAME="AEN5431" |
| ></A |
| ><H2 |
| >Description</H2 |
| ><P |
| >Checks the event queue for messages and optionally returns them.</P |
| ><P |
| >If <TT |
| CLASS="PARAMETER" |
| ><I |
| >action</I |
| ></TT |
| > is <TT |
| CLASS="LITERAL" |
| >SDL_ADDEVENT</TT |
| >, up to |
| <TT |
| CLASS="PARAMETER" |
| ><I |
| >numevents</I |
| ></TT |
| > events will be added to the back of the event |
| queue.</P |
| ><P |
| >If <TT |
| CLASS="PARAMETER" |
| ><I |
| >action</I |
| ></TT |
| > is <TT |
| CLASS="LITERAL" |
| >SDL_PEEKEVENT</TT |
| >, up to |
| <TT |
| CLASS="PARAMETER" |
| ><I |
| >numevents</I |
| ></TT |
| > events at the front of the event queue, |
| matching <A |
| HREF="sdlevent.html" |
| ><TT |
| CLASS="PARAMETER" |
| ><I |
| >mask</I |
| ></TT |
| ></A |
| >, |
| will be returned and will not be removed from the queue.</P |
| ><P |
| >If <TT |
| CLASS="PARAMETER" |
| ><I |
| >action</I |
| ></TT |
| > is <TT |
| CLASS="LITERAL" |
| >SDL_GETEVENT</TT |
| >, up to |
| <TT |
| CLASS="PARAMETER" |
| ><I |
| >numevents</I |
| ></TT |
| > events at the front of the event queue, |
| matching <A |
| HREF="sdlevent.html" |
| ><TT |
| CLASS="PARAMETER" |
| ><I |
| >mask</I |
| ></TT |
| ></A |
| >, |
| will be returned and will be removed from the queue.</P |
| ><P |
| >The <TT |
| CLASS="PARAMETER" |
| ><I |
| >mask</I |
| ></TT |
| > parameter is an bitwise OR of |
| <TT |
| CLASS="LITERAL" |
| >SDL_EVENTMASK</TT |
| >(<TT |
| CLASS="PARAMETER" |
| ><I |
| >event_type</I |
| ></TT |
| >), for all |
| event types you are interested in.</P |
| ><P |
| >This function is thread-safe.</P |
| ></DIV |
| ><DIV |
| CLASS="REFSECT1" |
| ><A |
| NAME="AEN5455" |
| ></A |
| ><H2 |
| >Return Value</H2 |
| ><P |
| >This function returns the number of events actually stored, or |
| <SPAN |
| CLASS="RETURNVALUE" |
| >-1</SPAN |
| > if there was an error. </P |
| ></DIV |
| ><DIV |
| CLASS="REFSECT1" |
| ><A |
| NAME="AEN5459" |
| ></A |
| ><H2 |
| >See Also</H2 |
| ><P |
| ><A |
| HREF="sdlevent.html" |
| ><SPAN |
| CLASS="STRUCTNAME" |
| >SDL_Event</SPAN |
| ></A |
| >, |
| <A |
| HREF="sdlpollevent.html" |
| ><TT |
| CLASS="FUNCTION" |
| >SDL_PollEvent</TT |
| ></A |
| >, |
| <A |
| HREF="sdlpushevent.html" |
| ><TT |
| CLASS="FUNCTION" |
| >SDL_PushEvent</TT |
| ></A |
| ></P |
| ></DIV |
| ><DIV |
| CLASS="NAVFOOTER" |
| ><HR |
| ALIGN="LEFT" |
| WIDTH="100%"><TABLE |
| SUMMARY="Footer navigation table" |
| WIDTH="100%" |
| BORDER="0" |
| CELLPADDING="0" |
| CELLSPACING="0" |
| ><TR |
| ><TD |
| WIDTH="33%" |
| ALIGN="left" |
| VALIGN="top" |
| ><A |
| HREF="sdlpumpevents.html" |
| ACCESSKEY="P" |
| >Prev</A |
| ></TD |
| ><TD |
| WIDTH="34%" |
| ALIGN="center" |
| VALIGN="top" |
| ><A |
| HREF="index.html" |
| ACCESSKEY="H" |
| >Home</A |
| ></TD |
| ><TD |
| WIDTH="33%" |
| ALIGN="right" |
| VALIGN="top" |
| ><A |
| HREF="sdlpollevent.html" |
| ACCESSKEY="N" |
| >Next</A |
| ></TD |
| ></TR |
| ><TR |
| ><TD |
| WIDTH="33%" |
| ALIGN="left" |
| VALIGN="top" |
| >SDL_PumpEvents</TD |
| ><TD |
| WIDTH="34%" |
| ALIGN="center" |
| VALIGN="top" |
| ><A |
| HREF="eventfunctions.html" |
| ACCESSKEY="U" |
| >Up</A |
| ></TD |
| ><TD |
| WIDTH="33%" |
| ALIGN="right" |
| VALIGN="top" |
| >SDL_PollEvent</TD |
| ></TR |
| ></TABLE |
| ></DIV |
| ></BODY |
| ></HTML |
| > |
