From 67285c1d5758526688f0023e27c4a6b24730a2fa Mon Sep 17 00:00:00 2001 From: Markus Ongyerth Date: Fri, 23 Feb 2018 13:18:05 +0100 Subject: idle-inhibit: style adjustments and motivation --- include/wlr/types/wlr_idle_inhibit_v1.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'include') diff --git a/include/wlr/types/wlr_idle_inhibit_v1.h b/include/wlr/types/wlr_idle_inhibit_v1.h index c06a82e8..a777ff43 100644 --- a/include/wlr/types/wlr_idle_inhibit_v1.h +++ b/include/wlr/types/wlr_idle_inhibit_v1.h @@ -3,6 +3,18 @@ #include +/* This interface permits clients to inhibit the idle behavior such as + * screenblanking, locking, and screensaving. + * + * This allows clients to ensure they stay visible instead of being hidden by + * power-saving. + * + * Inhibitors are created for surfaces. They should only be in effect, while + * this surface is visible. + * The effect could also be limited to outputs it is displayed on (e.g. + * dimm/dpms off outputs, except the one a video is displayed on). + */ + struct wlr_idle_inhibit_manager_v1 { struct wl_list wl_resources; // wl_resource_get_link struct wl_list inhibitors; // wlr_idle_inhibit_inhibitor_v1::link -- cgit v1.2.3