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

SDL_ScreenSaverEnabled

Check whether the screensaver is currently enabled.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

bool SDL_ScreenSaverEnabled(void);

Return Value

(bool) Returns true if the screensaver is enabled, false if it is disabled.

Remarks

The screensaver is disabled by default.

The default can also be changed using 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


CategoryAPI, CategoryAPIFunction, CategoryVideo


[ edit | delete | history | feedback | raw ]

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