Mercurial > sdl-ios-xcode
view docs/man3/SDL_PeepEvents.3 @ 1643:51038e80ae59
More general fix for bug #189
The clipping is done at a higher level, and the low level functions are
passed clipped rectangles. Drivers which don't support source clipping
have not been changed, so the image will be squished instead of clipped,
but at least they will no longer crash when the destination rect was out
of bounds.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Mon, 17 Apr 2006 06:47:23 +0000 |
| parents | e5bc29de3f0a |
| children | 546f7c1eb755 |
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