MythTV  master
Macros | Functions
The zwp_idle_inhibitor_v1 interface

An idle inhibitor prevents the output that the associated surface is visible on from being set to a state where it is not visually usable due to lack of user interaction (e.g. blanked, dimmed, locked, set to power save, etc.) Any screensaver processes are also blocked from displaying. More...

Macros

#define ZWP_IDLE_INHIBITOR_V1_DESTROY_SINCE_VERSION   1
 

Functions

static void zwp_idle_inhibitor_v1_set_user_data (struct zwp_idle_inhibitor_v1 *zwp_idle_inhibitor_v1, void *user_data)
 
static void * zwp_idle_inhibitor_v1_get_user_data (struct zwp_idle_inhibitor_v1 *zwp_idle_inhibitor_v1)
 
static void zwp_idle_inhibitor_v1_destroy (struct zwp_idle_inhibitor_v1 *zwp_idle_inhibitor_v1)
 

Detailed Description

An idle inhibitor prevents the output that the associated surface is visible on from being set to a state where it is not visually usable due to lack of user interaction (e.g. blanked, dimmed, locked, set to power save, etc.) Any screensaver processes are also blocked from displaying.

If the surface is destroyed, unmapped, becomes occluded, loses visibility, or otherwise becomes not visually relevant for the user, the idle inhibitor will not be honored by the compositor; if the surface subsequently regains visibility the inhibitor takes effect once again. Likewise, the inhibitor isn't honored if the system was already idled at the time the inhibitor was established, although if the system later de-idles and re-idles the inhibitor will take effect.

Macro Definition Documentation

◆ ZWP_IDLE_INHIBITOR_V1_DESTROY_SINCE_VERSION

#define ZWP_IDLE_INHIBITOR_V1_DESTROY_SINCE_VERSION   1

Definition at line 190 of file idle_inhibit_unstable_v1.h.

Function Documentation

◆ zwp_idle_inhibitor_v1_set_user_data()

static void zwp_idle_inhibitor_v1_set_user_data ( struct zwp_idle_inhibitor_v1 *  zwp_idle_inhibitor_v1,
void *  user_data 
)
inlinestatic

Definition at line 194 of file idle_inhibit_unstable_v1.h.

◆ zwp_idle_inhibitor_v1_get_user_data()

static void* zwp_idle_inhibitor_v1_get_user_data ( struct zwp_idle_inhibitor_v1 *  zwp_idle_inhibitor_v1)
inlinestatic

Definition at line 201 of file idle_inhibit_unstable_v1.h.

◆ zwp_idle_inhibitor_v1_destroy()

static void zwp_idle_inhibitor_v1_destroy ( struct zwp_idle_inhibitor_v1 *  zwp_idle_inhibitor_v1)
inlinestatic

Remove the inhibitor effect from the associated wl_surface.

Definition at line 218 of file idle_inhibit_unstable_v1.h.

Referenced by MythScreenSaverWayland::Restore(), and MythScreenSaverWayland::~MythScreenSaverWayland().