(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_DisableScreenSaver

Prevent the screen from being blanked by a screen saver.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

bool SDL_DisableScreenSaver(void);

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

If you disable the screensaver, it is automatically re-enabled when SDL quits.

The screensaver is disabled by default, but this may by changed by SDL_HINT_VIDEO_ALLOW_SCREENSAVER.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_EnableScreenSaver
• SDL_ScreenSaverEnabled

---

CategoryAPI, CategoryAPIFunction, CategoryVideo

[ 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.