mingw/man/man3/SDL_PeepEvents.3

   1 .TH "SDL_PeepEvents" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
   2 .SH "NAME"
   3 SDL_PeepEvents\- Checks the event queue for messages and optionally returns them\&.
   4 .SH "SYNOPSIS"
   5 .PP
   6 \fB#include "SDL\&.h"
   7 .sp
   8 \fBint \fBSDL_PeepEvents\fP\fR(\fBSDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask\fR);
   9 .SH "DESCRIPTION"
  10 .PP
  11 Checks the event queue for messages and optionally returns them\&.
  12 .PP
  13 If \fBaction\fR is \fBSDL_ADDEVENT\fP, up to \fBnumevents\fR events will be added to the back of the event queue\&.
  14 .PP
  15 If \fBaction\fR is \fBSDL_PEEKEVENT\fP, up to \fBnumevents\fR events at the front of the event queue, matching \fI\fBmask\fR\fR, will be returned and will not be removed from the queue\&.
  16 .PP
  17 If \fBaction\fR is \fBSDL_GETEVENT\fP, up to \fBnumevents\fR events at the front of the event queue, matching \fI\fBmask\fR\fR, will be returned and will be removed from the queue\&.
  18 .PP
  19 This function is thread-safe\&.
  20 .SH "RETURN VALUE"
  21 .PP
  22 This function returns the number of events actually stored, or \fB-1\fR if there was an error\&.
  23 .SH "SEE ALSO"
  24 .PP
  25 \fI\fBSDL_Event\fR\fR, \fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PushEvent\fP\fR
  26 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59