====== (This is the legacy documentation for stable SDL2, the current stable version; [https://wiki.libsdl.org/SDL3/ SDL3] is the current development version.) ======

== Draft ==

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

A variable controlling whether the idle timer is disabled on iOS.

== Header File ==

Defined in [SDL_hints.h](https://github.com/libsdl-org/SDL/blob/SDL2/include/SDL_hints.h), but apps should _only_ `#include "SDL.h"`!

== Syntax ==

<syntaxhighlight lang='c'>
#define SDL_HINT_IDLE_TIMER_DISABLED "SDL_IOS_IDLE_TIMER_DISABLED"</syntaxhighlight>

== Remarks ==

When an iOS app does not receive touches for some time, the screen is
dimmed automatically. For games where the accelerometer is the only input
this is problematic. This functionality can be disabled by setting this
hint.

As of SDL 2.0.4, [[SDL_EnableScreenSaver]]() and
[[SDL_DisableScreenSaver]]() accomplish the same thing on iOS. They should
be preferred over this hint.

This variable can be set to the following values: "0" - Enable idle timer
"1" - Disable idle timer

== Default ==

By default the idle timer is enabled.

----
[[CategoryAPI]], [[CategoryAPIMacro]], [[CategoryDefine]], [[CategoryHints]], [[CategoryDraft]]