Mercurial > sdl-ios-xcode

view docs/man3/SDL_PeepEvents.3 @ 866:0a45995a7fc3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Date: Tue, 2 Mar 2004 11:34:54 +0100 From: Bartosz Fenski aka fEnIo Subject: outdated entry in INSTALL file I've just found in INSTALL file: If you are cross-compiling from Linux to Win32, you should read the file README.Win32 But you don't shipped this file with SDL. I've found in CVS logs that this file has been deleted and this information is now in FAQ.
author Sam Lantinga <slouken@libsdl.org>
date Tue, 02 Mar 2004 13:01:02 +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