(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_FilterEvents

Run a specific filter function on the current event queue, removing any events for which the filter returns 0.

Header File

Syntax

void SDL_FilterEvents(SDL_EventFilter filter,
                      void *userdata);

Function Parameters

SDL_EventFilter	filter	the SDL_EventFilter function to call when an event happens.
void *	userdata	a pointer that is passed to `filter`.

Remarks

See SDL_SetEventFilter() for more information. Unlike SDL_SetEventFilter(), this function does not change the filter permanently, it only uses the supplied filter until this function returns.

Version

This function is available since SDL 2.0.0.