diff -r ffa851df0825 -r 2fb8b9db1c86 symbian-qemu-0.9.1-12/libsdl-trunk/docs/html/sdlpeepevents.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/symbian-qemu-0.9.1-12/libsdl-trunk/docs/html/sdlpeepevents.html Fri Jul 31 15:01:17 2009 +0100 @@ -0,0 +1,321 @@ +SDL_PeepEvents
SDL Library Documentation
PrevNext

SDL_PeepEvents

Name

SDL_PeepEvents -- Checks the event queue for messages and optionally returns them.

Synopsis

#include "SDL.h"

int SDL_PeepEvents(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask);

Description

Checks the event queue for messages and optionally returns them.

If action is SDL_ADDEVENT, up to +numevents events will be added to the back of the event + queue.

If action is SDL_PEEKEVENT, up to +numevents events at the front of the event queue, +matching mask, +will be returned and will not be removed from the queue.

If action is SDL_GETEVENT, up to +numevents events at the front of the event queue, +matching mask, +will be returned and will be removed from the queue.

The mask parameter is an bitwise OR of +SDL_EVENTMASK(event_type), for all +event types you are interested in.

This function is thread-safe.

Return Value

This function returns the number of events actually stored, or +-1 if there was an error.

See Also

SDL_Event, +SDL_PollEvent, +SDL_PushEvent

PrevHomeNext
SDL_PumpEventsUpSDL_PollEvent
\ No newline at end of file