Man page - sdl_flushevent(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_FlushEvent

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
THREAD SAFETY
AVAILABILITY
SEE ALSO

NAME

SDL_FlushEvent - Clear events of a specific type from the event queue.

HEADER FILE

Defined in SDL3/SDL_events.h

SYNOPSIS

#include "SDL3/SDL.h"

void SDL_FlushEvent(Uint32 type);

DESCRIPTION

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.

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.