====== (This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!) ======

== Draft ==

'''THIS PAGE IS A WORK IN PROGRESS''' ... Please make edits to this page to improve it!
= SDL_JoystickEventState =

Enable/disable joystick event polling.

== Syntax ==

<syntaxhighlight lang='c'>
int SDL_JoystickEventState(int state);
</syntaxhighlight>

== Function Parameters ==

{|
|'''state'''
|can be one of <code>[[SDL_QUERY]]</code>, <code>[[SDL_IGNORE]]</code>, or <code>[[SDL_ENABLE]]</code>
|}

== Return Value ==

Returns 1 if enabled, 0 if disabled, or a negative error code on failure;
call [[SDL_GetError]]() for more information.

If <code>state</code> is <code>[[SDL_QUERY]]</code> then the current state
is returned, otherwise the new processing state is returned.

== Remarks ==

If joystick events are disabled, you must call [[SDL_JoystickUpdate]]()
yourself and manually check the state of the joystick when you want
joystick information.

It is recommended that you leave joystick event handling enabled.

'''WARNING''': Calling this function may delete all events currently in
SDL's event queue.

== Version ==

This function is available since SDL 3.0.0.

== Code Examples ==

<syntaxhighlight lang='c++'>
printf("%i\n", SDL_JoystickEventState(SDL_QUERY));  /* prints 1 */
printf("%i\n", SDL_JoystickEventState(SDL_IGNORE)); /* prints 0 */
printf("%i\n", SDL_JoystickEventState(SDL_QUERY));  /* prints 0 */
</syntaxhighlight>

== Related Functions ==

:[[SDL_GameControllerEventState]]

----
[[CategoryAPI]], [[CategoryJoystick]], [[CategoryDraft]]