DRAFT

SDL_AddEventWatch

Use this function to add a callback to be triggered when an event is added to the event queue.

Syntax

void SDL_AddEventWatch(SDL_EventFilter filter,
                       void*           userdata)

Function Parameters

filter

the function to call when an event happens; see Remarks for details

userdata

a pointer that is passed to filter

Code Examples

You can add your code example here

Remarks

The function prototype for filter is:

  • int YourEventFilter(void*      userdata,
                        SDL_Event* event)
  • where YourEventFilter is the name of your function and its parameters are:

    userdata

    what was passed as userdata to SDL_AddEventWatch()

    event

    the event that triggered the callback

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

/!\ 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.


CategoryAPI, CategoryEvents

SDL_AddEventWatch (last edited 2012-02-05 16:06:50 by JonasThiem)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit