(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_EventState

Set the state of processing events by type.

Header File

Defined in SDL_events.h

Syntax

Uint8 SDL_EventState(Uint32 type, int state);

Function Parameters

Return Value

Returns SDL_DISABLE or SDL_ENABLE, representing the processing state of the event before this function makes any changes to it.

Remarks

state may be any of the following:

• SDL_QUERY: returns the current processing state of the specified event
• SDL_IGNORE (aka SDL_DISABLE): the event will automatically be dropped from the event queue and will not be filtered
• SDL_ENABLE: the event will be processed normally

Version

This function is available since SDL 2.0.0.

See Also

• SDL_GetEventState

CategoryAPI, CategoryAPIFunction, CategoryEvents