====== (This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!) ======
= SDL_EventState =
Set the state of processing events by type.
== Syntax ==
Uint8 SDL_EventState(Uint32 type, int state);
== Function Parameters ==
{|
|'''type'''
|the type of event; see [[SDL_EventType]] for details
|-
|'''state'''
|how to process the event
|}
== 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 3.0.0.
== Related Functions ==
:[[SDL_GetEventState]]
----
[[CategoryAPI]], [[CategoryEvents]]