gf_display_set_dpms()

Set the display power-saving mode

Synopsis:

#include <gf/gf.h>

int gf_display_set_dpms (
        gf_display_t    display,
        unsigned        mode );

Arguments:

display
The handle for the display to set the DPMS mode for. This handle is returned by gf_display_attach().
mode
The DPMS mode. Possible values are:

Library:

gf

Description:

This function sets the display power-saving mode based on VESA Display Power Management System standards.

Mode Description
GF_DPMS_ON The display is in full operation (Video:Active, Horizontal: Sync Pulses, Vertical: Sync Pulses)
GF_DPMS_STANDBY An optional state of minimal power reduction with the shortest display recovery time (Video: Blanked, Horizontal Sync: off, Vertical Sync: Pulses)
GF_DPMS_SUSPEND A state with substantial power reduction, but the display recovery time can be longer than that of the standby state (Video: Blanked, Horizontal Sync: Pulses, Vertical Sync: off)
GF_DPMS_OFF The display is consuming the lowest level of power and is nonoperational (Video: Blanked, Horizontal Sync: off, Vertical Sync: off)

Returns:

GF_ERR_OK
Success.
GF_ERR_NOSUPPORT
DPMS is not supported on the specified display.
GF_ERR_PARM
Invalid mode value.
GF_ERR_IODISPLAY
Error communicating with io-display. Check to ensure that io-display is running. The sloginfo utility may provide more information.

Classification:

QNX Graphics Framework

Safety:
Interrupt handler No
Signal handler No
Thread Yes

See also:

gf_display_attach(), gf_display_detach()