Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.23 KB

SDL_AddEventWatch.mediawiki

File metadata and controls

51 lines (34 loc) · 1.23 KB

Table of Contents

SDL_AddEventWatch

Add a callback to be triggered when an event is added to the event queue.

Syntax

<syntaxhighlight lang="c"> void SDL_AddEventWatch(SDL_EventFilter filter, void *userdata); </syntaxhighlight>

Function Parameters

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

Remarks

filter will be called when an event happens, and its return value is ignored.

WARNING: Be very careful of what you do in the event filter function, as it may run in a different thread!

If the quit event is generated by a signal (e.g. SIGINT), it will bypass the internal queue and be delivered to the watch callback immediately, and arrive at the next event poll.

Note: the callback is called for events posted by the user through SDL_PushEvent(), but not for disabled events, nor for events by a filter callback set with SDL_SetEventFilter(), nor for events posted by the user through SDL_PeepEvents().

Version

This function is available since SDL 2.0.0.

Related Functions

SDL_DelEventWatch
SDL_SetEventFilter

CategoryAPI, CategoryEvents