Section: X FUNCTIONS (3)
Updated: libXext 1.3.4Index
DPMSSetTimeouts - permits applications to set the timeout valuesused by the X server for DPMS timings
cc [ flag ... ] file ... -lXext [ library ... ]#include <X11/extensions/dpms.h>
- Status DPMSSetTimeouts(
- Display *display,
- CARD16 standby,
- CARD16 suspend,
- CARD16 off);
- Specifies the connection to the X server
- Specifies the new standby timeout in seconds
- Specifies the new suspend timeout in seconds
- Specifies the new off timeout in seconds
The DPMSSetTimeouts function permits applications to set the timeout valuesused by the X server for Display Power Management Signaling (DPMS) timings.
The value standby is the amount of inactivity time, in seconds, beforestandby mode is invoked. The actualeffects of this mode are dependent on the characteristics of the monitor andframe buffer card. Standby mode isimplemented by shutting off the horizontal sync signal, and pulsing the verticalsync signal. Standby modeprovides the quickest monitor recovery time. Note also that many monitorsimplement this mode identical tosuspend mode. A value of zero disables the standby mode.
The value suspend is the amount of time of inactivity, in seconds, beforethe second level of powersavings is invoked. Suspend mode's physical and electrical characteristics areimplementation defined. For DPMScompliant hardware, setting the suspend mode is implemented by pulsing thehorizontal sync signal andshutting off the vertical sync signal. In general, suspend mode recovery isconsidered to be slower thanstandby mode, but faster than off mode. However it may vary from monitor tomonitor. As noted above, manymonitors implement this mode identical to the standby mode. A value of zerodisables this mode.
The value off is the amount of time of inactivity, in seconds, before thethird and final level of powersavings is invoked. Off mode's physical and electrical characteristics areimplementation defined. In DPMScompliant hardware, it is implemented by shutting off both horizontal andvertical sync signals, resulting inpowering down of the monitor. Recovery time is implementation dependent.Usually the recovery time is veryclose to the power-up time of the monitor. A value of zero disables this mode.
Chronologically, standby mode occurs before or simultaneously withsuspend mode, andsuspend mode must occur before or simultaneously with off mode.Therefore, non-zero mode timeoutvalues must be greater than or equal to the timeout values of earlier modes. Ifinconsistent values aresupplied, a BadValue error will result.
- TheDPMSSetTimeoutsfunction returns TRUE when the function has succeeded.
- An argument is out of range.
- RETURN VALUES
- SEE ALSO
This document was created byman2html,using the manual pages.