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

SDL_EventFilter

A function pointer used for callbacks that watch the event queue.

Header File

Syntax

typedef bool (SDLCALL *SDL_EventFilter)(void *userdata, SDL_Event *event);

Function Parameters

userdata	what was passed as `userdata` to SDL_SetEventFilter() or SDL_AddEventWatch, etc.
event	the event that triggered the callback.

Return Value

Returns true to permit event to be added to the queue, and false to disallow it. When used with SDL_AddEventWatch, the return value is ignored.

Thread Safety

SDL may call this callback at any time from any thread; the application is responsible for locking resources the callback touches that need to be protected.

Version

This datatype is available since SDL 3.1.3.