XSetScreenSaver(3X11)XSetScreenSaver(3X11)NAME
XSetScreenSaver, XForceScreenSaver, XActivateScreenSaver, XResetScreen‐
Saver, XGetScreenSaver - manipulate the screen saver
SYNOPSIS
XSetScreenSaver(display, timeout, interval, prefer_blanking,
allow_exposures)
Display *display;
int timeout, interval;
int prefer_blanking;
int allow_exposures;
XForceScreenSaver(display, mode)
Display *display;
int mode;
XActivateScreenSaver(display)
Display *display;
XResetScreenSaver(display)
Display *display;
XGetScreenSaver(display, timeout_return, interval_return, prefer_blank‐
ing_return, allow_exposures_return)
Display *display;
int *timeout_return, *interval_return;
int *prefer_blanking_return;
int *allow_exposures_return;
ARGUMENTS
Specifies the screen save control values. You can pass DontAllowExpo‐
sures, AllowExposures, or DefaultExposures. Returns the current screen
save control value (DontAllowExposures, AllowExposures, or DefaultExpo‐
sures). Specifies the connection to the X server. Specifies the
interval, in seconds, between screen saver alterations. Returns the
interval between screen saver invocations. Specifies the mode that is
to be applied. You can pass ScreenSaverActive or ScreenSaverReset.
Specifies how to enable screen blanking. You can pass DontPreferBlank‐
ing, PreferBlanking, or DefaultBlanking. Returns the current screen
blanking preference (DontPreferBlanking, PreferBlanking, or Default‐
Blanking). Specifies the timeout, in seconds, until the screen saver
turns on. Returns the timeout, in seconds, until the screen saver
turns on.
DESCRIPTION
Timeout and interval are specified in seconds. A timeout of 0 disables
the screen saver (but an activated screen saver is not deactivated),
and a timeout of -1 restores the default. Other negative values gener‐
ate a BadValue error. If the timeout value is nonzero, XSetScreenSaver
enables the screen saver. An interval of 0 disables the random-pattern
motion. If no input from devices (keyboard, mouse, and so on) is gener‐
ated for the specified number of timeout seconds once the screen saver
is enabled, the screen saver is activated.
For each screen, if blanking is preferred and the hardware supports
video blanking, the screen simply goes blank. Otherwise, if either
exposures are allowed or the screen can be regenerated without sending
Expose events to clients, the screen is tiled with the root window
background tile randomly re-origined each interval seconds. Otherwise,
the screens' state do not change, and the screen saver is not acti‐
vated. The screen saver is deactivated, and all screen states are
restored at the next keyboard or pointer input or at the next call to
XForceScreenSaver with mode ScreenSaverReset.
If the server-dependent screen saver method supports periodic change,
the interval argument serves as a hint about how long the change period
should be, and zero hints that no periodic change should be made. Exam‐
ples of ways to change the screen include scrambling the colormap peri‐
odically, moving an icon image around the screen periodically, or
tiling the screen with the root window background tile, randomly re-
origined periodically.
XSetScreenSaver can generate a BadValue error.
If the specified mode is ScreenSaverActive and the screen saver cur‐
rently is deactivated, XForceScreenSaver activates the screen saver
even if the screen saver had been disabled with a timeout of zero. If
the specified mode is ScreenSaverReset and the screen saver currently
is enabled, XForceScreenSaver deactivates the screen saver if it was
activated, and the activation timer is reset to its initial state (as
if device input had been received).
XForceScreenSaver can generate a BadValue error.
The XActivateScreenSaver function activates the screen saver.
The XResetScreenSaver function resets the screen saver.
The XGetScreenSaver function gets the current screen saver values.
DIAGNOSTICS
Some numeric value falls outside the range of values accepted by the
request. Unless a specific range is specified for an argument, the full
range defined by the argument's type is accepted. Any argument defined
as a set of alternatives can generate this error.
SEE ALSO
Xlib -- C Language X Interface
XSetScreenSaver(3X11)
