#pragma section-numbers off
#pragma camelcase off

= 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.

<<TableOfContents()>>

== Syntax ==
{{{#!highlight cpp
void SDL_FilterEvents(SDL_EventFilter filter,
                      void*           userdata)
}}}

== Function Parameters ==
||'''filter'''||the function to call when an event happens; see [[#Remarks|Remarks]] for details||
||'''userdata'''||a pointer that is passed to '''filter'''||

== Code Examples ==
{{{#!highlight cpp
You can add your code example here
}}}

== Remarks ==
The function prototype for '''filter''' is:
{{{#!highlight cpp
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.

== Related Functions ==
 .[[SDL_GetEventFilter]]
 .[[SDL_SetEventFilter]]

----
[[CategoryAPI]], [[CategoryEvents]]