1SDL_PeepEvents(3)              SDL API Reference             SDL_PeepEvents(3)
2
3
4

NAME

6       SDL_PeepEvents-  Checks  the  event  queue  for messages and optionally
7       returns them.
8

SYNOPSIS

10       #include "SDL.h"
11
12       int SDL_PeepEvents(SDL_Event *events,  int  numevents,  SDL_eventaction
13       action, Uint32 mask);
14

DESCRIPTION

16       Checks the event queue for messages and optionally returns them.
17
18       If  action is SDL_ADDEVENT, up to numevents events will be added to the
19       back of the event queue.
20
21       If action is SDL_PEEKEVENT, up to numevents events at the front of  the
22       event  queue,  matching  mask, will be returned and will not be removed
23       from the queue.
24
25       If action is SDL_GETEVENT, up to numevents events at the front  of  the
26       event  queue,  matching mask, will be returned and will be removed from
27       the queue.
28
29       This function is thread-safe.
30

RETURN VALUE

32       This function returns the number of events actually stored,  or  -1  if
33       there was an error.
34

SEE ALSO

36       SDL_Event, SDL_PollEvent, SDL_PushEvent
37
38
39
40SDL                         Tue 11 Sep 2001, 22:59           SDL_PeepEvents(3)