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

SDL_ScreenSaverEnabled

Check whether the screensaver is currently enabled.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

SDL_bool SDL_ScreenSaverEnabled(void);

Return Value

Returns SDL_TRUE if the screensaver is enabled, SDL_FALSE if it is disabled.

Remarks

The screensaver is disabled by default.

The default can also be changed using SDL_HINT_VIDEO_ALLOW_SCREENSAVER.

Version

This function is available since SDL 3.0.0.

See Also

• SDL_DisableScreenSaver
• SDL_EnableScreenSaver

CategoryAPI, CategoryAPIFunction, CategoryVideo