🛠️🐜 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.

136 lines
6.4 KiB

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <protocol name="relative_pointer_unstable_v1">
  3. <copyright>
  4. Copyright © 2014 Jonas Ådahl
  5. Copyright © 2015 Red Hat Inc.
  6. Permission is hereby granted, free of charge, to any person obtaining a
  7. copy of this software and associated documentation files (the "Software"),
  8. to deal in the Software without restriction, including without limitation
  9. the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10. and/or sell copies of the Software, and to permit persons to whom the
  11. Software is furnished to do so, subject to the following conditions:
  12. The above copyright notice and this permission notice (including the next
  13. paragraph) shall be included in all copies or substantial portions of the
  14. Software.
  15. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  18. THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20. FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21. DEALINGS IN THE SOFTWARE.
  22. </copyright>
  23. <description summary="protocol for relative pointer motion events">
  24. This protocol specifies a set of interfaces used for making clients able to
  25. receive relative pointer events not obstructed by barriers (such as the
  26. monitor edge or other pointer barriers).
  27. To start receiving relative pointer events, a client must first bind the
  28. global interface "wp_relative_pointer_manager" which, if a compositor
  29. supports relative pointer motion events, is exposed by the registry. After
  30. having created the relative pointer manager proxy object, the client uses
  31. it to create the actual relative pointer object using the
  32. "get_relative_pointer" request given a wl_pointer. The relative pointer
  33. motion events will then, when applicable, be transmitted via the proxy of
  34. the newly created relative pointer object. See the documentation of the
  35. relative pointer interface for more details.
  36. Warning! The protocol described in this file is experimental and backward
  37. incompatible changes may be made. Backward compatible changes may be added
  38. together with the corresponding interface version bump. Backward
  39. incompatible changes are done by bumping the version number in the protocol
  40. and interface names and resetting the interface version. Once the protocol
  41. is to be declared stable, the 'z' prefix and the version number in the
  42. protocol and interface names are removed and the interface version number is
  43. reset.
  44. </description>
  45. <interface name="zwp_relative_pointer_manager_v1" version="1">
  46. <description summary="get relative pointer objects">
  47. A global interface used for getting the relative pointer object for a
  48. given pointer.
  49. </description>
  50. <request name="destroy" type="destructor">
  51. <description summary="destroy the relative pointer manager object">
  52. Used by the client to notify the server that it will no longer use this
  53. relative pointer manager object.
  54. </description>
  55. </request>
  56. <request name="get_relative_pointer">
  57. <description summary="get a relative pointer object">
  58. Create a relative pointer interface given a wl_pointer object. See the
  59. wp_relative_pointer interface for more details.
  60. </description>
  61. <arg name="id" type="new_id" interface="zwp_relative_pointer_v1"/>
  62. <arg name="pointer" type="object" interface="wl_pointer"/>
  63. </request>
  64. </interface>
  65. <interface name="zwp_relative_pointer_v1" version="1">
  66. <description summary="relative pointer object">
  67. A wp_relative_pointer object is an extension to the wl_pointer interface
  68. used for emitting relative pointer events. It shares the same focus as
  69. wl_pointer objects of the same seat and will only emit events when it has
  70. focus.
  71. </description>
  72. <request name="destroy" type="destructor">
  73. <description summary="release the relative pointer object"/>
  74. </request>
  75. <event name="relative_motion">
  76. <description summary="relative pointer motion">
  77. Relative x/y pointer motion from the pointer of the seat associated with
  78. this object.
  79. A relative motion is in the same dimension as regular wl_pointer motion
  80. events, except they do not represent an absolute position. For example,
  81. moving a pointer from (x, y) to (x', y') would have the equivalent
  82. relative motion (x' - x, y' - y). If a pointer motion caused the
  83. absolute pointer position to be clipped by for example the edge of the
  84. monitor, the relative motion is unaffected by the clipping and will
  85. represent the unclipped motion.
  86. This event also contains non-accelerated motion deltas. The
  87. non-accelerated delta is, when applicable, the regular pointer motion
  88. delta as it was before having applied motion acceleration and other
  89. transformations such as normalization.
  90. Note that the non-accelerated delta does not represent 'raw' events as
  91. they were read from some device. Pointer motion acceleration is device-
  92. and configuration-specific and non-accelerated deltas and accelerated
  93. deltas may have the same value on some devices.
  94. Relative motions are not coupled to wl_pointer.motion events, and can be
  95. sent in combination with such events, but also independently. There may
  96. also be scenarios where wl_pointer.motion is sent, but there is no
  97. relative motion. The order of an absolute and relative motion event
  98. originating from the same physical motion is not guaranteed.
  99. If the client needs button events or focus state, it can receive them
  100. from a wl_pointer object of the same seat that the wp_relative_pointer
  101. object is associated with.
  102. </description>
  103. <arg name="utime_hi" type="uint"
  104. summary="high 32 bits of a 64 bit timestamp with microsecond granularity"/>
  105. <arg name="utime_lo" type="uint"
  106. summary="low 32 bits of a 64 bit timestamp with microsecond granularity"/>
  107. <arg name="dx" type="fixed"
  108. summary="the x component of the motion vector"/>
  109. <arg name="dy" type="fixed"
  110. summary="the y component of the motion vector"/>
  111. <arg name="dx_unaccel" type="fixed"
  112. summary="the x component of the unaccelerated motion vector"/>
  113. <arg name="dy_unaccel" type="fixed"
  114. summary="the y component of the unaccelerated motion vector"/>
  115. </event>
  116. </interface>
  117. </protocol>