SDL Wiki
(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_FlushEvents

Clear events of a range of types from the event queue.

Header File

Defined in <SDL3/SDL_events.h>

Syntax

void SDL_FlushEvents(Uint32 minType, Uint32 maxType);

Function Parameters

Uint32 minType the low end of event type to be cleared, inclusive; see SDL_EventType for details.
Uint32 maxType the high end of event type to be cleared, inclusive; see SDL_EventType for details.

Remarks

This will unconditionally remove any events from the queue that are in the range of minType to maxType, inclusive. If you need to remove a single event type, use SDL_FlushEvent() instead.

It's also normal to just ignore events you don't care about in your event loop without calling this function.

This function only affects currently queued events. If you want to make sure that all pending OS events are flushed, you can call SDL_PumpEvents() on the main thread immediately before the flush call.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.

See Also


CategoryAPI, CategoryAPIFunction, 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.