Skip to content

TSdlScreenSaver

Screen saver functionality

Definition

Unit: Neslib.Sdl3.Video

type TSdlScreenSaver = record ... end;

Properties

Name Description
IsEnabled Whether the screen saver is currently enabled.

Methods

Name Description
Disable Disable the screen saver.
Enable Enable the screen saver.

Property Descriptions

IsEnabled

Whether the screen saver is currently enabled.

The screen saver is disabled by default.

The default can also be changed using TSdlHints.VideoAllowScreenSaver.

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

class property IsEnabled: Boolean read GetEnabled write SetEnabled

Type: Boolean

Exceptions

ESdlError: Raised on failure.

See Also

Remarks

This property should only be used on the main thread.


Method Descriptions

Disable

Disable the screen saver.

The screen saver is disabled by default.

The default can also be changed using TSdlHints.VideoAllowScreenSaver.

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

class procedure Disable; inline; static

Exceptions

ESdlError: Raised on failure.

See Also

Remarks

This method should only be used on the main thread.


Enable

Enable the screen saver.

The screen saver is disabled by default.

The default can also be changed using TSdlHints.VideoAllowScreenSaver.

class procedure Enable; inline; static

Exceptions

ESdlError: Raised on failure.

See Also

Remarks

This method should only be used on the main thread.