| .TH "SDL_PeepEvents" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" |
| .SH "NAME" |
| SDL_PeepEvents \- Checks the event queue for messages and optionally returns them\&. |
| .SH "SYNOPSIS" |
| .PP |
| \fB#include "SDL\&.h" |
| .sp |
| \fBint \fBSDL_PeepEvents\fP\fR(\fBSDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask\fR); |
| .SH "DESCRIPTION" |
| .PP |
| Checks the event queue for messages and optionally returns them\&. |
| .PP |
| If \fBaction\fR is \fBSDL_ADDEVENT\fP, up to \fBnumevents\fR events will be added to the back of the event queue\&. |
| .PP |
| 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\&. |
| .PP |
| 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\&. |
| .PP |
| This function is thread-safe\&. |
| .SH "RETURN VALUE" |
| .PP |
| This function returns the number of events actually stored, or \fB-1\fR if there was an error\&. |
| .SH "SEE ALSO" |
| .PP |
| \fI\fBSDL_Event\fR\fR, \fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PushEvent\fP\fR |
| .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 |
