0<?xml version="1.0" encoding="UTF-8"?>
1<protocol name="relative_pointer_unstable_v1">
3 <copyright>
4 Copyright © 2014 Jonas Ådahl
5 Copyright © 2015 Red Hat Inc.
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:
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.
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>
27 <description summary="protocol for relative pointer motion events">
28 This protocol specifies a set of interfaces used for making clients able to
29 receive relative pointer events not obstructed by barriers (such as the
30 monitor edge or other pointer barriers).
32 To start receiving relative pointer events, a client must first bind the
33 global interface "wp_relative_pointer_manager" which, if a compositor
34 supports relative pointer motion events, is exposed by the registry. After
35 having created the relative pointer manager proxy object, the client uses
36 it to create the actual relative pointer object using the
37 "get_relative_pointer" request given a wl_pointer. The relative pointer
38 motion events will then, when applicable, be transmitted via the proxy of
39 the newly created relative pointer object. See the documentation of the
40 relative pointer interface for more details.
42 Warning! The protocol described in this file is experimental and backward
43 incompatible changes may be made. Backward compatible changes may be added
44 together with the corresponding interface version bump. Backward
45 incompatible changes are done by bumping the version number in the protocol
46 and interface names and resetting the interface version. Once the protocol
47 is to be declared stable, the 'z' prefix and the version number in the
48 protocol and interface names are removed and the interface version number is
49 reset.
50 </description>
52 <interface name="zwp_relative_pointer_manager_v1" version="1">
53 <description summary="get relative pointer objects">
54 A global interface used for getting the relative pointer object for a
55 given pointer.
56 </description>
58 <request name="destroy" type="destructor">
59 <description summary="destroy the relative pointer manager object">
60 Used by the client to notify the server that it will no longer use this
61 relative pointer manager object.
62 </description>
63 </request>
65 <request name="get_relative_pointer">
66 <description summary="get a relative pointer object">
67 Create a relative pointer interface given a wl_pointer object. See the
68 wp_relative_pointer interface for more details.
69 </description>
70 <arg name="id" type="new_id" interface="zwp_relative_pointer_v1"/>
71 <arg name="pointer" type="object" interface="wl_pointer"/>
72 </request>
73 </interface>
75 <interface name="zwp_relative_pointer_v1" version="1">
76 <description summary="relative pointer object">
77 A wp_relative_pointer object is an extension to the wl_pointer interface
78 used for emitting relative pointer events. It shares the same focus as
79 wl_pointer objects of the same seat and will only emit events when it has
80 focus.
81 </description>
83 <request name="destroy" type="destructor">
84 <description summary="release the relative pointer object"/>
85 </request>
87 <event name="relative_motion">
88 <description summary="relative pointer motion">
89 Relative x/y pointer motion from the pointer of the seat associated with
90 this object.
92 A relative motion is in the same dimension as regular wl_pointer motion
93 events, except they do not represent an absolute position. For example,
94 moving a pointer from (x, y) to (x', y') would have the equivalent
95 relative motion (x' - x, y' - y). If a pointer motion caused the
96 absolute pointer position to be clipped by for example the edge of the
97 monitor, the relative motion is unaffected by the clipping and will
98 represent the unclipped motion.
100 This event also contains non-accelerated motion deltas. The
101 non-accelerated delta is, when applicable, the regular pointer motion
102 delta as it was before having applied motion acceleration and other
103 transformations such as normalization.
105 Note that the non-accelerated delta does not represent 'raw' events as
106 they were read from some device. Pointer motion acceleration is device-
107 and configuration-specific and non-accelerated deltas and accelerated
108 deltas may have the same value on some devices.
110 Relative motions are not coupled to wl_pointer.motion events, and can be
111 sent in combination with such events, but also independently. There may
112 also be scenarios where wl_pointer.motion is sent, but there is no
113 relative motion. The order of an absolute and relative motion event
114 originating from the same physical motion is not guaranteed.
116 If the client needs button events or focus state, it can receive them
117 from a wl_pointer object of the same seat that the wp_relative_pointer
118 object is associated with.
119 </description>
120 <arg name="utime_hi" type="uint"
121 summary="high 32 bits of a 64 bit timestamp with microsecond granularity"/>
122 <arg name="utime_lo" type="uint"
123 summary="low 32 bits of a 64 bit timestamp with microsecond granularity"/>
124 <arg name="dx" type="fixed"
125 summary="the x component of the motion vector"/>
126 <arg name="dy" type="fixed"
127 summary="the y component of the motion vector"/>
128 <arg name="dx_unaccel" type="fixed"
129 summary="the x component of the unaccelerated motion vector"/>
130 <arg name="dy_unaccel" type="fixed"
131 summary="the y component of the unaccelerated motion vector"/>
132 </event>
133 </interface>
135</protocol>
index : raylib-jai
---