docs/html/sdlpeepevents.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >SDL_PeepEvents</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_PumpEvents"
  17 HREF="sdlpumpevents.html"><LINK
  18 REL="NEXT"
  19 TITLE="SDL_PollEvent"
  20 HREF="sdlpollevent.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="sdlpumpevents.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="sdlpollevent.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="SDLPEEPEVENTS"
  74 ></A
  75 >SDL_PeepEvents</H1
  76 ><DIV
  77 CLASS="REFNAMEDIV"
  78 ><A
  79 NAME="AEN5421"
  80 ></A
  81 ><H2
  82 >Name</H2
  83 >SDL_PeepEvents&nbsp;--&nbsp;Checks the event queue for messages and optionally returns them.</DIV
  84 ><DIV
  85 CLASS="REFSYNOPSISDIV"
  86 ><A
  87 NAME="AEN5424"
  88 ></A
  89 ><H2
  90 >Synopsis</H2
  91 ><DIV
  92 CLASS="FUNCSYNOPSIS"
  93 ><A
  94 NAME="AEN5425"
  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_PeepEvents</B
 108 ></CODE
 109 >(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask);</CODE
 110 ></P
 111 ><P
 112 ></P
 113 ></DIV
 114 ></DIV
 115 ><DIV
 116 CLASS="REFSECT1"
 117 ><A
 118 NAME="AEN5431"
 119 ></A
 120 ><H2
 121 >Description</H2
 122 ><P
 123 >Checks the event queue for messages and optionally returns them.</P
 124 ><P
 125 >If <TT
 126 CLASS="PARAMETER"
 127 ><I
 128 >action</I
 129 ></TT
 130 > is <TT
 131 CLASS="LITERAL"
 132 >SDL_ADDEVENT</TT
 133 >, up to
 134 <TT
 135 CLASS="PARAMETER"
 136 ><I
 137 >numevents</I
 138 ></TT
 139 > events will be added to the back of the event
 140  queue.</P
 141 ><P
 142 >If <TT
 143 CLASS="PARAMETER"
 144 ><I
 145 >action</I
 146 ></TT
 147 > is <TT
 148 CLASS="LITERAL"
 149 >SDL_PEEKEVENT</TT
 150 >, up to
 151 <TT
 152 CLASS="PARAMETER"
 153 ><I
 154 >numevents</I
 155 ></TT
 156 > events at the front of the event queue,
 157 matching <A
 158 HREF="sdlevent.html"
 159 ><TT
 160 CLASS="PARAMETER"
 161 ><I
 162 >mask</I
 163 ></TT
 164 ></A
 165 >,
 166 will be returned and will not be removed from the queue.</P
 167 ><P
 168 >If <TT
 169 CLASS="PARAMETER"
 170 ><I
 171 >action</I
 172 ></TT
 173 > is <TT
 174 CLASS="LITERAL"
 175 >SDL_GETEVENT</TT
 176 >, up to
 177 <TT
 178 CLASS="PARAMETER"
 179 ><I
 180 >numevents</I
 181 ></TT
 182 > events at the front of the event queue,
 183 matching <A
 184 HREF="sdlevent.html"
 185 ><TT
 186 CLASS="PARAMETER"
 187 ><I
 188 >mask</I
 189 ></TT
 190 ></A
 191 >,
 192 will be returned and will be removed from the queue.</P
 193 ><P
 194 >The <TT
 195 CLASS="PARAMETER"
 196 ><I
 197 >mask</I
 198 ></TT
 199 > parameter is an bitwise OR of
 200 <TT
 201 CLASS="LITERAL"
 202 >SDL_EVENTMASK</TT
 203 >(<TT
 204 CLASS="PARAMETER"
 205 ><I
 206 >event_type</I
 207 ></TT
 208 >), for all
 209 event types you are interested in.</P
 210 ><P
 211 >This function is thread-safe.</P
 212 ></DIV
 213 ><DIV
 214 CLASS="REFSECT1"
 215 ><A
 216 NAME="AEN5455"
 217 ></A
 218 ><H2
 219 >Return Value</H2
 220 ><P
 221 >This function returns the number of events actually stored, or
 222 <SPAN
 223 CLASS="RETURNVALUE"
 224 >-1</SPAN
 225 > if there was an error.  </P
 226 ></DIV
 227 ><DIV
 228 CLASS="REFSECT1"
 229 ><A
 230 NAME="AEN5459"
 231 ></A
 232 ><H2
 233 >See Also</H2
 234 ><P
 235 ><A
 236 HREF="sdlevent.html"
 237 ><SPAN
 238 CLASS="STRUCTNAME"
 239 >SDL_Event</SPAN
 240 ></A
 241 >,
 242 <A
 243 HREF="sdlpollevent.html"
 244 ><TT
 245 CLASS="FUNCTION"
 246 >SDL_PollEvent</TT
 247 ></A
 248 >,
 249 <A
 250 HREF="sdlpushevent.html"
 251 ><TT
 252 CLASS="FUNCTION"
 253 >SDL_PushEvent</TT
 254 ></A
 255 ></P
 256 ></DIV
 257 ><DIV
 258 CLASS="NAVFOOTER"
 259 ><HR
 260 ALIGN="LEFT"
 261 WIDTH="100%"><TABLE
 262 SUMMARY="Footer navigation table"
 263 WIDTH="100%"
 264 BORDER="0"
 265 CELLPADDING="0"
 266 CELLSPACING="0"
 267 ><TR
 268 ><TD
 269 WIDTH="33%"
 270 ALIGN="left"
 271 VALIGN="top"
 272 ><A
 273 HREF="sdlpumpevents.html"
 274 ACCESSKEY="P"
 275 >Prev</A
 276 ></TD
 277 ><TD
 278 WIDTH="34%"
 279 ALIGN="center"
 280 VALIGN="top"
 281 ><A
 282 HREF="index.html"
 283 ACCESSKEY="H"
 284 >Home</A
 285 ></TD
 286 ><TD
 287 WIDTH="33%"
 288 ALIGN="right"
 289 VALIGN="top"
 290 ><A
 291 HREF="sdlpollevent.html"
 292 ACCESSKEY="N"
 293 >Next</A
 294 ></TD
 295 ></TR
 296 ><TR
 297 ><TD
 298 WIDTH="33%"
 299 ALIGN="left"
 300 VALIGN="top"
 301 >SDL_PumpEvents</TD
 302 ><TD
 303 WIDTH="34%"
 304 ALIGN="center"
 305 VALIGN="top"
 306 ><A
 307 HREF="eventfunctions.html"
 308 ACCESSKEY="U"
 309 >Up</A
 310 ></TD
 311 ><TD
 312 WIDTH="33%"
 313 ALIGN="right"
 314 VALIGN="top"
 315 >SDL_PollEvent</TD
 316 ></TR
 317 ></TABLE
 318 ></DIV
 319 ></BODY
 320 ></HTML
 321 >