Wiki Page Content

Revision 8 as of 2013-09-15 18:29:12

Clear message

SDL_FilterEvents

Use this function to run a specific filter function on the current event queue, removing any events for which the filter returns 0.

Syntax

void SDL_FilterEvents(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 SDL_EventFilter(void* userdata, SDL_Event* event)
  • where its parameters are:

    userdata

    what was passed as userdata to SDL_FilterEvents()

    event

    the desired event to pull from the queue

See SDL_SetEventFilter() for more information. Unlike SDL_SetEventFilter(), this function does not change the filter permanently, it only uses the supplied filter until this function returns.


CategoryAPI, CategoryEvents

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