idle-inhibit-unstable-v1.xml (4017B)
1 <?xml version="1.0" encoding="UTF-8"?> 2 <protocol name="idle_inhibit_unstable_v1"> 3 4 <copyright> 5 Copyright © 2015 Samsung Electronics Co., Ltd 6 7 Permission is hereby granted, free of charge, to any person obtaining a 8 copy of this software and associated documentation files (the "Software"), 9 to deal in the Software without restriction, including without limitation 10 the rights to use, copy, modify, merge, publish, distribute, sublicense, 11 and/or sell copies of the Software, and to permit persons to whom the 12 Software is furnished to do so, subject to the following conditions: 13 14 The above copyright notice and this permission notice (including the next 15 paragraph) shall be included in all copies or substantial portions of the 16 Software. 17 18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 21 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 23 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 24 DEALINGS IN THE SOFTWARE. 25 </copyright> 26 27 <interface name="zwp_idle_inhibit_manager_v1" version="1"> 28 <description summary="control behavior when display idles"> 29 This interface permits inhibiting the idle behavior such as screen 30 blanking, locking, and screensaving. The client binds the idle manager 31 globally, then creates idle-inhibitor objects for each surface. 32 33 Warning! The protocol described in this file is experimental and 34 backward incompatible changes may be made. Backward compatible changes 35 may be added together with the corresponding interface version bump. 36 Backward incompatible changes are done by bumping the version number in 37 the protocol and interface names and resetting the interface version. 38 Once the protocol is to be declared stable, the 'z' prefix and the 39 version number in the protocol and interface names are removed and the 40 interface version number is reset. 41 </description> 42 43 <request name="destroy" type="destructor"> 44 <description summary="destroy the idle inhibitor object"> 45 Destroy the inhibit manager. 46 </description> 47 </request> 48 49 <request name="create_inhibitor"> 50 <description summary="create a new inhibitor object"> 51 Create a new inhibitor object associated with the given surface. 52 </description> 53 <arg name="id" type="new_id" interface="zwp_idle_inhibitor_v1"/> 54 <arg name="surface" type="object" interface="wl_surface" 55 summary="the surface that inhibits the idle behavior"/> 56 </request> 57 58 </interface> 59 60 <interface name="zwp_idle_inhibitor_v1" version="1"> 61 <description summary="context object for inhibiting idle behavior"> 62 An idle inhibitor prevents the output that the associated surface is 63 visible on from being set to a state where it is not visually usable due 64 to lack of user interaction (e.g. blanked, dimmed, locked, set to power 65 save, etc.) Any screensaver processes are also blocked from displaying. 66 67 If the surface is destroyed, unmapped, becomes occluded, loses 68 visibility, or otherwise becomes not visually relevant for the user, the 69 idle inhibitor will not be honored by the compositor; if the surface 70 subsequently regains visibility the inhibitor takes effect once again. 71 Likewise, the inhibitor isn't honored if the system was already idled at 72 the time the inhibitor was established, although if the system later 73 de-idles and re-idles the inhibitor will take effect. 74 </description> 75 76 <request name="destroy" type="destructor"> 77 <description summary="destroy the idle inhibitor object"> 78 Remove the inhibitor effect from the associated wl_surface. 79 </description> 80 </request> 81 82 </interface> 83 </protocol>