SDL_SetEventFilter3
Set up a filter to process all events before they are added to the internal event queue.
Usage
#include "SDL3/SDL.h"
void SDL_SetEventFilter(SDL_EventFilter filter, void *userdata);
Header file
Defined in SDL3/SDL_events.h
Overview
If you just want to see events without modifying them or preventing them from being queued, you should use SDL_AddEventWatch () instead.
If the filter function returns true when called, then the event will be added to the internal queue. If it returns false, then the event will be dropped from the queue, but the internal state will still be updated. This allows selective filtering of dynamically arriving events. WARNING : Be very careful of what you do in the event filter function, as it may run in a different thread!
On platforms that support it, if the quit event is generated by an interrupt signal (e.g. pressing Ctrl-C), it will be delivered to the application at the next event poll.
Note: Disabled events never make it to the event filter function; see
SDL_SetEventEnabled ().
Note: Events pushed onto the queue with SDL_PushEvent () get passed through the event filter, but events pushed onto the queue with
SDL_PeepEvents () do not.
Function parameters
filter
|
an |
|---|---|
userdata
|
a pointer that is passed to |
Thread safety
It is safe to call this function from any thread.
Releases
12 releases since Debian 3.0 (Woody); the text changed 2 times.