📄 sdlpeepevents.html
字号:
<HTML><HEAD><TITLE>SDL_PeepEvents</TITLE><METANAME="GENERATOR"CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+"><LINKREL="HOME"TITLE="SDL Library Documentation"HREF="index.html"><LINKREL="UP"TITLE="Event Functions."HREF="eventfunctions.html"><LINKREL="PREVIOUS"TITLE="SDL_PumpEvents"HREF="sdlpumpevents.html"><LINKREL="NEXT"TITLE="SDL_PollEvent"HREF="sdlpollevent.html"></HEAD><BODYCLASS="REFENTRY"BGCOLOR="#FFF8DC"TEXT="#000000"LINK="#0000ee"VLINK="#551a8b"ALINK="#ff0000"><DIVCLASS="NAVHEADER"><TABLESUMMARY="Header navigation table"WIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><THCOLSPAN="3"ALIGN="center">SDL Library Documentation</TH></TR><TR><TDWIDTH="10%"ALIGN="left"VALIGN="bottom"><AHREF="sdlpumpevents.html"ACCESSKEY="P">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom"></TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="sdlpollevent.html"ACCESSKEY="N">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="SDLPEEPEVENTS"></A>SDL_PeepEvents</H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN5421"></A><H2>Name</H2>SDL_PeepEvents -- Checks the event queue for messages and optionally returns them.</DIV><DIVCLASS="REFSYNOPSISDIV"><ANAME="AEN5424"></A><H2>Synopsis</H2><DIVCLASS="FUNCSYNOPSIS"><ANAME="AEN5425"></A><P></P><PRECLASS="FUNCSYNOPSISINFO">#include "SDL.h"</PRE><P><CODE><CODECLASS="FUNCDEF">int <BCLASS="FSFUNC">SDL_PeepEvents</B></CODE>(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask);</CODE></P><P></P></DIV></DIV><DIVCLASS="REFSECT1"><ANAME="AEN5431"></A><H2>Description</H2><P>Checks the event queue for messages and optionally returns them.</P><P>If <TTCLASS="PARAMETER"><I>action</I></TT> is <TTCLASS="LITERAL">SDL_ADDEVENT</TT>, up to <TTCLASS="PARAMETER"><I>numevents</I></TT> events will be added to the back of the event queue.</P><P>If <TTCLASS="PARAMETER"><I>action</I></TT> is <TTCLASS="LITERAL">SDL_PEEKEVENT</TT>, up to<TTCLASS="PARAMETER"><I>numevents</I></TT> events at the front of the event queue, matching <AHREF="sdlevent.html"><TTCLASS="PARAMETER"><I>mask</I></TT></A>, will be returned and will not be removed from the queue.</P><P>If <TTCLASS="PARAMETER"><I>action</I></TT> is <TTCLASS="LITERAL">SDL_GETEVENT</TT>, up to <TTCLASS="PARAMETER"><I>numevents</I></TT> events at the front of the event queue, matching <AHREF="sdlevent.html"><TTCLASS="PARAMETER"><I>mask</I></TT></A>, will be returned and will be removed from the queue.</P><P>The <TTCLASS="PARAMETER"><I>mask</I></TT> parameter is an bitwise OR of<TTCLASS="LITERAL">SDL_EVENTMASK</TT>(<TTCLASS="PARAMETER"><I>event_type</I></TT>), for allevent types you are interested in.</P><P>This function is thread-safe.</P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN5455"></A><H2>Return Value</H2><P>This function returns the number of events actually stored, or <SPANCLASS="RETURNVALUE">-1</SPAN> if there was an error. </P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN5459"></A><H2>See Also</H2><P><AHREF="sdlevent.html"><SPANCLASS="STRUCTNAME">SDL_Event</SPAN></A>,<AHREF="sdlpollevent.html"><TTCLASS="FUNCTION">SDL_PollEvent</TT></A>,<AHREF="sdlpushevent.html"><TTCLASS="FUNCTION">SDL_PushEvent</TT></A></P></DIV><DIVCLASS="NAVFOOTER"><HRALIGN="LEFT"WIDTH="100%"><TABLESUMMARY="Footer navigation table"WIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top"><AHREF="sdlpumpevents.html"ACCESSKEY="P">Prev</A></TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="index.html"ACCESSKEY="H">Home</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top"><AHREF="sdlpollevent.html"ACCESSKEY="N">Next</A></TD></TR><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top">SDL_PumpEvents</TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="eventfunctions.html"ACCESSKEY="U">Up</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top">SDL_PollEvent</TD></TR></TABLE></DIV></BODY></HTML>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -