Mercurial > sdl-ios-xcode
view docs/man3/SDL_PeepEvents.3 @ 4347:38f22ed3a433 SDL-1.2
Option to fix bug #851
For some people setting the period size works better (and is what SDL 1.2.13 did), but for most people it's the same or worse. You can use an environment variable to pick which one you want.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Sat, 17 Oct 2009 06:55:17 +0000 |
| parents | 1238da4a7112 |
| children |
line wrap: on
line source
.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