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

SDL_GetEventFilter

Query the current event filter.

Header File

Defined in <SDL3/SDL_events.h>

Syntax

bool SDL_GetEventFilter(SDL_EventFilter *filter, void **userdata);

Function Parameters

SDL_EventFilter *	filter	the current callback function will be stored here.
void **	userdata	the pointer that is passed to the current event filter will be stored here.

Return Value

(bool) Returns true on success or false if there is no event filter set.

Remarks

This function can be used to "chain" filters, by saving the existing filter before replacing it with a function that will call that saved filter.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_SetEventFilter

---

CategoryAPI, CategoryAPIFunction, CategoryEvents

[ 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.