pointer-warp-v1.xml RawHistoryFolder

1<?xml version="1.0" encoding="UTF-8"?>
2<protocol name="pointer_warp_v1">
3  <copyright>
4    Copyright © 2024 Neal Gompa
5    Copyright © 2024 Xaver Hugl
6    Copyright © 2024 Matthias Klumpp
7    Copyright © 2024 Vlad Zahorodnii
8
9    Permission is hereby granted, free of charge, to any person obtaining a
10    copy of this software and associated documentation files (the "Software"),
11    to deal in the Software without restriction, including without limitation
12    the rights to use, copy, modify, merge, publish, distribute, sublicense,
13    and/or sell copies of the Software, and to permit persons to whom the
14    Software is furnished to do so, subject to the following conditions:
15    The above copyright notice and this permission notice (including the next
16    paragraph) shall be included in all copies or substantial portions of the
17    Software.
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="wp_pointer_warp_v1" version="1">
28    <description summary="reposition the pointer to a location on a surface">
29      This global interface allows applications to request the pointer to be
30      moved to a position relative to a wl_surface.
31
32      Note that if the desired behavior is to constrain the pointer to an area
33      or lock it to a position, this protocol does not provide a reliable way
34      to do that. The pointer constraint and pointer lock protocols should be
35      used for those use cases instead.
36
37      Warning! The protocol described in this file is currently in the testing
38      phase. Backward compatible changes may be added together with the
39      corresponding interface version bump. Backward incompatible changes can
40      only be done by creating a new major version of the extension.
41    </description>
42
43    <request name="destroy" type="destructor">
44      <description summary="destroy the warp manager">
45        Destroy the pointer warp manager.
46      </description>
47    </request>
48
49    <request name="warp_pointer">
50      <description summary="reposition the pointer">
51        Request the compositor to move the pointer to a surface-local position.
52        Whether or not the compositor honors the request is implementation defined,
53        but it should
54        - honor it if the surface has pointer focus, including
55          when it has an implicit pointer grab
56        - reject it if the enter serial is incorrect
57        - reject it if the requested position is outside of the surface
58
59        Note that the enter serial is valid for any surface of the client,
60        and does not have to be from the surface the pointer is warped to.
61
62      </description>
63      <arg name="surface" type="object" interface="wl_surface"
64           summary="surface to position the pointer on"/>
65      <arg name="pointer" type="object" interface="wl_pointer"
66           summary="the pointer that should be repositioned"/>
67      <arg name="x" type="fixed"/>
68      <arg name="y" type="fixed"/>
69      <arg name="serial" type="uint" summary="serial number of the enter event"/>
70    </request>
71  </interface>
72</protocol>