Warning, /libraries/plasma-wayland-protocols/src/protocols/dpms.xml is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" encoding="UTF-8"?>
0002 <protocol name="dpms">
0003   <copyright><![CDATA[
0004     SPDX-FileCopyrightText: 2015 Martin Gräßlin
0005 
0006     SPDX-License-Identifier: LGPL-2.1-or-later
0007   ]]></copyright>
0008   <interface name="org_kde_kwin_dpms_manager" version="1">
0009       <description summary="Output dpms manager">
0010           The Dpms manager allows to get a org_kde_kwin_dpms for a given wl_output.
0011           The org_kde_kwin_dpms provides the currently used VESA Display Power Management
0012           Signaling state (see https://en.wikipedia.org/wiki/VESA_Display_Power_Management_Signaling ).
0013           In addition it allows to request a state change. A compositor is not obliged to honor it
0014           and will normally automatically switch back to on state.
0015       </description>
0016       <request name="get">
0017           <description summary="Get org_kde_kwin_dpms for wl_output">
0018               Factory request to get the org_kde_kwin_dpms for a given wl_output.
0019           </description>
0020           <arg name="id" type="new_id" interface="org_kde_kwin_dpms"/>
0021           <arg name="output" type="object" interface="wl_output"/>
0022       </request>
0023   </interface>
0024   <interface name="org_kde_kwin_dpms" version="1">
0025       <description summary="Dpms for a wl_output">
0026           This interface provides information about the VESA DPMS state for a wl_output.
0027           It gets created through the request get on the org_kde_kwin_dpms_manager interface.
0028 
0029           On creating the resource the server will push whether DPSM is supported for the output,
0030           the currently used DPMS state and notifies the client through the done event once all
0031           states are pushed. Whenever a state changes the set of changes is committed with the
0032           done event.
0033       </description>
0034       <event name="supported">
0035           <description summary="Event indicating whether DPMS is supported on the wl_output">
0036               This event gets pushed on binding the resource and indicates whether the wl_output
0037               supports DPMS. There are operation modes of a Wayland server where DPMS might not
0038               make sense (e.g. nested compositors).
0039           </description>
0040           <arg name="supported" type="uint" summary="Boolean value whether DPMS is supported (1) for the wl_output or not (0)"/>
0041       </event>
0042       <enum name="mode">
0043             <entry name="On" value="0"/>
0044             <entry name="Standby" value="1"/>
0045             <entry name="Suspend" value="2"/>
0046             <entry name="Off" value="3"/>
0047       </enum>
0048       <event name="mode">
0049           <description summary="Event indicating used DPMS mode">
0050               This mode gets pushed on binding the resource and provides the currently used
0051               DPMS mode. It also gets pushed if DPMS is not supported for the wl_output, in that
0052               case the value will be On.
0053 
0054               The event is also pushed whenever the state changes.
0055           </description>
0056           <arg name="mode" type="uint" summary="The new currently used mode"/>
0057       </event>
0058       <event name="done">
0059           <description summary="All changes are pushed">
0060               This event gets pushed on binding the resource once all other states are pushed.
0061 
0062               In addition it gets pushed whenever a state changes to tell the client that all
0063               state changes have been pushed.
0064           </description>
0065       </event>
0066       <request name="set">
0067           <description summary="Request DPMS state change for the wl_output">
0068               Requests that the compositor puts the wl_output into the passed mode. The compositor
0069               is not obliged to change the state. In addition the compositor might leave the mode
0070               whenever it seems suitable. E.g. the compositor might return to On state on user input.
0071 
0072               The client should not assume that the mode changed after requesting a new mode.
0073               Instead the client should listen for the mode event.
0074           </description>
0075           <arg name="mode" type="uint" summary="Requested mode"/>
0076       </request>
0077       <request name="release" type="destructor">
0078         <description summary="release the dpms object"/>
0079       </request>
0080   </interface>
0081 </protocol>
0082