devela::_dep::sdl3::sys::events

Function SDL_FlushEvent

pub unsafe extern "C" fn SDL_FlushEvent(type: u32)
Available on crate feature dep_sdl3 only.
Expand description

Clear events of a specific type from the event queue.

This will unconditionally remove any events from the queue that match type. If you need to remove a range of event types, use SDL_FlushEvents() 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.

If you have user events with custom data that needs to be freed, you should use SDL_PeepEvents() to remove and clean up those events before calling this function.

§Parameters

  • type: the type of event to be cleared; see SDL_EventType for details.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.

§See also