Check the event queue for messages and optionally return them.
int SDL_PeepEvents(SDL_Event * events, int numevents, SDL_eventaction action, Uint32 minType, Uint32 maxType);
|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 [[#action|
|minType||minimum value of the event type to be considered; SDL_EVENT_FIRST is a safe choice|
|maxType||maximum value of the event type to be considered; SDL_EVENT_LAST is a safe choice|
Returns the number of events actually stored or a negative error code on failure; call SDL_GetError() for more information.
action may be any of the following:
SDL_ADDEVENT: up to
numeventsevents will be added to the back of the event queue.
numeventsevents at the front of the event queue, within the specified minimum and maximum type, will be returned to the caller and will not be removed from the queue.
SDL_GETEVENT: up to
numeventsevents at the front of the event queue, within the specified minimum and maximum type, will be returned to the caller and will be removed from the queue.
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.
This function is available since SDL 3.0.0.
Add a code example here.