SDL_GetEventFilter

Use this function to return the current event filter.

Syntax

SDL_bool SDL_GetEventFilter(SDL_EventFilter* filter,
                            void**           userdata)

Function Parameters

Return Value

Returns SDL_TRUE on success or SDL_FALSE if there is no event filter set_{; call [[SDL_GetError]]() for more information.}

The header says it "Returns the current event filter" but I suspect this isn't referring to the actual return value but the output of the function. Should that be included here?

Code Examples

You can add your code example here

Remarks

This function can be used to "chain" filters.

Should the following be included here as it is in SDL_SetEventFilter()? Right now this is different. 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_GetEventFilter()
  event	the desired event to query from the queue ???

Related Functions

• SDL_SetEventFilter

CategoryAPI, CategoryEvents