(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable 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

Uint32	type	the type of event; see SDL_EventType for details.
int	state	how to process the event.

Return Value

(Uint8) 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

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.