Mercurial > sdl-ios-xcode

view docs/man3/SDL_PeepEvents.3 @ 3083:0bc41e0361d3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Date: Mon, 2 Mar 2009 16:27:42 +0200 From: "Mike Gorchak" Subject: About QNX support in SDL 1.3 Right now I'm working on QNX SDL 1.3 drivers implementation and looks like a lot of code must be completely reworked. But I'm ready for it :) Also I want to add QNX Graphics Framework SDL driver, which is fullscreen graphics framework, with support of hardware accelerated OpenGL ES implementations. This Graphics Framework (called GF in QNX) could also use QNX Photon (window manager GUI) as window manager. In the attachment initial patch for QNX support in SDL 1.3
author Sam Lantinga <slouken@libsdl.org>
date Tue, 03 Mar 2009 04:21:51 +0000
parents 546f7c1eb755
children 1238da4a7112
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