Ecore_X_DPMS_Group (3) - Linux Manuals

Ecore_X_DPMS_Group: Functions related to the X DPMS extension.

NAME

X DPMS Extension Functions - Functions related to the X DPMS extension.

Functions

EAPI int ecore_x_dpms_query (void)
Checks if the DPMS extension is available or not.
EAPI void ecore_x_dpms_capable_get_prefetch (void)
Sends the DPMSCapable request.
EAPI void ecore_x_dpms_capable_get_fetch (void)
Gets the reply of the DPMSCapable request sent by ecore_x_dpms_capable_get_prefetch().
EAPI int ecore_x_dpms_capable_get (void)
Checks if the X server is capable of DPMS.
EAPI void ecore_x_dpms_enable_get_prefetch (void)
Sends the DPMSInfo request.
EAPI void ecore_x_dpms_enable_get_fetch (void)
Gets the reply of the DPMSInfo request sent by ecore_x_dpms_enable_get_prefetch().
EAPI int ecore_x_dpms_enable_get (void)
Checks the DPMS state of the display.
EAPI void ecore_x_dpms_enabled_set (int enabled)
Sets the DPMS state of the display.
EAPI int ecore_x_dpms_timeouts_set (unsigned int standby, unsigned int suspend, unsigned int off)
Sets the timeouts.
EAPI void ecore_x_dpms_timeouts_get_prefetch (void)
Sends the DPMSGetTimeouts request.
EAPI void ecore_x_dpms_timeouts_get_fetch (void)
Gets the reply of the DPMSGetTimeouts request sent by ecore_x_dpms_timeouts_get_prefetch().
EAPI void ecore_x_dpms_timeouts_get (unsigned int *standby, unsigned int *suspend, unsigned int *off)
Gets the timeouts.
EAPI unsigned int ecore_x_dpms_timeout_standby_get (void)
Returns the amount of time of inactivity before standby mode is invoked.
EAPI unsigned int ecore_x_dpms_timeout_suspend_get (void)
Returns the amount of time of inactivity before the second level of power saving is invoked.
EAPI unsigned int ecore_x_dpms_timeout_off_get (void)
Returns the amount of time of inactivity before the third and final level of power saving is invoked.
EAPI void ecore_x_dpms_timeout_standby_set (unsigned int new_standby)
Sets the standby timeout (in unit of seconds).
EAPI void ecore_x_dpms_timeout_suspend_set (unsigned int new_suspend)
Sets the suspend timeout (in unit of seconds).
EAPI void ecore_x_dpms_timeout_off_set (unsigned int new_off)
Sets the off timeout (in unit of seconds).
EAPI int ecore_x_dpms_enabled_get (void)
Checks the DPMS state of the display.

Detailed Description

Functions related to the X DPMS extension.

Function Documentation

EAPI int ecore_x_dpms_capable_get (void)

Checks if the X server is capable of DPMS.

Returns:

1 if the X server is capable of DPMS, 0 otherwise.

To use this function, you must call before, and in order, ecore_x_dpms_capable_get_prefetch(), which sends the DPMSCapable request, then ecore_x_dpms_capable_get_fetch(), which gets the reply.

Returns:

1 if the X server is capable of DPMS, 0 otherwise.

EAPI int ecore_x_dpms_enable_get (void)

Checks the DPMS state of the display.

Returns:

1 if DPMS is enabled, 0 otherwise.

To use this function, you must call before, and in order, ecore_x_dpms_enapable_get_prefetch(), which sends the DPMSInfo request, then ecore_x_dpms_enapable_get_fetch(), which gets the reply.

EAPI int ecore_x_dpms_enabled_get (void)

Checks the DPMS state of the display.

Returns:

1 if DPMS is enabled, 0 otherwise.

EAPI void ecore_x_dpms_enabled_set (int enabled)

Sets the DPMS state of the display.

Parameters:

enabled 0 to disable DPMS characteristics of the server, enable it otherwise.

EAPI int ecore_x_dpms_query (void)

Checks if the DPMS extension is available or not.

Checks if the X DPMS extension is available on the server.

Returns:

