DRAFT

SDL_FilterEvents

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

Is this more appropriate wording for this context?


Use this function to filter the current event queue and remove filtered events.

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.


CategoryAPI, CategoryEvents

SDL_FilterEvents (last edited 2011-11-07 01:11:52 by SheenaSmith)

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