🛠️🐜 Antkeeper superbuild with dependencies included https://antkeeper.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

83 lines
3.9 KiB

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