1 if the DPMS extension is available, 0 otherwise.

Return 1 if the X server supports the DPMS Extension version 1.0, 0 otherwise.

Returns:

1 if the X DPMS extension is available, 0 otherwise.

EAPI unsigned int ecore_x_dpms_timeout_off_get (void)

Returns the amount of time of inactivity before the third and final level of power saving is invoked.

Returns:

The off timeout value.

To use this function, you must call before, and in order, ecore_x_dpms_timeouts_get_prefetch(), which sends the DPMSGetTimeouts request, then ecore_x_dpms_timeouts_get_fetch(), which gets the reply.

Returns:

The off timeout value.

EAPI void ecore_x_dpms_timeout_off_set (unsigned int new_timeout)

Sets the off timeout (in unit of seconds).

Parameters:

off Amount of time of inactivity before the monitor is shut off.

To use this function, you must call before, and in order, ecore_x_dpms_timeouts_get_prefetch(), which sends the DPMSGetTimeouts request, then ecore_x_dpms_timeouts_get_fetch(), which gets the reply.

Parameters:

off Amount of time of inactivity before the monitor is shut off.

EAPI unsigned int ecore_x_dpms_timeout_standby_get (void)

Returns the amount of time of inactivity before standby mode is invoked.

Returns:

The standby timeout value.

To use this function, you must call before, and in order, ecore_x_dpms_timeouts_get_prefetch(), which sends the DPMSGetTimeouts request, then ecore_x_dpms_timeouts_get_fetch(), which gets the reply.

Returns:

The standby timeout value.

EAPI void ecore_x_dpms_timeout_standby_set (unsigned int new_timeout)

Sets the standby timeout (in unit of seconds).

Parameters:

new_standby Amount of time of inactivity before standby mode will be invoked.

To use this function, you must call before, and in order, ecore_x_dpms_timeouts_get_prefetch(), which sends the DPMSGetTimeouts request, then ecore_x_dpms_timeouts_get_fetch(), which gets the reply.

Parameters:

new_standby Amount of time of inactivity before standby mode will be invoked.

EAPI unsigned int ecore_x_dpms_timeout_suspend_get (void)

Returns the amount of time of inactivity before the second level of power saving is invoked.

Returns:

The suspend timeout value.

To use this function, you must call before, and in order, ecore_x_dpms_timeouts_get_prefetch(), which sends the DPMSGetTimeouts request, then ecore_x_dpms_timeouts_get_fetch(), which gets the reply.

Returns:

The suspend timeout value.

EAPI void ecore_x_dpms_timeout_suspend_set (unsigned int new_timeout)

Sets the suspend timeout (in unit of seconds).

Parameters:

suspend Amount of time of inactivity before the screen is placed into suspend mode.

To use this function, you must call before, and in order, ecore_x_dpms_timeouts_get_prefetch(), which sends the DPMSGetTimeouts request, then ecore_x_dpms_timeouts_get_fetch(), which gets the reply.

Parameters:

suspend Amount of time of inactivity before the screen is placed into suspend mode.

EAPI void ecore_x_dpms_timeouts_get (unsigned int * standby, unsigned int * suspend, unsigned int * off)

Gets the timeouts.

The values are in unit of seconds.

Parameters:

standby Amount of time of inactivity before standby mode will be invoked.
suspend Amount of time of inactivity before the screen is placed into suspend mode.
off Amount of time of inactivity before the monitor is shut off.

EAPI int ecore_x_dpms_timeouts_set (unsigned int standby, unsigned int suspend, unsigned int off)

Sets the timeouts.

The values are in unit of seconds.

Parameters:

standby Amount of time of inactivity before standby mode will be invoked.
suspend Amount of time of inactivity before the screen is placed into suspend mode.
off Amount of time of inactivity before the monitor is shut off.

Returns:

Returns always 1.

The values are in unit of seconds.

Parameters:

standby Amount of time of inactivity before standby mode will be invoked.
suspend Amount of time of inactivity before the screen is placed into suspend mode.
off Amount of time of inactivity before the monitor is shut off.

Author

Generated automatically by Doxygen for Ecore from the source code.