This is new wiki software and old wiki content. It's a work in progress!
Here's the explanation.
Be gentle, report bugs, leave feedback on pages, or just edit them yourself! Thanks!

SDL Wiki

SDL_PeepEvents

Check the event queue for messages and optionally return them.

Syntax

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

Function Parameters

events

destination buffer for the retrieved events

numevents

if action is SDL_ADDEVENT, the number of events to add back to the event queue; if action is SDL_PEEKEVENT or SDL_GETEVENT, the maximum number of events to retrieve

action

action to take; see Remarks for details

minType

minimum value of the event type to be considered; SDL_FIRSTEVENT is a safe choice

maxType

maximum value of the event type to be considered; SDL_LASTEVENT is a safe choice

Return Value

Returns the number of events actually stored or a negative error code on failure; call SDL_GetError() for more information.

Remarks

action may be any of the following:

You may have to call SDL_PumpEvents() before calling this function. Otherwise, the events may not be ready to be filtered when you call SDL_PeepEvents().

This function is thread-safe.

Code Examples

Add a code example here.
SDL_PollEvent
SDL_PumpEvents
SDL_PushEvent

CategoryAPI, CategoryEvents


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.