SDL_ScreenSaverEnabled(3)

SDL_ScreenSaverEnabled3

Check whether the screensaver is currently enabled.

Usage

#include "SDL3/SDL.h"

bool SDL_ScreenSaverEnabled(void);

Header file

Defined in SDL3/SDL_video.h

Overview

The screensaver is disabled by default.

The default can also be changed using

SDL_HINT_VIDEO_ALLOW_SCREENSAVER .

Return value

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

Thread safety

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.