detached a2cb70a

Merge branch 'feat/cursor-shape': generate cursor-shape-v1 and tablet-v2

commit
a2cb70a5513a0913e8cd8f206178f28459d4b197
author
brice · · 2026-09-29 15:16 UTC
merge of
c910d98 + 9585e4b · diff against the first parent
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
7 files · +4047 -1
Unified
UnifiedSplit
M protocol/SOURCE.md +5 -0
@@ -21,3 +21,8 @@ SHA-256 (of the vendored XML bytes):
2121 | `stable/viewporter/viewporter.xml` | `viewporter/viewporter.xml` | `dcb12279a03746301fe490aaed4b38a403485a925abfce2ccfceb644e104fe71` |
2222 | `staging/fractional-scale/fractional-scale-v1.xml` | `fractionalscale/fractional-scale-v1.xml` | `5941de5d28f427ecdadddc8623a6f6af0a30b0ab4726847236ba7a7652b81316` |
2323 | `unstable/text-input/text-input-unstable-v3.xml` | `textinput/text-input-unstable-v3.xml` | `160815cda13c285a30df1971d8f0a5b3aac07071537df59916d2f748b18e4f59` |
24+| `staging/cursor-shape/cursor-shape-v1.xml` | `cursorshape/cursor-shape-v1.xml` | `bb57d91e53a79dadab7c612dab87c233393cee73673feefa7442cfbfdd9aed2f` |
25+| `stable/tablet/tablet-v2.xml` | `tablet/tablet-v2.xml` | `ac1128b26c779cf90b9ed71182ba5e34a7262826789adae206d825a4d45908b4` |
26+
27+`tablet-v2.xml` is vendored because `wp_cursor_shape_manager_v1.get_tablet_tool_v2`
28+references `zwp_tablet_tool_v2`.
@@ -21,3 +21,8 @@ SHA-256 (of the vendored XML bytes):
21 | `stable/viewporter/viewporter.xml` | `viewporter/viewporter.xml` | `dcb12279a03746301fe490aaed4b38a403485a925abfce2ccfceb644e104fe71` |21 | `stable/viewporter/viewporter.xml` | `viewporter/viewporter.xml` | `dcb12279a03746301fe490aaed4b38a403485a925abfce2ccfceb644e104fe71` |
22 | `staging/fractional-scale/fractional-scale-v1.xml` | `fractionalscale/fractional-scale-v1.xml` | `5941de5d28f427ecdadddc8623a6f6af0a30b0ab4726847236ba7a7652b81316` |22 | `staging/fractional-scale/fractional-scale-v1.xml` | `fractionalscale/fractional-scale-v1.xml` | `5941de5d28f427ecdadddc8623a6f6af0a30b0ab4726847236ba7a7652b81316` |
23 | `unstable/text-input/text-input-unstable-v3.xml` | `textinput/text-input-unstable-v3.xml` | `160815cda13c285a30df1971d8f0a5b3aac07071537df59916d2f748b18e4f59` |23 | `unstable/text-input/text-input-unstable-v3.xml` | `textinput/text-input-unstable-v3.xml` | `160815cda13c285a30df1971d8f0a5b3aac07071537df59916d2f748b18e4f59` |
24+| `staging/cursor-shape/cursor-shape-v1.xml` | `cursorshape/cursor-shape-v1.xml` | `bb57d91e53a79dadab7c612dab87c233393cee73673feefa7442cfbfdd9aed2f` |
25+| `stable/tablet/tablet-v2.xml` | `tablet/tablet-v2.xml` | `ac1128b26c779cf90b9ed71182ba5e34a7262826789adae206d825a4d45908b4` |
26+
27+`tablet-v2.xml` is vendored because `wp_cursor_shape_manager_v1.get_tablet_tool_v2`
28+references `zwp_tablet_tool_v2`.
A protocol/cursorshape/cursor-shape-v1.xml +162 -0
@@ -0,0 +1,162 @@
1+<?xml version="1.0" encoding="UTF-8"?>
2+<protocol name="cursor_shape_v1">
3+ <copyright>
4+ Copyright 2018 The Chromium Authors
5+ Copyright 2023 Simon Ser
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+ The above copyright notice and this permission notice (including the next
14+ paragraph) shall be included in all copies or substantial portions of the
15+ Software.
16+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19+ THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22+ DEALINGS IN THE SOFTWARE.
23+ </copyright>
24+
25+ <interface name="wp_cursor_shape_manager_v1" version="2">
26+ <description summary="cursor shape manager">
27+ This global offers an alternative, optional way to set cursor images. This
28+ new way uses enumerated cursors instead of a wl_surface like
29+ wl_pointer.set_cursor does.
30+
31+ Warning! The protocol described in this file is currently in the testing
32+ phase. Backward compatible changes may be added together with the
33+ corresponding interface version bump. Backward incompatible changes can
34+ only be done by creating a new major version of the extension.
35+ </description>
36+
37+ <request name="destroy" type="destructor">
38+ <description summary="destroy the manager">
39+ Destroy the cursor shape manager.
40+ </description>
41+ </request>
42+
43+ <request name="get_pointer">
44+ <description summary="manage the cursor shape of a pointer device">
45+ Obtain a wp_cursor_shape_device_v1 for a wl_pointer object.
46+
47+ When the pointer capability is removed from the wl_seat, the
48+ wp_cursor_shape_device_v1 object becomes inert.
49+ </description>
50+ <arg name="cursor_shape_device" type="new_id" interface="wp_cursor_shape_device_v1"/>
51+ <arg name="pointer" type="object" interface="wl_pointer"/>
52+ </request>
53+
54+ <request name="get_tablet_tool_v2">
55+ <description summary="manage the cursor shape of a tablet tool device">
56+ Obtain a wp_cursor_shape_device_v1 for a zwp_tablet_tool_v2 object.
57+
58+ When the zwp_tablet_tool_v2 is removed, the wp_cursor_shape_device_v1
59+ object becomes inert.
60+ </description>
61+ <arg name="cursor_shape_device" type="new_id" interface="wp_cursor_shape_device_v1"/>
62+ <arg name="tablet_tool" type="object" interface="zwp_tablet_tool_v2"/>
63+ </request>
64+ </interface>
65+
66+ <interface name="wp_cursor_shape_device_v1" version="2">
67+ <description summary="cursor shape for a device">
68+ This interface allows clients to set the cursor shape.
69+ </description>
70+
71+ <enum name="shape">
72+ <description summary="cursor shapes">
73+ This enum describes cursor shapes.
74+
75+ The names are taken from the CSS W3C specification:
76+ https://w3c.github.io/csswg-drafts/css-ui/#cursor
77+ with a few additions.
78+
79+ Note that there are some groups of cursor shapes that are related:
80+ The first group is drag-and-drop cursors which are used to indicate
81+ the selected action during dnd operations. The second group is resize
82+ cursors which are used to indicate resizing and moving possibilities
83+ on window borders. It is recommended that the shapes in these groups
84+ should use visually compatible images and metaphors.
85+ </description>
86+ <entry name="default" value="1" summary="default cursor"/>
87+ <entry name="context_menu" value="2" summary="a context menu is available for the object under the cursor"/>
88+ <entry name="help" value="3" summary="help is available for the object under the cursor"/>
89+ <entry name="pointer" value="4" summary="pointer that indicates a link or another interactive element"/>
90+ <entry name="progress" value="5" summary="progress indicator"/>
91+ <entry name="wait" value="6" summary="program is busy, user should wait"/>
92+ <entry name="cell" value="7" summary="a cell or set of cells may be selected"/>
93+ <entry name="crosshair" value="8" summary="simple crosshair"/>
94+ <entry name="text" value="9" summary="text may be selected"/>
95+ <entry name="vertical_text" value="10" summary="vertical text may be selected"/>
96+ <entry name="alias" value="11" summary="drag-and-drop: alias of/shortcut to something is to be created"/>
97+ <entry name="copy" value="12" summary="drag-and-drop: something is to be copied"/>
98+ <entry name="move" value="13" summary="drag-and-drop: something is to be moved"/>
99+ <entry name="no_drop" value="14" summary="drag-and-drop: the dragged item cannot be dropped at the current cursor location"/>
100+ <entry name="not_allowed" value="15" summary="drag-and-drop: the requested action will not be carried out"/>
101+ <entry name="grab" value="16" summary="drag-and-drop: something can be grabbed"/>
102+ <entry name="grabbing" value="17" summary="drag-and-drop: something is being grabbed"/>
103+ <entry name="e_resize" value="18" summary="resizing: the east border is to be moved"/>
104+ <entry name="n_resize" value="19" summary="resizing: the north border is to be moved"/>
105+ <entry name="ne_resize" value="20" summary="resizing: the north-east corner is to be moved"/>
106+ <entry name="nw_resize" value="21" summary="resizing: the north-west corner is to be moved"/>
107+ <entry name="s_resize" value="22" summary="resizing: the south border is to be moved"/>
108+ <entry name="se_resize" value="23" summary="resizing: the south-east corner is to be moved"/>
109+ <entry name="sw_resize" value="24" summary="resizing: the south-west corner is to be moved"/>
110+ <entry name="w_resize" value="25" summary="resizing: the west border is to be moved"/>
111+ <entry name="ew_resize" value="26" summary="resizing: the east and west borders are to be moved"/>
112+ <entry name="ns_resize" value="27" summary="resizing: the north and south borders are to be moved"/>
113+ <entry name="nesw_resize" value="28" summary="resizing: the north-east and south-west corners are to be moved"/>
114+ <entry name="nwse_resize" value="29" summary="resizing: the north-west and south-east corners are to be moved"/>
115+ <entry name="col_resize" value="30" summary="resizing: that the item/column can be resized horizontally"/>
116+ <entry name="row_resize" value="31" summary="resizing: that the item/row can be resized vertically"/>
117+ <entry name="all_scroll" value="32" summary="something can be scrolled in any direction"/>
118+ <entry name="zoom_in" value="33" summary="something can be zoomed in"/>
119+ <entry name="zoom_out" value="34" summary="something can be zoomed out"/>
120+ <entry name="dnd_ask" value="35" summary="drag-and-drop: the user will select which action will be carried out (non-css value)" since="2"/>
121+ <entry name="all_resize" value="36" summary="resizing: something can be moved or resized in any direction (non-css value)" since="2"/>
122+ </enum>
123+
124+ <enum name="error">
125+ <entry name="invalid_shape" value="1"
126+ summary="the specified shape value is invalid"/>
127+ </enum>
128+
129+ <request name="destroy" type="destructor">
130+ <description summary="destroy the cursor shape device">
131+ Destroy the cursor shape device.
132+
133+ The device cursor shape remains unchanged.
134+ </description>
135+ </request>
136+
137+ <request name="set_shape">
138+ <description summary="set device cursor to the shape">
139+ Sets the device cursor to the specified shape. The compositor will
140+ change the cursor image based on the specified shape.
141+
142+ The cursor actually changes only if the input device focus is one of
143+ the requesting client's surfaces. If any, the previous cursor image
144+ (surface or shape) is replaced.
145+
146+ The "shape" argument must be a valid enum entry, otherwise the
147+ invalid_shape protocol error is raised.
148+
149+ This is similar to the wl_pointer.set_cursor and
150+ zwp_tablet_tool_v2.set_cursor requests, but this request accepts a
151+ shape instead of contents in the form of a surface. Clients can mix
152+ set_cursor and set_shape requests.
153+
154+ The serial parameter must match the latest wl_pointer.enter or
155+ zwp_tablet_tool_v2.proximity_in serial number sent to the client.
156+ Otherwise the request will be ignored.
157+ </description>
158+ <arg name="serial" type="uint" summary="serial number of the enter event"/>
159+ <arg name="shape" type="uint" enum="shape"/>
160+ </request>
161+ </interface>
162+</protocol>
@@ -0,0 +1,162 @@
1+<?xml version="1.0" encoding="UTF-8"?>
2+<protocol name="cursor_shape_v1">
3+ <copyright>
4+ Copyright 2018 The Chromium Authors
5+ Copyright 2023 Simon Ser
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+ The above copyright notice and this permission notice (including the next
14+ paragraph) shall be included in all copies or substantial portions of the
15+ Software.
16+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19+ THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22+ DEALINGS IN THE SOFTWARE.
23+ </copyright>
24+
25+ <interface name="wp_cursor_shape_manager_v1" version="2">
26+ <description summary="cursor shape manager">
27+ This global offers an alternative, optional way to set cursor images. This
28+ new way uses enumerated cursors instead of a wl_surface like
29+ wl_pointer.set_cursor does.
30+
31+ Warning! The protocol described in this file is currently in the testing
32+ phase. Backward compatible changes may be added together with the
33+ corresponding interface version bump. Backward incompatible changes can
34+ only be done by creating a new major version of the extension.
35+ </description>
36+
37+ <request name="destroy" type="destructor">
38+ <description summary="destroy the manager">
39+ Destroy the cursor shape manager.
40+ </description>
41+ </request>
42+
43+ <request name="get_pointer">
44+ <description summary="manage the cursor shape of a pointer device">
45+ Obtain a wp_cursor_shape_device_v1 for a wl_pointer object.
46+
47+ When the pointer capability is removed from the wl_seat, the
48+ wp_cursor_shape_device_v1 object becomes inert.
49+ </description>
50+ <arg name="cursor_shape_device" type="new_id" interface="wp_cursor_shape_device_v1"/>
51+ <arg name="pointer" type="object" interface="wl_pointer"/>
52+ </request>
53+
54+ <request name="get_tablet_tool_v2">
55+ <description summary="manage the cursor shape of a tablet tool device">
56+ Obtain a wp_cursor_shape_device_v1 for a zwp_tablet_tool_v2 object.
57+
58+ When the zwp_tablet_tool_v2 is removed, the wp_cursor_shape_device_v1
59+ object becomes inert.
60+ </description>
61+ <arg name="cursor_shape_device" type="new_id" interface="wp_cursor_shape_device_v1"/>
62+ <arg name="tablet_tool" type="object" interface="zwp_tablet_tool_v2"/>
63+ </request>
64+ </interface>
65+
66+ <interface name="wp_cursor_shape_device_v1" version="2">
67+ <description summary="cursor shape for a device">
68+ This interface allows clients to set the cursor shape.
69+ </description>
70+
71+ <enum name="shape">
72+ <description summary="cursor shapes">
73+ This enum describes cursor shapes.
74+
75+ The names are taken from the CSS W3C specification:
76+ https://w3c.github.io/csswg-drafts/css-ui/#cursor
77+ with a few additions.
78+
79+ Note that there are some groups of cursor shapes that are related:
80+ The first group is drag-and-drop cursors which are used to indicate
81+ the selected action during dnd operations. The second group is resize
82+ cursors which are used to indicate resizing and moving possibilities
83+ on window borders. It is recommended that the shapes in these groups
84+ should use visually compatible images and metaphors.
85+ </description>
86+ <entry name="default" value="1" summary="default cursor"/>
87+ <entry name="context_menu" value="2" summary="a context menu is available for the object under the cursor"/>
88+ <entry name="help" value="3" summary="help is available for the object under the cursor"/>
89+ <entry name="pointer" value="4" summary="pointer that indicates a link or another interactive element"/>
90+ <entry name="progress" value="5" summary="progress indicator"/>
91+ <entry name="wait" value="6" summary="program is busy, user should wait"/>
92+ <entry name="cell" value="7" summary="a cell or set of cells may be selected"/>
93+ <entry name="crosshair" value="8" summary="simple crosshair"/>
94+ <entry name="text" value="9" summary="text may be selected"/>
95+ <entry name="vertical_text" value="10" summary="vertical text may be selected"/>
96+ <entry name="alias" value="11" summary="drag-and-drop: alias of/shortcut to something is to be created"/>
97+ <entry name="copy" value="12" summary="drag-and-drop: something is to be copied"/>
98+ <entry name="move" value="13" summary="drag-and-drop: something is to be moved"/>
99+ <entry name="no_drop" value="14" summary="drag-and-drop: the dragged item cannot be dropped at the current cursor location"/>
100+ <entry name="not_allowed" value="15" summary="drag-and-drop: the requested action will not be carried out"/>
101+ <entry name="grab" value="16" summary="drag-and-drop: something can be grabbed"/>
102+ <entry name="grabbing" value="17" summary="drag-and-drop: something is being grabbed"/>
103+ <entry name="e_resize" value="18" summary="resizing: the east border is to be moved"/>
104+ <entry name="n_resize" value="19" summary="resizing: the north border is to be moved"/>
105+ <entry name="ne_resize" value="20" summary="resizing: the north-east corner is to be moved"/>
106+ <entry name="nw_resize" value="21" summary="resizing: the north-west corner is to be moved"/>
107+ <entry name="s_resize" value="22" summary="resizing: the south border is to be moved"/>
108+ <entry name="se_resize" value="23" summary="resizing: the south-east corner is to be moved"/>
109+ <entry name="sw_resize" value="24" summary="resizing: the south-west corner is to be moved"/>
110+ <entry name="w_resize" value="25" summary="resizing: the west border is to be moved"/>
111+ <entry name="ew_resize" value="26" summary="resizing: the east and west borders are to be moved"/>
112+ <entry name="ns_resize" value="27" summary="resizing: the north and south borders are to be moved"/>
113+ <entry name="nesw_resize" value="28" summary="resizing: the north-east and south-west corners are to be moved"/>
114+ <entry name="nwse_resize" value="29" summary="resizing: the north-west and south-east corners are to be moved"/>
115+ <entry name="col_resize" value="30" summary="resizing: that the item/column can be resized horizontally"/>
116+ <entry name="row_resize" value="31" summary="resizing: that the item/row can be resized vertically"/>
117+ <entry name="all_scroll" value="32" summary="something can be scrolled in any direction"/>
118+ <entry name="zoom_in" value="33" summary="something can be zoomed in"/>
119+ <entry name="zoom_out" value="34" summary="something can be zoomed out"/>
120+ <entry name="dnd_ask" value="35" summary="drag-and-drop: the user will select which action will be carried out (non-css value)" since="2"/>
121+ <entry name="all_resize" value="36" summary="resizing: something can be moved or resized in any direction (non-css value)" since="2"/>
122+ </enum>
123+
124+ <enum name="error">
125+ <entry name="invalid_shape" value="1"
126+ summary="the specified shape value is invalid"/>
127+ </enum>
128+
129+ <request name="destroy" type="destructor">
130+ <description summary="destroy the cursor shape device">
131+ Destroy the cursor shape device.
132+
133+ The device cursor shape remains unchanged.
134+ </description>
135+ </request>
136+
137+ <request name="set_shape">
138+ <description summary="set device cursor to the shape">
139+ Sets the device cursor to the specified shape. The compositor will
140+ change the cursor image based on the specified shape.
141+
142+ The cursor actually changes only if the input device focus is one of
143+ the requesting client's surfaces. If any, the previous cursor image
144+ (surface or shape) is replaced.
145+
146+ The "shape" argument must be a valid enum entry, otherwise the
147+ invalid_shape protocol error is raised.
148+
149+ This is similar to the wl_pointer.set_cursor and
150+ zwp_tablet_tool_v2.set_cursor requests, but this request accepts a
151+ shape instead of contents in the form of a surface. Clients can mix
152+ set_cursor and set_shape requests.
153+
154+ The serial parameter must match the latest wl_pointer.enter or
155+ zwp_tablet_tool_v2.proximity_in serial number sent to the client.
156+ Otherwise the request will be ignored.
157+ </description>
158+ <arg name="serial" type="uint" summary="serial number of the enter event"/>
159+ <arg name="shape" type="uint" enum="shape"/>
160+ </request>
161+ </interface>
162+</protocol>
A protocol/cursorshape/cursor-shape-v1_generated.go +257 -0
@@ -0,0 +1,257 @@
1+// Code generated by wlturbo-scanner. DO NOT EDIT.
2+// Protocol: cursor_shape_v1
3+// Source: cursor-shape-v1.xml
4+
5+package cursorshape
6+
7+import (
8+ cross_wl_pointer "github.com/bnema/wlturbo/protocol/core"
9+ cross_zwp_tablet_tool_v2 "github.com/bnema/wlturbo/protocol/tablet"
10+ "github.com/bnema/wlturbo/wl"
11+)
12+
13+// SHAPE_DEFAULT is the shape default value.
14+const SHAPE_DEFAULT = 1
15+
16+// SHAPE_CONTEXT_MENU is the shape context_menu value.
17+const SHAPE_CONTEXT_MENU = 2
18+
19+// SHAPE_HELP is the shape help value.
20+const SHAPE_HELP = 3
21+
22+// SHAPE_POINTER is the shape pointer value.
23+const SHAPE_POINTER = 4
24+
25+// SHAPE_PROGRESS is the shape progress value.
26+const SHAPE_PROGRESS = 5
27+
28+// SHAPE_WAIT is the shape wait value.
29+const SHAPE_WAIT = 6
30+
31+// SHAPE_CELL is the shape cell value.
32+const SHAPE_CELL = 7
33+
34+// SHAPE_CROSSHAIR is the shape crosshair value.
35+const SHAPE_CROSSHAIR = 8
36+
37+// SHAPE_TEXT is the shape text value.
38+const SHAPE_TEXT = 9
39+
40+// SHAPE_VERTICAL_TEXT is the shape vertical_text value.
41+const SHAPE_VERTICAL_TEXT = 10
42+
43+// SHAPE_ALIAS is the shape alias value.
44+const SHAPE_ALIAS = 11
45+
46+// SHAPE_COPY is the shape copy value.
47+const SHAPE_COPY = 12
48+
49+// SHAPE_MOVE is the shape move value.
50+const SHAPE_MOVE = 13
51+
52+// SHAPE_NO_DROP is the shape no_drop value.
53+const SHAPE_NO_DROP = 14
54+
55+// SHAPE_NOT_ALLOWED is the shape not_allowed value.
56+const SHAPE_NOT_ALLOWED = 15
57+
58+// SHAPE_GRAB is the shape grab value.
59+const SHAPE_GRAB = 16
60+
61+// SHAPE_GRABBING is the shape grabbing value.
62+const SHAPE_GRABBING = 17
63+
64+// SHAPE_E_RESIZE is the shape e_resize value.
65+const SHAPE_E_RESIZE = 18
66+
67+// SHAPE_N_RESIZE is the shape n_resize value.
68+const SHAPE_N_RESIZE = 19
69+
70+// SHAPE_NE_RESIZE is the shape ne_resize value.
71+const SHAPE_NE_RESIZE = 20
72+
73+// SHAPE_NW_RESIZE is the shape nw_resize value.
74+const SHAPE_NW_RESIZE = 21
75+
76+// SHAPE_S_RESIZE is the shape s_resize value.
77+const SHAPE_S_RESIZE = 22
78+
79+// SHAPE_SE_RESIZE is the shape se_resize value.
80+const SHAPE_SE_RESIZE = 23
81+
82+// SHAPE_SW_RESIZE is the shape sw_resize value.
83+const SHAPE_SW_RESIZE = 24
84+
85+// SHAPE_W_RESIZE is the shape w_resize value.
86+const SHAPE_W_RESIZE = 25
87+
88+// SHAPE_EW_RESIZE is the shape ew_resize value.
89+const SHAPE_EW_RESIZE = 26
90+
91+// SHAPE_NS_RESIZE is the shape ns_resize value.
92+const SHAPE_NS_RESIZE = 27
93+
94+// SHAPE_NESW_RESIZE is the shape nesw_resize value.
95+const SHAPE_NESW_RESIZE = 28
96+
97+// SHAPE_NWSE_RESIZE is the shape nwse_resize value.
98+const SHAPE_NWSE_RESIZE = 29
99+
100+// SHAPE_COL_RESIZE is the shape col_resize value.
101+const SHAPE_COL_RESIZE = 30
102+
103+// SHAPE_ROW_RESIZE is the shape row_resize value.
104+const SHAPE_ROW_RESIZE = 31
105+
106+// SHAPE_ALL_SCROLL is the shape all_scroll value.
107+const SHAPE_ALL_SCROLL = 32
108+
109+// SHAPE_ZOOM_IN is the shape zoom_in value.
110+const SHAPE_ZOOM_IN = 33
111+
112+// SHAPE_ZOOM_OUT is the shape zoom_out value.
113+const SHAPE_ZOOM_OUT = 34
114+
115+// SHAPE_DND_ASK is the shape dnd_ask value.
116+const SHAPE_DND_ASK = 35
117+
118+// SHAPE_ALL_RESIZE is the shape all_resize value.
119+const SHAPE_ALL_RESIZE = 36
120+
121+// ERROR_INVALID_SHAPE is the error invalid_shape value.
122+const ERROR_INVALID_SHAPE = 1
123+
124+// WpCursorShapeManagerInterface is the protocol interface name.
125+const WpCursorShapeManagerInterface = "wp_cursor_shape_manager_v1"
126+
127+// WpCursorShapeManager is the generated binding for wp_cursor_shape_manager_v1 version 2.
128+type WpCursorShapeManager struct {
129+ wl.BaseProxy
130+}
131+
132+// NewWpCursorShapeManager returns an unbound WpCursorShapeManager.
133+func NewWpCursorShapeManager(ctx *wl.Context) *WpCursorShapeManager {
134+ obj := &WpCursorShapeManager{}
135+ obj.SetContext(ctx)
136+ ctx.Register(obj)
137+ return obj
138+}
139+
140+// Destroy the cursor shape manager.
141+func (o *WpCursorShapeManager) Destroy() error {
142+ if err := o.Context().CheckProxy(o); err != nil {
143+ return err
144+ }
145+ if err := o.Context().SendDestructor(o, 0); err != nil {
146+ return err
147+ }
148+ return nil
149+}
150+
151+// Obtain a wp_cursor_shape_device_v1 for a wl_pointer object. When the pointer capability is removed from the wl_seat, the wp_cursor_shape_device_v1 object becomes inert.
152+func (o *WpCursorShapeManager) GetPointer(pointer *cross_wl_pointer.Pointer) (*WpCursorShapeDevice, error) {
153+ if err := o.Context().CheckProxy(o); err != nil {
154+ return nil, err
155+ }
156+ var arg1 wl.Object
157+ if pointer != nil {
158+ arg1 = pointer
159+ }
160+ child := &WpCursorShapeDevice{}
161+ child.SetContext(o.Context())
162+ child.SetID(o.Context().AllocateID())
163+ o.Context().Register(child)
164+ if err := o.Context().SendRequest(o, 1, child, arg1); err != nil {
165+ o.Context().Unregister(child)
166+ return nil, err
167+ }
168+ return child, nil
169+}
170+
171+// Obtain a wp_cursor_shape_device_v1 for a zwp_tablet_tool_v2 object. When the zwp_tablet_tool_v2 is removed, the wp_cursor_shape_device_v1 object becomes inert.
172+func (o *WpCursorShapeManager) GetTabletTool(tabletTool *cross_zwp_tablet_tool_v2.TabletTool) (*WpCursorShapeDevice, error) {
173+ if err := o.Context().CheckProxy(o); err != nil {
174+ return nil, err
175+ }
176+ var arg1 wl.Object
177+ if tabletTool != nil {
178+ arg1 = tabletTool
179+ }
180+ child := &WpCursorShapeDevice{}
181+ child.SetContext(o.Context())
182+ child.SetID(o.Context().AllocateID())
183+ o.Context().Register(child)
184+ if err := o.Context().SendRequest(o, 2, child, arg1); err != nil {
185+ o.Context().Unregister(child)
186+ return nil, err
187+ }
188+ return child, nil
189+}
190+
191+// EventSignature returns the declared event argument types in wire order.
192+func (o *WpCursorShapeManager) EventSignature(opcode uint16) (string, bool) {
193+ switch opcode {
194+ default:
195+ return "", false
196+ }
197+}
198+
199+// Dispatch decodes one event on wp_cursor_shape_manager_v1 and calls the registered handlers.
200+func (o *WpCursorShapeManager) Dispatch(event *wl.Event) {
201+ switch event.Opcode {
202+ default:
203+ }
204+}
205+
206+// WpCursorShapeDeviceInterface is the protocol interface name.
207+const WpCursorShapeDeviceInterface = "wp_cursor_shape_device_v1"
208+
209+// WpCursorShapeDevice is the generated binding for wp_cursor_shape_device_v1 version 2.
210+type WpCursorShapeDevice struct {
211+ wl.BaseProxy
212+}
213+
214+// NewWpCursorShapeDevice returns an unbound WpCursorShapeDevice.
215+func NewWpCursorShapeDevice(ctx *wl.Context) *WpCursorShapeDevice {
216+ obj := &WpCursorShapeDevice{}
217+ obj.SetContext(ctx)
218+ ctx.Register(obj)
219+ return obj
220+}
221+
222+// Destroy the cursor shape device. The device cursor shape remains unchanged.
223+func (o *WpCursorShapeDevice) Destroy() error {
224+ if err := o.Context().CheckProxy(o); err != nil {
225+ return err
226+ }
227+ if err := o.Context().SendDestructor(o, 0); err != nil {
228+ return err
229+ }
230+ return nil
231+}
232+
233+// Sets the device cursor to the specified shape. The compositor will change the cursor image based on the specified shape. The cursor actually changes only if the input device focus is one of the requesting client's surfaces. If any, the previous cursor image (surface or shape) is replaced. The "shape" argument must be a valid enum entry, otherwise the invalid_shape protocol error is raised. This is similar to the wl_pointer.set_cursor and zwp_tablet_tool_v2.set_cursor requests, but this request accepts a shape instead of contents in the form of a surface. Clients can mix set_cursor and set_shape requests. The serial parameter must match the latest wl_pointer.enter or zwp_tablet_tool_v2.proximity_in serial number sent to the client. Otherwise the request will be ignored.
234+func (o *WpCursorShapeDevice) SetShape(serial uint32, shape uint32) error {
235+ if err := o.Context().CheckProxy(o); err != nil {
236+ return err
237+ }
238+ if err := o.Context().SendRequest(o, 1, serial, shape); err != nil {
239+ return err
240+ }
241+ return nil
242+}
243+
244+// EventSignature returns the declared event argument types in wire order.
245+func (o *WpCursorShapeDevice) EventSignature(opcode uint16) (string, bool) {
246+ switch opcode {
247+ default:
248+ return "", false
249+ }
250+}
251+
252+// Dispatch decodes one event on wp_cursor_shape_device_v1 and calls the registered handlers.
253+func (o *WpCursorShapeDevice) Dispatch(event *wl.Event) {
254+ switch event.Opcode {
255+ default:
256+ }
257+}
@@ -0,0 +1,257 @@
1+// Code generated by wlturbo-scanner. DO NOT EDIT.
2+// Protocol: cursor_shape_v1
3+// Source: cursor-shape-v1.xml
4+
5+package cursorshape
6+
7+import (
8+ cross_wl_pointer "github.com/bnema/wlturbo/protocol/core"
9+ cross_zwp_tablet_tool_v2 "github.com/bnema/wlturbo/protocol/tablet"
10+ "github.com/bnema/wlturbo/wl"
11+)
12+
13+// SHAPE_DEFAULT is the shape default value.
14+const SHAPE_DEFAULT = 1
15+
16+// SHAPE_CONTEXT_MENU is the shape context_menu value.
17+const SHAPE_CONTEXT_MENU = 2
18+
19+// SHAPE_HELP is the shape help value.
20+const SHAPE_HELP = 3
21+
22+// SHAPE_POINTER is the shape pointer value.
23+const SHAPE_POINTER = 4
24+
25+// SHAPE_PROGRESS is the shape progress value.
26+const SHAPE_PROGRESS = 5
27+
28+// SHAPE_WAIT is the shape wait value.
29+const SHAPE_WAIT = 6
30+
31+// SHAPE_CELL is the shape cell value.
32+const SHAPE_CELL = 7
33+
34+// SHAPE_CROSSHAIR is the shape crosshair value.
35+const SHAPE_CROSSHAIR = 8
36+
37+// SHAPE_TEXT is the shape text value.
38+const SHAPE_TEXT = 9
39+
40+// SHAPE_VERTICAL_TEXT is the shape vertical_text value.
41+const SHAPE_VERTICAL_TEXT = 10
42+
43+// SHAPE_ALIAS is the shape alias value.
44+const SHAPE_ALIAS = 11
45+
46+// SHAPE_COPY is the shape copy value.
47+const SHAPE_COPY = 12
48+
49+// SHAPE_MOVE is the shape move value.
50+const SHAPE_MOVE = 13
51+
52+// SHAPE_NO_DROP is the shape no_drop value.
53+const SHAPE_NO_DROP = 14
54+
55+// SHAPE_NOT_ALLOWED is the shape not_allowed value.
56+const SHAPE_NOT_ALLOWED = 15
57+
58+// SHAPE_GRAB is the shape grab value.
59+const SHAPE_GRAB = 16
60+
61+// SHAPE_GRABBING is the shape grabbing value.
62+const SHAPE_GRABBING = 17
63+
64+// SHAPE_E_RESIZE is the shape e_resize value.
65+const SHAPE_E_RESIZE = 18
66+
67+// SHAPE_N_RESIZE is the shape n_resize value.
68+const SHAPE_N_RESIZE = 19
69+
70+// SHAPE_NE_RESIZE is the shape ne_resize value.
71+const SHAPE_NE_RESIZE = 20
72+
73+// SHAPE_NW_RESIZE is the shape nw_resize value.
74+const SHAPE_NW_RESIZE = 21
75+
76+// SHAPE_S_RESIZE is the shape s_resize value.
77+const SHAPE_S_RESIZE = 22
78+
79+// SHAPE_SE_RESIZE is the shape se_resize value.
80+const SHAPE_SE_RESIZE = 23
81+
82+// SHAPE_SW_RESIZE is the shape sw_resize value.
83+const SHAPE_SW_RESIZE = 24
84+
85+// SHAPE_W_RESIZE is the shape w_resize value.
86+const SHAPE_W_RESIZE = 25
87+
88+// SHAPE_EW_RESIZE is the shape ew_resize value.
89+const SHAPE_EW_RESIZE = 26
90+
91+// SHAPE_NS_RESIZE is the shape ns_resize value.
92+const SHAPE_NS_RESIZE = 27
93+
94+// SHAPE_NESW_RESIZE is the shape nesw_resize value.
95+const SHAPE_NESW_RESIZE = 28
96+
97+// SHAPE_NWSE_RESIZE is the shape nwse_resize value.
98+const SHAPE_NWSE_RESIZE = 29
99+
100+// SHAPE_COL_RESIZE is the shape col_resize value.
101+const SHAPE_COL_RESIZE = 30
102+
103+// SHAPE_ROW_RESIZE is the shape row_resize value.
104+const SHAPE_ROW_RESIZE = 31
105+
106+// SHAPE_ALL_SCROLL is the shape all_scroll value.
107+const SHAPE_ALL_SCROLL = 32
108+
109+// SHAPE_ZOOM_IN is the shape zoom_in value.
110+const SHAPE_ZOOM_IN = 33
111+
112+// SHAPE_ZOOM_OUT is the shape zoom_out value.
113+const SHAPE_ZOOM_OUT = 34
114+
115+// SHAPE_DND_ASK is the shape dnd_ask value.
116+const SHAPE_DND_ASK = 35
117+
118+// SHAPE_ALL_RESIZE is the shape all_resize value.
119+const SHAPE_ALL_RESIZE = 36
120+
121+// ERROR_INVALID_SHAPE is the error invalid_shape value.
122+const ERROR_INVALID_SHAPE = 1
123+
124+// WpCursorShapeManagerInterface is the protocol interface name.
125+const WpCursorShapeManagerInterface = "wp_cursor_shape_manager_v1"
126+
127+// WpCursorShapeManager is the generated binding for wp_cursor_shape_manager_v1 version 2.
128+type WpCursorShapeManager struct {
129+ wl.BaseProxy
130+}
131+
132+// NewWpCursorShapeManager returns an unbound WpCursorShapeManager.
133+func NewWpCursorShapeManager(ctx *wl.Context) *WpCursorShapeManager {
134+ obj := &WpCursorShapeManager{}
135+ obj.SetContext(ctx)
136+ ctx.Register(obj)
137+ return obj
138+}
139+
140+// Destroy the cursor shape manager.
141+func (o *WpCursorShapeManager) Destroy() error {
142+ if err := o.Context().CheckProxy(o); err != nil {
143+ return err
144+ }
145+ if err := o.Context().SendDestructor(o, 0); err != nil {
146+ return err
147+ }
148+ return nil
149+}
150+
151+// Obtain a wp_cursor_shape_device_v1 for a wl_pointer object. When the pointer capability is removed from the wl_seat, the wp_cursor_shape_device_v1 object becomes inert.
152+func (o *WpCursorShapeManager) GetPointer(pointer *cross_wl_pointer.Pointer) (*WpCursorShapeDevice, error) {
153+ if err := o.Context().CheckProxy(o); err != nil {
154+ return nil, err
155+ }
156+ var arg1 wl.Object
157+ if pointer != nil {
158+ arg1 = pointer
159+ }
160+ child := &WpCursorShapeDevice{}
161+ child.SetContext(o.Context())
162+ child.SetID(o.Context().AllocateID())
163+ o.Context().Register(child)
164+ if err := o.Context().SendRequest(o, 1, child, arg1); err != nil {
165+ o.Context().Unregister(child)
166+ return nil, err
167+ }
168+ return child, nil
169+}
170+
171+// Obtain a wp_cursor_shape_device_v1 for a zwp_tablet_tool_v2 object. When the zwp_tablet_tool_v2 is removed, the wp_cursor_shape_device_v1 object becomes inert.
172+func (o *WpCursorShapeManager) GetTabletTool(tabletTool *cross_zwp_tablet_tool_v2.TabletTool) (*WpCursorShapeDevice, error) {
173+ if err := o.Context().CheckProxy(o); err != nil {
174+ return nil, err
175+ }
176+ var arg1 wl.Object
177+ if tabletTool != nil {
178+ arg1 = tabletTool
179+ }
180+ child := &WpCursorShapeDevice{}
181+ child.SetContext(o.Context())
182+ child.SetID(o.Context().AllocateID())
183+ o.Context().Register(child)
184+ if err := o.Context().SendRequest(o, 2, child, arg1); err != nil {
185+ o.Context().Unregister(child)
186+ return nil, err
187+ }
188+ return child, nil
189+}
190+
191+// EventSignature returns the declared event argument types in wire order.
192+func (o *WpCursorShapeManager) EventSignature(opcode uint16) (string, bool) {
193+ switch opcode {
194+ default:
195+ return "", false
196+ }
197+}
198+
199+// Dispatch decodes one event on wp_cursor_shape_manager_v1 and calls the registered handlers.
200+func (o *WpCursorShapeManager) Dispatch(event *wl.Event) {
201+ switch event.Opcode {
202+ default:
203+ }
204+}
205+
206+// WpCursorShapeDeviceInterface is the protocol interface name.
207+const WpCursorShapeDeviceInterface = "wp_cursor_shape_device_v1"
208+
209+// WpCursorShapeDevice is the generated binding for wp_cursor_shape_device_v1 version 2.
210+type WpCursorShapeDevice struct {
211+ wl.BaseProxy
212+}
213+
214+// NewWpCursorShapeDevice returns an unbound WpCursorShapeDevice.
215+func NewWpCursorShapeDevice(ctx *wl.Context) *WpCursorShapeDevice {
216+ obj := &WpCursorShapeDevice{}
217+ obj.SetContext(ctx)
218+ ctx.Register(obj)
219+ return obj
220+}
221+
222+// Destroy the cursor shape device. The device cursor shape remains unchanged.
223+func (o *WpCursorShapeDevice) Destroy() error {
224+ if err := o.Context().CheckProxy(o); err != nil {
225+ return err
226+ }
227+ if err := o.Context().SendDestructor(o, 0); err != nil {
228+ return err
229+ }
230+ return nil
231+}
232+
233+// Sets the device cursor to the specified shape. The compositor will change the cursor image based on the specified shape. The cursor actually changes only if the input device focus is one of the requesting client's surfaces. If any, the previous cursor image (surface or shape) is replaced. The "shape" argument must be a valid enum entry, otherwise the invalid_shape protocol error is raised. This is similar to the wl_pointer.set_cursor and zwp_tablet_tool_v2.set_cursor requests, but this request accepts a shape instead of contents in the form of a surface. Clients can mix set_cursor and set_shape requests. The serial parameter must match the latest wl_pointer.enter or zwp_tablet_tool_v2.proximity_in serial number sent to the client. Otherwise the request will be ignored.
234+func (o *WpCursorShapeDevice) SetShape(serial uint32, shape uint32) error {
235+ if err := o.Context().CheckProxy(o); err != nil {
236+ return err
237+ }
238+ if err := o.Context().SendRequest(o, 1, serial, shape); err != nil {
239+ return err
240+ }
241+ return nil
242+}
243+
244+// EventSignature returns the declared event argument types in wire order.
245+func (o *WpCursorShapeDevice) EventSignature(opcode uint16) (string, bool) {
246+ switch opcode {
247+ default:
248+ return "", false
249+ }
250+}
251+
252+// Dispatch decodes one event on wp_cursor_shape_device_v1 and calls the registered handlers.
253+func (o *WpCursorShapeDevice) Dispatch(event *wl.Event) {
254+ switch event.Opcode {
255+ default:
256+ }
257+}
M protocol/extensions_test.go +22 -1
@@ -12,6 +12,7 @@ import (
1212
1313 "github.com/bnema/wlturbo"
1414 "github.com/bnema/wlturbo/protocol/core"
15+ "github.com/bnema/wlturbo/protocol/cursorshape"
1516 "github.com/bnema/wlturbo/protocol/drmsyncobj"
1617 "github.com/bnema/wlturbo/protocol/fractionalscale"
1718 "github.com/bnema/wlturbo/protocol/linuxdmabuf"
@@ -413,6 +414,26 @@ func TestExtensionsOverSocketpair(t *testing.T) {
413414 request(t, p)
414415 noerr(t, mgr.Release())
415416 request(t, p)
417+ // Cursor shape: get a device for a wl_pointer and set a shape at an
418+ // enter serial; check the exact wire arguments.
419+ pointer := core.NewPointer(d.Context())
420+ pointer.SetID(d.AllocateID())
421+ d.Context().Register(pointer)
422+ shapes := cursorshape.NewWpCursorShapeManager(d.Context())
423+ bind(t, d, p, 8, cursorshape.WpCursorShapeManagerInterface, 2, 1, shapes)
424+ shape, e := shapes.GetPointer(pointer)
425+ noerr(t, e)
426+ if id, op, b := request(t, p); id != shapes.ID() || op != 1 || binary.NativeEndian.Uint32(b) != shape.ID() || binary.NativeEndian.Uint32(b[4:]) != pointer.ID() {
427+ t.Fatalf("get_pointer wire id=%d op=%d %x", id, op, b)
428+ }
429+ noerr(t, shape.SetShape(42, cursorshape.SHAPE_POINTER))
430+ if id, op, b := request(t, p); id != shape.ID() || op != 1 || binary.NativeEndian.Uint32(b) != 42 || binary.NativeEndian.Uint32(b[4:]) != 4 {
431+ t.Fatalf("set_shape wire id=%d op=%d %x", id, op, b)
432+ }
433+ noerr(t, shape.Destroy())
434+ request(t, p)
435+ noerr(t, shapes.Destroy())
436+ request(t, p)
416437
417438 }
418439
@@ -424,7 +445,7 @@ func TestLiveFeedback(t *testing.T) {
424445 noerr(t, e)
425446 defer d.Close()
426447 noerr(t, d.Roundtrip())
427- for _, iface := range []string{xdgshell.XdgWmBaseInterface, linuxdmabuf.LinuxDmabufInterface, drmsyncobj.WpLinuxDrmSyncobjManagerInterface, viewporter.WpViewporterInterface, fractionalscale.WpFractionalScaleManagerInterface, textinput.TextInputManagerV3Interface} {
448+ for _, iface := range []string{xdgshell.XdgWmBaseInterface, linuxdmabuf.LinuxDmabufInterface, drmsyncobj.WpLinuxDrmSyncobjManagerInterface, viewporter.WpViewporterInterface, fractionalscale.WpFractionalScaleManagerInterface, textinput.TextInputManagerV3Interface, cursorshape.WpCursorShapeManagerInterface} {
428449 g, ok := d.Registry().FindGlobal(iface)
429450 if !ok {
430451 t.Logf("%s absent", iface)
@@ -12,6 +12,7 @@ import (
12 12
13 "github.com/bnema/wlturbo"13 "github.com/bnema/wlturbo"
14 "github.com/bnema/wlturbo/protocol/core"14 "github.com/bnema/wlturbo/protocol/core"
15+ "github.com/bnema/wlturbo/protocol/cursorshape"
15 "github.com/bnema/wlturbo/protocol/drmsyncobj"16 "github.com/bnema/wlturbo/protocol/drmsyncobj"
16 "github.com/bnema/wlturbo/protocol/fractionalscale"17 "github.com/bnema/wlturbo/protocol/fractionalscale"
17 "github.com/bnema/wlturbo/protocol/linuxdmabuf"18 "github.com/bnema/wlturbo/protocol/linuxdmabuf"
@@ -413,6 +414,26 @@ func TestExtensionsOverSocketpair(t *testing.T) {
413 request(t, p)414 request(t, p)
414 noerr(t, mgr.Release())415 noerr(t, mgr.Release())
415 request(t, p)416 request(t, p)
417+ // Cursor shape: get a device for a wl_pointer and set a shape at an
418+ // enter serial; check the exact wire arguments.
419+ pointer := core.NewPointer(d.Context())
420+ pointer.SetID(d.AllocateID())
421+ d.Context().Register(pointer)
422+ shapes := cursorshape.NewWpCursorShapeManager(d.Context())
423+ bind(t, d, p, 8, cursorshape.WpCursorShapeManagerInterface, 2, 1, shapes)
424+ shape, e := shapes.GetPointer(pointer)
425+ noerr(t, e)
426+ if id, op, b := request(t, p); id != shapes.ID() || op != 1 || binary.NativeEndian.Uint32(b) != shape.ID() || binary.NativeEndian.Uint32(b[4:]) != pointer.ID() {
427+ t.Fatalf("get_pointer wire id=%d op=%d %x", id, op, b)
428+ }
429+ noerr(t, shape.SetShape(42, cursorshape.SHAPE_POINTER))
430+ if id, op, b := request(t, p); id != shape.ID() || op != 1 || binary.NativeEndian.Uint32(b) != 42 || binary.NativeEndian.Uint32(b[4:]) != 4 {
431+ t.Fatalf("set_shape wire id=%d op=%d %x", id, op, b)
432+ }
433+ noerr(t, shape.Destroy())
434+ request(t, p)
435+ noerr(t, shapes.Destroy())
436+ request(t, p)
416 437
417 }438 }
418 439
@@ -424,7 +445,7 @@ func TestLiveFeedback(t *testing.T) {
424 noerr(t, e)445 noerr(t, e)
425 defer d.Close()446 defer d.Close()
426 noerr(t, d.Roundtrip())447 noerr(t, d.Roundtrip())
427- for _, iface := range []string{xdgshell.XdgWmBaseInterface, linuxdmabuf.LinuxDmabufInterface, drmsyncobj.WpLinuxDrmSyncobjManagerInterface, viewporter.WpViewporterInterface, fractionalscale.WpFractionalScaleManagerInterface, textinput.TextInputManagerV3Interface} {448+ for _, iface := range []string{xdgshell.XdgWmBaseInterface, linuxdmabuf.LinuxDmabufInterface, drmsyncobj.WpLinuxDrmSyncobjManagerInterface, viewporter.WpViewporterInterface, fractionalscale.WpFractionalScaleManagerInterface, textinput.TextInputManagerV3Interface, cursorshape.WpCursorShapeManagerInterface} {
428 g, ok := d.Registry().FindGlobal(iface)449 g, ok := d.Registry().FindGlobal(iface)
429 if !ok {450 if !ok {
430 t.Logf("%s absent", iface)451 t.Logf("%s absent", iface)
M protocol/generate.go +2 -0
@@ -6,4 +6,6 @@ package protocol
66 //go:generate go run ../cmd/wlturbo-scanner -p drmsyncobj -o drmsyncobj/linux-drm-syncobj-v1_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core drmsyncobj/linux-drm-syncobj-v1.xml
77 //go:generate go run ../cmd/wlturbo-scanner -p viewporter -o viewporter/viewporter_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core viewporter/viewporter.xml
88 //go:generate go run ../cmd/wlturbo-scanner -p fractionalscale -o fractionalscale/fractional-scale-v1_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core fractionalscale/fractional-scale-v1.xml
9+//go:generate go run ../cmd/wlturbo-scanner -p tablet -o tablet/tablet-v2_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core -import wl_seat=github.com/bnema/wlturbo/protocol/core tablet/tablet-v2.xml
10+//go:generate go run ../cmd/wlturbo-scanner -p cursorshape -o cursorshape/cursor-shape-v1_generated.go -import wl_pointer=github.com/bnema/wlturbo/protocol/core -import zwp_tablet_tool_v2=github.com/bnema/wlturbo/protocol/tablet cursorshape/cursor-shape-v1.xml
911 //go:generate go run ../cmd/wlturbo-scanner -p textinput -o textinput/text-input-unstable-v3_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core -import wl_seat=github.com/bnema/wlturbo/protocol/core textinput/text-input-unstable-v3.xml
@@ -6,4 +6,6 @@ package protocol
6 //go:generate go run ../cmd/wlturbo-scanner -p drmsyncobj -o drmsyncobj/linux-drm-syncobj-v1_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core drmsyncobj/linux-drm-syncobj-v1.xml6 //go:generate go run ../cmd/wlturbo-scanner -p drmsyncobj -o drmsyncobj/linux-drm-syncobj-v1_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core drmsyncobj/linux-drm-syncobj-v1.xml
7 //go:generate go run ../cmd/wlturbo-scanner -p viewporter -o viewporter/viewporter_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core viewporter/viewporter.xml7 //go:generate go run ../cmd/wlturbo-scanner -p viewporter -o viewporter/viewporter_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core viewporter/viewporter.xml
8 //go:generate go run ../cmd/wlturbo-scanner -p fractionalscale -o fractionalscale/fractional-scale-v1_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core fractionalscale/fractional-scale-v1.xml8 //go:generate go run ../cmd/wlturbo-scanner -p fractionalscale -o fractionalscale/fractional-scale-v1_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core fractionalscale/fractional-scale-v1.xml
9+//go:generate go run ../cmd/wlturbo-scanner -p tablet -o tablet/tablet-v2_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core -import wl_seat=github.com/bnema/wlturbo/protocol/core tablet/tablet-v2.xml
10+//go:generate go run ../cmd/wlturbo-scanner -p cursorshape -o cursorshape/cursor-shape-v1_generated.go -import wl_pointer=github.com/bnema/wlturbo/protocol/core -import zwp_tablet_tool_v2=github.com/bnema/wlturbo/protocol/tablet cursorshape/cursor-shape-v1.xml
9 //go:generate go run ../cmd/wlturbo-scanner -p textinput -o textinput/text-input-unstable-v3_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core -import wl_seat=github.com/bnema/wlturbo/protocol/core textinput/text-input-unstable-v3.xml11 //go:generate go run ../cmd/wlturbo-scanner -p textinput -o textinput/text-input-unstable-v3_generated.go -import wl_surface=github.com/bnema/wlturbo/protocol/core -import wl_seat=github.com/bnema/wlturbo/protocol/core textinput/text-input-unstable-v3.xml
A protocol/tablet/tablet-v2.xml +1297 -0
@@ -0,0 +1,1297 @@
1+<?xml version="1.0" encoding="UTF-8"?>
2+<protocol name="tablet_v2">
3+
4+ <copyright>
5+ Copyright 2014 © Stephen "Lyude" Chandler Paul
6+ Copyright 2015-2024 © Red Hat, Inc.
7+
8+ Permission is hereby granted, free of charge, to any person
9+ obtaining a copy of this software and associated documentation files
10+ (the "Software"), to deal in the Software without restriction,
11+ including without limitation the rights to use, copy, modify, merge,
12+ publish, distribute, sublicense, and/or sell copies of the Software,
13+ and to permit persons to whom the Software is furnished to do so,
14+ subject to the following conditions:
15+
16+ The above copyright notice and this permission notice (including the
17+ next paragraph) shall be included in all copies or substantial
18+ portions of the Software.
19+
20+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24+ BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25+ ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27+ SOFTWARE.
28+ </copyright>
29+
30+ <description summary="Wayland protocol for graphics tablets">
31+ This description provides a high-level overview of the interplay between
32+ the interfaces defined this protocol. For details, see the protocol
33+ specification.
34+
35+ More than one tablet may exist, and device-specifics matter. Tablets are
36+ not represented by a single virtual device like wl_pointer. A client
37+ binds to the tablet manager object which is just a proxy object. From
38+ that, the client requests zwp_tablet_manager_v2.get_tablet_seat(wl_seat)
39+ and that returns the actual interface that has all the tablets. With
40+ this indirection, we can avoid merging zwp_tablet_v2 into the actual Wayland
41+ protocol, a long-term benefit.
42+
43+ The zwp_tablet_seat_v2 sends a "tablet added" event for each tablet
44+ connected. That event is followed by descriptive events about the
45+ hardware; currently that includes events for name, vid/pid and
46+ a zwp_tablet_v2.path event that describes a local path. This path can be
47+ used to uniquely identify a tablet or get more information through
48+ libwacom. Emulated or nested tablets can skip any of those, e.g. a
49+ virtual tablet may not have a vid/pid. The sequence of descriptive
50+ events is terminated by a zwp_tablet_v2.done event to signal that a client
51+ may now finalize any initialization for that tablet.
52+
53+ Events from tablets require a tool in proximity. Tools are also managed
54+ by the tablet seat; a "tool added" event is sent whenever a tool is new
55+ to the compositor. That event is followed by a number of descriptive
56+ events about the hardware; currently that includes capabilities,
57+ hardware id and serial number, and tool type. Similar to the tablet
58+ interface, a zwp_tablet_tool_v2.done event is sent to terminate that initial
59+ sequence.
60+
61+ Any event from a tool happens on the zwp_tablet_tool_v2 interface. When the
62+ tool gets into proximity of the tablet, a proximity_in event is sent on
63+ the zwp_tablet_tool_v2 interface, listing the tablet and the surface. That
64+ event is followed by a motion event with the coordinates. After that,
65+ it's the usual motion, axis, button, etc. events. The protocol's
66+ serialisation means events are grouped by zwp_tablet_tool_v2.frame events.
67+
68+ Two special events (that don't exist in X) are down and up. They signal
69+ "tip touching the surface". For tablets without real proximity
70+ detection, the sequence is: proximity_in, motion, down, frame.
71+
72+ When the tool leaves proximity, a proximity_out event is sent. If any
73+ button is still down, a button release event is sent before this
74+ proximity event. These button events are sent in the same frame as the
75+ proximity event to signal to the client that the buttons were held when
76+ the tool left proximity.
77+
78+ If the tool moves out of the surface but stays in proximity (i.e.
79+ between windows), compositor-specific grab policies apply. This usually
80+ means that the proximity-out is delayed until all buttons are released.
81+
82+ Moving a tool physically from one tablet to the other has no real effect
83+ on the protocol, since we already have the tool object from the "tool
84+ added" event. All the information is already there and the proximity
85+ events on both tablets are all a client needs to reconstruct what
86+ happened.
87+
88+ Some extra axes are normalized, i.e. the client knows the range as
89+ specified in the protocol (e.g. [0, 65535]), the granularity however is
90+ unknown. The current normalized axes are pressure, distance, and slider.
91+
92+ Other extra axes are in physical units as specified in the protocol.
93+ The current extra axes with physical units are tilt, rotation and
94+ wheel rotation.
95+
96+ Since tablets work independently of the pointer controlled by the mouse,
97+ the focus handling is independent too and controlled by proximity.
98+ The zwp_tablet_tool_v2.set_cursor request sets a tool-specific cursor.
99+ This cursor surface may be the same as the mouse cursor, and it may be
100+ the same across tools but it is possible to be more fine-grained. For
101+ example, a client may set different cursors for the pen and eraser.
102+
103+ Tools are generally independent of tablets and it is
104+ compositor-specific policy when a tool can be removed. Common approaches
105+ will likely include some form of removing a tool when all tablets the
106+ tool was used on are removed.
107+ </description>
108+
109+ <interface name="zwp_tablet_manager_v2" version="2">
110+ <description summary="controller object for graphic tablet devices">
111+ An object that provides access to the graphics tablets available on this
112+ system. All tablets are associated with a seat, to get access to the
113+ actual tablets, use zwp_tablet_manager_v2.get_tablet_seat.
114+ </description>
115+
116+ <request name="get_tablet_seat">
117+ <description summary="get the tablet seat">
118+ Get the zwp_tablet_seat_v2 object for the given seat. This object
119+ provides access to all graphics tablets in this seat.
120+ </description>
121+ <arg name="tablet_seat" type="new_id" interface="zwp_tablet_seat_v2"/>
122+ <arg name="seat" type="object" interface="wl_seat" summary="The wl_seat object to retrieve the tablets for" />
123+ </request>
124+
125+ <request name="destroy" type="destructor">
126+ <description summary="release the memory for the tablet manager object">
127+ Destroy the zwp_tablet_manager_v2 object. Objects created from this
128+ object are unaffected and should be destroyed separately.
129+ </description>
130+ </request>
131+ </interface>
132+
133+ <interface name="zwp_tablet_seat_v2" version="2">
134+ <description summary="controller object for graphic tablet devices of a seat">
135+ An object that provides access to the graphics tablets available on this
136+ seat. After binding to this interface, the compositor sends a set of
137+ zwp_tablet_seat_v2.tablet_added and zwp_tablet_seat_v2.tool_added events.
138+ </description>
139+
140+ <request name="destroy" type="destructor">
141+ <description summary="release the memory for the tablet seat object">
142+ Destroy the zwp_tablet_seat_v2 object. Objects created from this
143+ object are unaffected and should be destroyed separately.
144+ </description>
145+ </request>
146+
147+ <event name="tablet_added">
148+ <description summary="new device notification">
149+ This event is sent whenever a new tablet becomes available on this
150+ seat. This event only provides the object id of the tablet, any
151+ static information about the tablet (device name, vid/pid, etc.) is
152+ sent through the zwp_tablet_v2 interface.
153+ </description>
154+ <arg name="id" type="new_id" interface="zwp_tablet_v2" summary="the newly added graphics tablet"/>
155+ </event>
156+
157+ <event name="tool_added">
158+ <description summary="a new tool has been used with a tablet">
159+ This event is sent whenever a tool that has not previously been used
160+ with a tablet comes into use. This event only provides the object id
161+ of the tool; any static information about the tool (capabilities,
162+ type, etc.) is sent through the zwp_tablet_tool_v2 interface.
163+ </description>
164+ <arg name="id" type="new_id" interface="zwp_tablet_tool_v2" summary="the newly added tablet tool"/>
165+ </event>
166+
167+ <event name="pad_added">
168+ <description summary="new pad notification">
169+ This event is sent whenever a new pad is known to the system. Typically,
170+ pads are physically attached to tablets and a pad_added event is
171+ sent immediately after the zwp_tablet_seat_v2.tablet_added.
172+ However, some standalone pad devices logically attach to tablets at
173+ runtime, and the client must wait for zwp_tablet_pad_v2.enter to know
174+ the tablet a pad is attached to.
175+
176+ This event only provides the object id of the pad. All further
177+ features (buttons, strips, rings) are sent through the zwp_tablet_pad_v2
178+ interface.
179+ </description>
180+ <arg name="id" type="new_id" interface="zwp_tablet_pad_v2" summary="the newly added pad"/>
181+ </event>
182+ </interface>
183+
184+ <interface name="zwp_tablet_tool_v2" version="2">
185+ <description summary="a physical tablet tool">
186+ An object that represents a physical tool that has been, or is
187+ currently in use with a tablet in this seat. Each zwp_tablet_tool_v2
188+ object stays valid until the client destroys it; the compositor
189+ reuses the zwp_tablet_tool_v2 object to indicate that the object's
190+ respective physical tool has come into proximity of a tablet again.
191+
192+ A zwp_tablet_tool_v2 object's relation to a physical tool depends on the
193+ tablet's ability to report serial numbers. If the tablet supports
194+ this capability, then the object represents a specific physical tool
195+ and can be identified even when used on multiple tablets.
196+
197+ A tablet tool has a number of static characteristics, e.g. tool type,
198+ hardware_serial and capabilities. These capabilities are sent in an
199+ event sequence after the zwp_tablet_seat_v2.tool_added event before any
200+ actual events from this tool. This initial event sequence is
201+ terminated by a zwp_tablet_tool_v2.done event.
202+
203+ Tablet tool events are grouped by zwp_tablet_tool_v2.frame events.
204+ Any events received before a zwp_tablet_tool_v2.frame event should be
205+ considered part of the same hardware state change.
206+ </description>
207+
208+ <request name="set_cursor">
209+ <description summary="set the tablet tool's surface">
210+ Sets the surface of the cursor used for this tool on the given
211+ tablet. This request only takes effect if the tool is in proximity
212+ of one of the requesting client's surfaces or the surface parameter
213+ is the current pointer surface. If there was a previous surface set
214+ with this request it is replaced. If surface is NULL, the cursor
215+ image is hidden.
216+
217+ The parameters hotspot_x and hotspot_y define the position of the
218+ pointer surface relative to the pointer location. Its top-left corner
219+ is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the
220+ coordinates of the pointer location, in surface-local coordinates.
221+
222+ On surface.attach requests to the pointer surface, hotspot_x and
223+ hotspot_y are decremented by the x and y parameters passed to the
224+ request. Attach must be confirmed by wl_surface.commit as usual.
225+
226+ The hotspot can also be updated by passing the currently set pointer
227+ surface to this request with new values for hotspot_x and hotspot_y.
228+
229+ The current and pending input regions of the wl_surface are cleared,
230+ and wl_surface.set_input_region is ignored until the wl_surface is no
231+ longer used as the cursor. When the use as a cursor ends, the current
232+ and pending input regions become undefined, and the wl_surface is
233+ unmapped.
234+
235+ This request gives the surface the role of a zwp_tablet_tool_v2 cursor. A
236+ surface may only ever be used as the cursor surface for one
237+ zwp_tablet_tool_v2. If the surface already has another role or has
238+ previously been used as cursor surface for a different tool, a
239+ protocol error is raised.
240+ </description>
241+ <arg name="serial" type="uint" summary="serial of the proximity_in event"/>
242+ <arg name="surface" type="object" interface="wl_surface" allow-null="true"/>
243+ <arg name="hotspot_x" type="int" summary="surface-local x coordinate"/>
244+ <arg name="hotspot_y" type="int" summary="surface-local y coordinate"/>
245+ </request>
246+
247+ <request name="destroy" type="destructor">
248+ <description summary="destroy the tool object">
249+ This destroys the client's resource for this tool object.
250+ </description>
251+ </request>
252+
253+ <enum name="type">
254+ <description summary="a physical tool type">
255+ Describes the physical type of a tool. The physical type of a tool
256+ generally defines its base usage.
257+
258+ The mouse tool represents a mouse-shaped tool that is not a relative
259+ device but bound to the tablet's surface, providing absolute
260+ coordinates.
261+
262+ The lens tool is a mouse-shaped tool with an attached lens to
263+ provide precision focus.
264+ </description>
265+ <entry name="pen" value="0x140" summary="Pen"/>
266+ <entry name="eraser" value="0x141" summary="Eraser"/>
267+ <entry name="brush" value="0x142" summary="Brush"/>
268+ <entry name="pencil" value="0x143" summary="Pencil"/>
269+ <entry name="airbrush" value="0x144" summary="Airbrush"/>
270+ <entry name="finger" value="0x145" summary="Finger"/>
271+ <entry name="mouse" value="0x146" summary="Mouse"/>
272+ <entry name="lens" value="0x147" summary="Lens"/>
273+ </enum>
274+
275+ <event name="type">
276+ <description summary="tool type">
277+ The tool type is the high-level type of the tool and usually decides
278+ the interaction expected from this tool.
279+
280+ This event is sent in the initial burst of events before the
281+ zwp_tablet_tool_v2.done event.
282+ </description>
283+ <arg name="tool_type" type="uint" enum="type" summary="the physical tool type"/>
284+ </event>
285+
286+ <event name="hardware_serial">
287+ <description summary="unique hardware serial number of the tool">
288+ If the physical tool can be identified by a unique 64-bit serial
289+ number, this event notifies the client of this serial number.
290+
291+ If multiple tablets are available in the same seat and the tool is
292+ uniquely identifiable by the serial number, that tool may move
293+ between tablets.
294+
295+ Otherwise, if the tool has no serial number and this event is
296+ missing, the tool is tied to the tablet it first comes into
297+ proximity with. Even if the physical tool is used on multiple
298+ tablets, separate zwp_tablet_tool_v2 objects will be created, one per
299+ tablet.
300+
301+ This event is sent in the initial burst of events before the
302+ zwp_tablet_tool_v2.done event.
303+ </description>
304+ <arg name="hardware_serial_hi" type="uint" summary="the unique serial number of the tool, most significant bits"/>
305+ <arg name="hardware_serial_lo" type="uint" summary="the unique serial number of the tool, least significant bits"/>
306+ </event>
307+
308+ <event name="hardware_id_wacom">
309+ <description summary="hardware id notification in Wacom's format">
310+ This event notifies the client of a hardware id available on this tool.
311+
312+ The hardware id is a device-specific 64-bit id that provides extra
313+ information about the tool in use, beyond the wl_tool.type
314+ enumeration. The format of the id is specific to tablets made by
315+ Wacom Inc. For example, the hardware id of a Wacom Grip
316+ Pen (a stylus) is 0x802.
317+
318+ This event is sent in the initial burst of events before the
319+ zwp_tablet_tool_v2.done event.
320+ </description>
321+ <arg name="hardware_id_hi" type="uint" summary="the hardware id, most significant bits"/>
322+ <arg name="hardware_id_lo" type="uint" summary="the hardware id, least significant bits"/>
323+ </event>
324+
325+ <enum name="capability">
326+ <description summary="capability flags for a tool">
327+ Describes extra capabilities on a tablet.
328+
329+ Any tool must provide x and y values, extra axes are
330+ device-specific.
331+ </description>
332+ <entry name="tilt" value="1" summary="Tilt axes"/>
333+ <entry name="pressure" value="2" summary="Pressure axis"/>
334+ <entry name="distance" value="3" summary="Distance axis"/>
335+ <entry name="rotation" value="4" summary="Z-rotation axis"/>
336+ <entry name="slider" value="5" summary="Slider axis"/>
337+ <entry name="wheel" value="6" summary="Wheel axis"/>
338+ </enum>
339+
340+ <event name="capability">
341+ <description summary="tool capability notification">
342+ This event notifies the client of any capabilities of this tool,
343+ beyond the main set of x/y axes and tip up/down detection.
344+
345+ One event is sent for each extra capability available on this tool.
346+
347+ This event is sent in the initial burst of events before the
348+ zwp_tablet_tool_v2.done event.
349+ </description>
350+ <arg name="capability" type="uint" enum="capability" summary="the capability"/>
351+ </event>
352+
353+ <event name="done">
354+ <description summary="tool description events sequence complete">
355+ This event signals the end of the initial burst of descriptive
356+ events. A client may consider the static description of the tool to
357+ be complete and finalize initialization of the tool.
358+ </description>
359+ </event>
360+
361+ <event name="removed">
362+ <description summary="tool removed">
363+ This event is sent when the tool is removed from the system and will
364+ send no further events. Should the physical tool come back into
365+ proximity later, a new zwp_tablet_tool_v2 object will be created.
366+
367+ It is compositor-dependent when a tool is removed. A compositor may
368+ remove a tool on proximity out, tablet removal or any other reason.
369+ A compositor may also keep a tool alive until shutdown.
370+
371+ If the tool is currently in proximity, a proximity_out event will be
372+ sent before the removed event. See zwp_tablet_tool_v2.proximity_out for
373+ the handling of any buttons logically down.
374+
375+ When this event is received, the client must zwp_tablet_tool_v2.destroy
376+ the object.
377+ </description>
378+ </event>
379+
380+ <event name="proximity_in">
381+ <description summary="proximity in event">
382+ Notification that this tool is focused on a certain surface.
383+
384+ This event can be received when the tool has moved from one surface to
385+ another, or when the tool has come back into proximity above the
386+ surface.
387+
388+ If any button is logically down when the tool comes into proximity,
389+ the respective button event is sent after the proximity_in event but
390+ within the same frame as the proximity_in event.
391+ </description>
392+ <arg name="serial" type="uint"/>
393+ <arg name="tablet" type="object" interface="zwp_tablet_v2" summary="The tablet the tool is in proximity of"/>
394+ <arg name="surface" type="object" interface="wl_surface" summary="The current surface the tablet tool is over"/>
395+ </event>
396+
397+ <event name="proximity_out">
398+ <description summary="proximity out event">
399+ Notification that this tool has either left proximity, or is no
400+ longer focused on a certain surface.
401+
402+ When the tablet tool leaves proximity of the tablet, button release
403+ events are sent for each button that was held down at the time of
404+ leaving proximity. These events are sent before the proximity_out
405+ event but within the same zwp_tablet_v2.frame.
406+
407+ If the tool stays within proximity of the tablet, but the focus
408+ changes from one surface to another, a button release event may not
409+ be sent until the button is actually released or the tool leaves the
410+ proximity of the tablet.
411+ </description>
412+ </event>
413+
414+ <event name="down">
415+ <description summary="tablet tool is making contact">
416+ Sent whenever the tablet tool comes in contact with the surface of the
417+ tablet.
418+
419+ If the tool is already in contact with the tablet when entering the
420+ input region, the client owning said region will receive a
421+ zwp_tablet_v2.proximity_in event, followed by a zwp_tablet_v2.down
422+ event and a zwp_tablet_v2.frame event.
423+
424+ Note that this event describes logical contact, not physical
425+ contact. On some devices, a compositor may not consider a tool in
426+ logical contact until a minimum physical pressure threshold is
427+ exceeded.
428+ </description>
429+ <arg name="serial" type="uint"/>
430+ </event>
431+
432+ <event name="up">
433+ <description summary="tablet tool is no longer making contact">
434+ Sent whenever the tablet tool stops making contact with the surface of
435+ the tablet, or when the tablet tool moves out of the input region
436+ and the compositor grab (if any) is dismissed.
437+
438+ If the tablet tool moves out of the input region while in contact
439+ with the surface of the tablet and the compositor does not have an
440+ ongoing grab on the surface, the client owning said region will
441+ receive a zwp_tablet_v2.up event, followed by a zwp_tablet_v2.proximity_out
442+ event and a zwp_tablet_v2.frame event. If the compositor has an ongoing
443+ grab on this device, this event sequence is sent whenever the grab
444+ is dismissed in the future.
445+
446+ Note that this event describes logical contact, not physical
447+ contact. On some devices, a compositor may not consider a tool out
448+ of logical contact until physical pressure falls below a specific
449+ threshold.
450+ </description>
451+ </event>
452+
453+ <event name="motion">
454+ <description summary="motion event">
455+ Sent whenever a tablet tool moves.
456+ </description>
457+ <arg name="x" type="fixed" summary="surface-local x coordinate"/>
458+ <arg name="y" type="fixed" summary="surface-local y coordinate"/>
459+ </event>
460+
461+ <event name="pressure">
462+ <description summary="pressure change event">
463+ Sent whenever the pressure axis on a tool changes. The value of this
464+ event is normalized to a value between 0 and 65535.
465+
466+ Note that pressure may be nonzero even when a tool is not in logical
467+ contact. See the down and up events for more details.
468+ </description>
469+ <arg name="pressure" type="uint" summary="The current pressure value"/>
470+ </event>
471+
472+ <event name="distance">
473+ <description summary="distance change event">
474+ Sent whenever the distance axis on a tool changes. The value of this
475+ event is normalized to a value between 0 and 65535.
476+
477+ Note that distance may be nonzero even when a tool is not in logical
478+ contact. See the down and up events for more details.
479+ </description>
480+ <arg name="distance" type="uint" summary="The current distance value"/>
481+ </event>
482+
483+ <event name="tilt">
484+ <description summary="tilt change event">
485+ Sent whenever one or both of the tilt axes on a tool change. Each tilt
486+ value is in degrees, relative to the z-axis of the tablet.
487+ The angle is positive when the top of a tool tilts along the
488+ positive x or y axis.
489+ </description>
490+ <arg name="tilt_x" type="fixed" summary="The current value of the X tilt axis"/>
491+ <arg name="tilt_y" type="fixed" summary="The current value of the Y tilt axis"/>
492+ </event>
493+
494+ <event name="rotation">
495+ <description summary="z-rotation change event">
496+ Sent whenever the z-rotation axis on the tool changes. The
497+ rotation value is in degrees clockwise from the tool's
498+ logical neutral position.
499+ </description>
500+ <arg name="degrees" type="fixed" summary="The current rotation of the Z axis"/>
501+ </event>
502+
503+ <event name="slider">
504+ <description summary="Slider position change event">
505+ Sent whenever the slider position on the tool changes. The
506+ value is normalized between -65535 and 65535, with 0 as the logical
507+ neutral position of the slider.
508+
509+ The slider is available on e.g. the Wacom Airbrush tool.
510+ </description>
511+ <arg name="position" type="int" summary="The current position of slider"/>
512+ </event>
513+
514+ <event name="wheel">
515+ <description summary="Wheel delta event">
516+ Sent whenever the wheel on the tool emits an event. This event
517+ contains two values for the same axis change. The degrees value is
518+ in the same orientation as the wl_pointer.vertical_scroll axis. The
519+ clicks value is in discrete logical clicks of the mouse wheel. This
520+ value may be zero if the movement of the wheel was less
521+ than one logical click.
522+
523+ Clients should choose either value and avoid mixing degrees and
524+ clicks. The compositor may accumulate values smaller than a logical
525+ click and emulate click events when a certain threshold is met.
526+ Thus, zwp_tablet_tool_v2.wheel events with non-zero clicks values may
527+ have different degrees values.
528+ </description>
529+ <arg name="degrees" type="fixed" summary="The wheel delta in degrees"/>
530+ <arg name="clicks" type="int" summary="The wheel delta in discrete clicks"/>
531+ </event>
532+
533+ <enum name="button_state">
534+ <description summary="physical button state">
535+ Describes the physical state of a button that produced the button event.
536+ </description>
537+ <entry name="released" value="0" summary="button is not pressed"/>
538+ <entry name="pressed" value="1" summary="button is pressed"/>
539+ </enum>
540+
541+ <event name="button">
542+ <description summary="button event">
543+ Sent whenever a button on the tool is pressed or released.
544+
545+ If a button is held down when the tool moves in or out of proximity,
546+ button events are generated by the compositor. See
547+ zwp_tablet_tool_v2.proximity_in and zwp_tablet_tool_v2.proximity_out for
548+ details.
549+ </description>
550+ <arg name="serial" type="uint"/>
551+ <arg name="button" type="uint" summary="The button whose state has changed"/>
552+ <arg name="state" type="uint" enum="button_state" summary="Whether the button was pressed or released"/>
553+ </event>
554+
555+ <event name="frame">
556+ <description summary="frame event">
557+ Marks the end of a series of axis and/or button updates from the
558+ tablet. The Wayland protocol requires axis updates to be sent
559+ sequentially, however all events within a frame should be considered
560+ one hardware event.
561+ </description>
562+ <arg name="time" type="uint" summary="The time of the event with millisecond granularity"/>
563+ </event>
564+
565+ <enum name="error">
566+ <entry name="role" value="0" summary="given wl_surface has another role"/>
567+ </enum>
568+ </interface>
569+
570+ <interface name="zwp_tablet_v2" version="2">
571+ <description summary="graphics tablet device">
572+ The zwp_tablet_v2 interface represents one graphics tablet device. The
573+ tablet interface itself does not generate events; all events are
574+ generated by zwp_tablet_tool_v2 objects when in proximity above a tablet.
575+
576+ A tablet has a number of static characteristics, e.g. device name and
577+ pid/vid. These capabilities are sent in an event sequence after the
578+ zwp_tablet_seat_v2.tablet_added event. This initial event sequence is
579+ terminated by a zwp_tablet_v2.done event.
580+ </description>
581+
582+ <request name="destroy" type="destructor">
583+ <description summary="destroy the tablet object">
584+ This destroys the client's resource for this tablet object.
585+ </description>
586+ </request>
587+
588+ <event name="name">
589+ <description summary="tablet device name">
590+ A descriptive name for the tablet device.
591+
592+ If the device has no descriptive name, this event is not sent.
593+
594+ This event is sent in the initial burst of events before the
595+ zwp_tablet_v2.done event.
596+ </description>
597+ <arg name="name" type="string" summary="the device name"/>
598+ </event>
599+
600+ <event name="id">
601+ <description summary="tablet device vendor/product id">
602+ The vendor and product IDs for the tablet device.
603+
604+ The interpretation of the id depends on the zwp_tablet_v2.bustype.
605+ Prior to version v2 of this protocol, the id was implied to be a USB
606+ vendor and product ID. If no zwp_tablet_v2.bustype is sent, the ID
607+ is to be interpreted as USB vendor and product ID.
608+
609+ If the device has no vendor/product ID, this event is not sent.
610+ This can happen for virtual devices or non-USB devices, for instance.
611+
612+ This event is sent in the initial burst of events before the
613+ zwp_tablet_v2.done event.
614+ </description>
615+ <arg name="vid" type="uint" summary="vendor id"/>
616+ <arg name="pid" type="uint" summary="product id"/>
617+ </event>
618+
619+ <event name="path">
620+ <description summary="path to the device">
621+ A system-specific device path that indicates which device is behind
622+ this zwp_tablet_v2. This information may be used to gather additional
623+ information about the device, e.g. through libwacom.
624+
625+ A device may have more than one device path. If so, multiple
626+ zwp_tablet_v2.path events are sent. A device may be emulated and not
627+ have a device path, and in that case this event will not be sent.
628+
629+ The format of the path is unspecified, it may be a device node, a
630+ sysfs path, or some other identifier. It is up to the client to
631+ identify the string provided.
632+
633+ This event is sent in the initial burst of events before the
634+ zwp_tablet_v2.done event.
635+ </description>
636+ <arg name="path" type="string" summary="path to local device"/>
637+ </event>
638+
639+ <event name="done">
640+ <description summary="tablet description events sequence complete">
641+ This event is sent immediately to signal the end of the initial
642+ burst of descriptive events. A client may consider the static
643+ description of the tablet to be complete and finalize initialization
644+ of the tablet.
645+ </description>
646+ </event>
647+
648+ <event name="removed">
649+ <description summary="tablet removed event">
650+ Sent when the tablet has been removed from the system. When a tablet
651+ is removed, some tools may be removed.
652+
653+ When this event is received, the client must zwp_tablet_v2.destroy
654+ the object.
655+ </description>
656+ </event>
657+
658+ <!-- Version 2 additions -->
659+
660+ <enum name="bustype" since="2">
661+ <description summary="bus type ">
662+ Describes the bus types this tablet is connected to.
663+ </description>
664+ <entry name="usb" value="3" summary="USB"/>
665+ <entry name="bluetooth" value="5" summary="Bluetooth"/>
666+ <entry name="virtual" value="6" summary="Virtual"/>
667+ <entry name="serial" value="17" summary="Serial"/>
668+ <entry name="i2c" value="24" summary="I2C"/>
669+ </enum>
670+
671+ <event name="bustype" since="2">
672+ <description summary="tablet device bus type">
673+ The bustype argument is one of the BUS_ defines in the Linux kernel's
674+ linux/input.h
675+
676+ If the device has no known bustype or the bustype cannot be
677+ queried, this event is not sent.
678+
679+ This event is sent in the initial burst of events before the
680+ zwp_tablet_v2.done event.
681+ </description>
682+ <arg name="bustype" type="uint" enum="bustype" summary="bus type"/>
683+ </event>
684+ </interface>
685+
686+ <interface name="zwp_tablet_pad_ring_v2" version="2">
687+ <description summary="pad ring">
688+ A circular interaction area, such as the touch ring on the Wacom Intuos
689+ Pro series tablets.
690+
691+ Events on a ring are logically grouped by the zwp_tablet_pad_ring_v2.frame
692+ event.
693+ </description>
694+
695+ <request name="set_feedback">
696+ <description summary="set compositor feedback">
697+ Request that the compositor use the provided feedback string
698+ associated with this ring. This request should be issued immediately
699+ after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
700+ group is received, or whenever the ring is mapped to a different
701+ action. See zwp_tablet_pad_group_v2.mode_switch for more details.
702+
703+ Clients are encouraged to provide context-aware descriptions for
704+ the actions associated with the ring; compositors may use this
705+ information to offer visual feedback about the button layout
706+ (eg. on-screen displays).
707+
708+ The provided string 'description' is a UTF-8 encoded string to be
709+ associated with this ring, and is considered user-visible; general
710+ internationalization rules apply.
711+
712+ The serial argument will be that of the last
713+ zwp_tablet_pad_group_v2.mode_switch event received for the group of this
714+ ring. Requests providing other serials than the most recent one will be
715+ ignored.
716+ </description>
717+ <arg name="description" type="string" summary="ring description"/>
718+ <arg name="serial" type="uint" summary="serial of the mode switch event"/>
719+ </request>
720+
721+ <request name="destroy" type="destructor">
722+ <description summary="destroy the ring object">
723+ This destroys the client's resource for this ring object.
724+ </description>
725+ </request>
726+
727+ <enum name="source">
728+ <description summary="ring axis source">
729+ Describes the source types for ring events. This indicates to the
730+ client how a ring event was physically generated; a client may
731+ adjust the user interface accordingly. For example, events
732+ from a "finger" source may trigger kinetic scrolling.
733+ </description>
734+ <entry name="finger" value="1" summary="finger"/>
735+ </enum>
736+
737+ <event name="source">
738+ <description summary="ring event source">
739+ Source information for ring events.
740+
741+ This event does not occur on its own. It is sent before a
742+ zwp_tablet_pad_ring_v2.frame event and carries the source information
743+ for all events within that frame.
744+
745+ The source specifies how this event was generated. If the source is
746+ zwp_tablet_pad_ring_v2.source.finger, a zwp_tablet_pad_ring_v2.stop event
747+ will be sent when the user lifts the finger off the device.
748+
749+ This event is optional. If the source is unknown for an interaction,
750+ no event is sent.
751+ </description>
752+ <arg name="source" type="uint" enum="source" summary="the event source"/>
753+ </event>
754+
755+ <event name="angle">
756+ <description summary="angle changed">
757+ Sent whenever the angle on a ring changes.
758+
759+ The angle is provided in degrees clockwise from the logical
760+ north of the ring in the pad's current rotation.
761+ </description>
762+ <arg name="degrees" type="fixed" summary="the current angle in degrees"/>
763+ </event>
764+
765+ <event name="stop">
766+ <description summary="interaction stopped">
767+ Stop notification for ring events.
768+
769+ For some zwp_tablet_pad_ring_v2.source types, a zwp_tablet_pad_ring_v2.stop
770+ event is sent to notify a client that the interaction with the ring
771+ has terminated. This enables the client to implement kinetic scrolling.
772+ See the zwp_tablet_pad_ring_v2.source documentation for information on
773+ when this event may be generated.
774+
775+ Any zwp_tablet_pad_ring_v2.angle events with the same source after this
776+ event should be considered as the start of a new interaction.
777+ </description>
778+ </event>
779+
780+ <event name="frame">
781+ <description summary="end of a ring event sequence">
782+ Indicates the end of a set of ring events that logically belong
783+ together. A client is expected to accumulate the data in all events
784+ within the frame before proceeding.
785+
786+ All zwp_tablet_pad_ring_v2 events before a zwp_tablet_pad_ring_v2.frame event belong
787+ logically together. For example, on termination of a finger interaction
788+ on a ring the compositor will send a zwp_tablet_pad_ring_v2.source event,
789+ a zwp_tablet_pad_ring_v2.stop event and a zwp_tablet_pad_ring_v2.frame event.
790+
791+ A zwp_tablet_pad_ring_v2.frame event is sent for every logical event
792+ group, even if the group only contains a single zwp_tablet_pad_ring_v2
793+ event. Specifically, a client may get a sequence: angle, frame,
794+ angle, frame, etc.
795+ </description>
796+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
797+ </event>
798+ </interface>
799+
800+ <interface name="zwp_tablet_pad_strip_v2" version="2">
801+ <description summary="pad strip">
802+ A linear interaction area, such as the strips found in Wacom Cintiq
803+ models.
804+
805+ Events on a strip are logically grouped by the zwp_tablet_pad_strip_v2.frame
806+ event.
807+ </description>
808+
809+ <request name="set_feedback">
810+ <description summary="set compositor feedback">
811+ Requests the compositor to use the provided feedback string
812+ associated with this strip. This request should be issued immediately
813+ after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
814+ group is received, or whenever the strip is mapped to a different
815+ action. See zwp_tablet_pad_group_v2.mode_switch for more details.
816+
817+ Clients are encouraged to provide context-aware descriptions for
818+ the actions associated with the strip, and compositors may use this
819+ information to offer visual feedback about the button layout
820+ (eg. on-screen displays).
821+
822+ The provided string 'description' is a UTF-8 encoded string to be
823+ associated with this ring, and is considered user-visible; general
824+ internationalization rules apply.
825+
826+ The serial argument will be that of the last
827+ zwp_tablet_pad_group_v2.mode_switch event received for the group of this
828+ strip. Requests providing other serials than the most recent one will be
829+ ignored.
830+ </description>
831+ <arg name="description" type="string" summary="strip description"/>
832+ <arg name="serial" type="uint" summary="serial of the mode switch event"/>
833+ </request>
834+
835+ <request name="destroy" type="destructor">
836+ <description summary="destroy the strip object">
837+ This destroys the client's resource for this strip object.
838+ </description>
839+ </request>
840+
841+ <enum name="source">
842+ <description summary="strip axis source">
843+ Describes the source types for strip events. This indicates to the
844+ client how a strip event was physically generated; a client may
845+ adjust the user interface accordingly. For example, events
846+ from a "finger" source may trigger kinetic scrolling.
847+ </description>
848+ <entry name="finger" value="1" summary="finger"/>
849+ </enum>
850+
851+ <event name="source">
852+ <description summary="strip event source">
853+ Source information for strip events.
854+
855+ This event does not occur on its own. It is sent before a
856+ zwp_tablet_pad_strip_v2.frame event and carries the source information
857+ for all events within that frame.
858+
859+ The source specifies how this event was generated. If the source is
860+ zwp_tablet_pad_strip_v2.source.finger, a zwp_tablet_pad_strip_v2.stop event
861+ will be sent when the user lifts their finger off the device.
862+
863+ This event is optional. If the source is unknown for an interaction,
864+ no event is sent.
865+ </description>
866+ <arg name="source" type="uint" enum="source" summary="the event source"/>
867+ </event>
868+
869+ <event name="position">
870+ <description summary="position changed">
871+ Sent whenever the position on a strip changes.
872+
873+ The position is normalized to a range of [0, 65535], the 0-value
874+ represents the top-most and/or left-most position of the strip in
875+ the pad's current rotation.
876+ </description>
877+ <arg name="position" type="uint" summary="the current position"/>
878+ </event>
879+
880+ <event name="stop">
881+ <description summary="interaction stopped">
882+ Stop notification for strip events.
883+
884+ For some zwp_tablet_pad_strip_v2.source types, a zwp_tablet_pad_strip_v2.stop
885+ event is sent to notify a client that the interaction with the strip
886+ has terminated. This enables the client to implement kinetic
887+ scrolling. See the zwp_tablet_pad_strip_v2.source documentation for
888+ information on when this event may be generated.
889+
890+ Any zwp_tablet_pad_strip_v2.position events with the same source after this
891+ event should be considered as the start of a new interaction.
892+ </description>
893+ </event>
894+
895+ <event name="frame">
896+ <description summary="end of a strip event sequence">
897+ Indicates the end of a set of events that represent one logical
898+ hardware strip event. A client is expected to accumulate the data
899+ in all events within the frame before proceeding.
900+
901+ All zwp_tablet_pad_strip_v2 events before a zwp_tablet_pad_strip_v2.frame event belong
902+ logically together. For example, on termination of a finger interaction
903+ on a strip the compositor will send a zwp_tablet_pad_strip_v2.source event,
904+ a zwp_tablet_pad_strip_v2.stop event and a zwp_tablet_pad_strip_v2.frame
905+ event.
906+
907+ A zwp_tablet_pad_strip_v2.frame event is sent for every logical event
908+ group, even if the group only contains a single zwp_tablet_pad_strip_v2
909+ event. Specifically, a client may get a sequence: position, frame,
910+ position, frame, etc.
911+ </description>
912+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
913+ </event>
914+ </interface>
915+
916+ <interface name="zwp_tablet_pad_group_v2" version="2">
917+ <description summary="a set of buttons, rings and strips">
918+ A pad group describes a distinct (sub)set of buttons, rings and strips
919+ present in the tablet. The criteria of this grouping is usually positional,
920+ eg. if a tablet has buttons on the left and right side, 2 groups will be
921+ presented. The physical arrangement of groups is undisclosed and may
922+ change on the fly.
923+
924+ Pad groups will announce their features during pad initialization. Between
925+ the corresponding zwp_tablet_pad_v2.group event and zwp_tablet_pad_group_v2.done, the
926+ pad group will announce the buttons, rings and strips contained in it,
927+ plus the number of supported modes.
928+
929+ Modes are a mechanism to allow multiple groups of actions for every element
930+ in the pad group. The number of groups and available modes in each is
931+ persistent across device plugs. The current mode is user-switchable, it
932+ will be announced through the zwp_tablet_pad_group_v2.mode_switch event both
933+ whenever it is switched, and after zwp_tablet_pad_v2.enter.
934+
935+ The current mode logically applies to all elements in the pad group,
936+ although it is at clients' discretion whether to actually perform different
937+ actions, and/or issue the respective .set_feedback requests to notify the
938+ compositor. See the zwp_tablet_pad_group_v2.mode_switch event for more details.
939+ </description>
940+
941+ <request name="destroy" type="destructor">
942+ <description summary="destroy the pad object">
943+ Destroy the zwp_tablet_pad_group_v2 object. Objects created from this object
944+ are unaffected and should be destroyed separately.
945+ </description>
946+ </request>
947+
948+ <event name="buttons">
949+ <description summary="buttons announced">
950+ Sent on zwp_tablet_pad_group_v2 initialization to announce the available
951+ buttons in the group. Button indices start at 0, a button may only be
952+ in one group at a time.
953+
954+ This event is first sent in the initial burst of events before the
955+ zwp_tablet_pad_group_v2.done event.
956+
957+ Some buttons are reserved by the compositor. These buttons may not be
958+ assigned to any zwp_tablet_pad_group_v2. Compositors may broadcast this
959+ event in the case of changes to the mapping of these reserved buttons.
960+ If the compositor happens to reserve all buttons in a group, this event
961+ will be sent with an empty array.
962+ </description>
963+ <arg name="buttons" type="array" summary="buttons in this group"/>
964+ </event>
965+
966+ <event name="ring">
967+ <description summary="ring announced">
968+ Sent on zwp_tablet_pad_group_v2 initialization to announce available rings.
969+ One event is sent for each ring available on this pad group.
970+
971+ This event is sent in the initial burst of events before the
972+ zwp_tablet_pad_group_v2.done event.
973+ </description>
974+ <arg name="ring" type="new_id" interface="zwp_tablet_pad_ring_v2"/>
975+ </event>
976+
977+ <event name="strip">
978+ <description summary="strip announced">
979+ Sent on zwp_tablet_pad_v2 initialization to announce available strips.
980+ One event is sent for each strip available on this pad group.
981+
982+ This event is sent in the initial burst of events before the
983+ zwp_tablet_pad_group_v2.done event.
984+ </description>
985+ <arg name="strip" type="new_id" interface="zwp_tablet_pad_strip_v2"/>
986+ </event>
987+
988+ <event name="modes">
989+ <description summary="mode-switch ability announced">
990+ Sent on zwp_tablet_pad_group_v2 initialization to announce that the pad
991+ group may switch between modes. A client may use a mode to store a
992+ specific configuration for buttons, rings and strips and use the
993+ zwp_tablet_pad_group_v2.mode_switch event to toggle between these
994+ configurations. Mode indices start at 0.
995+
996+ Switching modes is compositor-dependent. See the
997+ zwp_tablet_pad_group_v2.mode_switch event for more details.
998+
999+ This event is sent in the initial burst of events before the
1000+ zwp_tablet_pad_group_v2.done event. This event is only sent when
1001+ more than one mode is available.
1002+ </description>
1003+ <arg name="modes" type="uint" summary="the number of modes"/>
1004+ </event>
1005+
1006+ <event name="done">
1007+ <description summary="tablet group description events sequence complete">
1008+ This event is sent immediately to signal the end of the initial
1009+ burst of descriptive events. A client may consider the static
1010+ description of the tablet to be complete and finalize initialization
1011+ of the tablet group.
1012+ </description>
1013+ </event>
1014+
1015+ <event name="mode_switch">
1016+ <description summary="mode switch event">
1017+ Notification that the mode was switched.
1018+
1019+ A mode applies to all buttons, rings, strips and dials in a group
1020+ simultaneously, but a client is not required to assign different actions
1021+ for each mode. For example, a client may have mode-specific button
1022+ mappings but map the ring to vertical scrolling in all modes. Mode
1023+ indices start at 0.
1024+
1025+ Switching modes is compositor-dependent. The compositor may provide
1026+ visual cues to the user about the mode, e.g. by toggling LEDs on
1027+ the tablet device. Mode-switching may be software-controlled or
1028+ controlled by one or more physical buttons. For example, on a Wacom
1029+ Intuos Pro, the button inside the ring may be assigned to switch
1030+ between modes.
1031+
1032+ The compositor will also send this event after zwp_tablet_pad_v2.enter on
1033+ each group in order to notify of the current mode. Groups that only
1034+ feature one mode will use mode=0 when emitting this event.
1035+
1036+ If a button action in the new mode differs from the action in the
1037+ previous mode, the client should immediately issue a
1038+ zwp_tablet_pad_v2.set_feedback request for each changed button.
1039+
1040+ If a ring, strip or dial action in the new mode differs from the action
1041+ in the previous mode, the client should immediately issue a
1042+ zwp_tablet_ring_v2.set_feedback, zwp_tablet_strip_v2.set_feedback or
1043+ zwp_tablet_dial_v2.set_feedback request for each changed ring, strip or dial.
1044+ </description>
1045+ <arg name="time" type="uint" summary="the time of the event with millisecond granularity"/>
1046+ <arg name="serial" type="uint"/>
1047+ <arg name="mode" type="uint" summary="the new mode of the pad"/>
1048+ </event>
1049+
1050+ <!-- Version 2 additions -->
1051+
1052+ <event name="dial" since="2">
1053+ <description summary="dial announced">
1054+ Sent on zwp_tablet_pad_v2 initialization to announce available dials.
1055+ One event is sent for each dial available on this pad group.
1056+
1057+ This event is sent in the initial burst of events before the
1058+ zwp_tablet_pad_group_v2.done event.
1059+ </description>
1060+ <arg name="dial" type="new_id" interface="zwp_tablet_pad_dial_v2"/>
1061+ </event>
1062+ </interface>
1063+
1064+ <interface name="zwp_tablet_pad_v2" version="2">
1065+ <description summary="a set of buttons, rings, strips and dials">
1066+ A pad device is a set of buttons, rings, strips and dials
1067+ usually physically present on the tablet device itself. Some
1068+ exceptions exist where the pad device is physically detached, e.g. the
1069+ Wacom ExpressKey Remote.
1070+
1071+ Pad devices have no axes that control the cursor and are generally
1072+ auxiliary devices to the tool devices used on the tablet surface.
1073+
1074+ A pad device has a number of static characteristics, e.g. the number
1075+ of rings. These capabilities are sent in an event sequence after the
1076+ zwp_tablet_seat_v2.pad_added event before any actual events from this pad.
1077+ This initial event sequence is terminated by a zwp_tablet_pad_v2.done
1078+ event.
1079+
1080+ All pad features (buttons, rings, strips and dials) are logically divided into
1081+ groups and all pads have at least one group. The available groups are
1082+ notified through the zwp_tablet_pad_v2.group event; the compositor will
1083+ emit one event per group before emitting zwp_tablet_pad_v2.done.
1084+
1085+ Groups may have multiple modes. Modes allow clients to map multiple
1086+ actions to a single pad feature. Only one mode can be active per group,
1087+ although different groups may have different active modes.
1088+ </description>
1089+
1090+ <request name="set_feedback">
1091+ <description summary="set compositor feedback">
1092+ Requests the compositor to use the provided feedback string
1093+ associated with this button. This request should be issued immediately
1094+ after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
1095+ group is received, or whenever a button is mapped to a different
1096+ action. See zwp_tablet_pad_group_v2.mode_switch for more details.
1097+
1098+ Clients are encouraged to provide context-aware descriptions for
1099+ the actions associated with each button, and compositors may use
1100+ this information to offer visual feedback on the button layout
1101+ (e.g. on-screen displays).
1102+
1103+ Button indices start at 0. Setting the feedback string on a button
1104+ that is reserved by the compositor (i.e. not belonging to any
1105+ zwp_tablet_pad_group_v2) does not generate an error but the compositor
1106+ is free to ignore the request.
1107+
1108+ The provided string 'description' is a UTF-8 encoded string to be
1109+ associated with this ring, and is considered user-visible; general
1110+ internationalization rules apply.
1111+
1112+ The serial argument will be that of the last
1113+ zwp_tablet_pad_group_v2.mode_switch event received for the group of this
1114+ button. Requests providing other serials than the most recent one will
1115+ be ignored.
1116+ </description>
1117+ <arg name="button" type="uint" summary="button index"/>
1118+ <arg name="description" type="string" summary="button description"/>
1119+ <arg name="serial" type="uint" summary="serial of the mode switch event"/>
1120+ </request>
1121+
1122+ <request name="destroy" type="destructor">
1123+ <description summary="destroy the pad object">
1124+ Destroy the zwp_tablet_pad_v2 object. Objects created from this object
1125+ are unaffected and should be destroyed separately.
1126+ </description>
1127+ </request>
1128+
1129+ <event name="group">
1130+ <description summary="group announced">
1131+ Sent on zwp_tablet_pad_v2 initialization to announce available groups.
1132+ One event is sent for each pad group available.
1133+
1134+ This event is sent in the initial burst of events before the
1135+ zwp_tablet_pad_v2.done event. At least one group will be announced.
1136+ </description>
1137+ <arg name="pad_group" type="new_id" interface="zwp_tablet_pad_group_v2"/>
1138+ </event>
1139+
1140+ <event name="path">
1141+ <description summary="path to the device">
1142+ A system-specific device path that indicates which device is behind
1143+ this zwp_tablet_pad_v2. This information may be used to gather additional
1144+ information about the device, e.g. through libwacom.
1145+
1146+ The format of the path is unspecified, it may be a device node, a
1147+ sysfs path, or some other identifier. It is up to the client to
1148+ identify the string provided.
1149+
1150+ This event is sent in the initial burst of events before the
1151+ zwp_tablet_pad_v2.done event.
1152+ </description>
1153+ <arg name="path" type="string" summary="path to local device"/>
1154+ </event>
1155+
1156+ <event name="buttons">
1157+ <description summary="buttons announced">
1158+ Sent on zwp_tablet_pad_v2 initialization to announce the available
1159+ buttons.
1160+
1161+ This event is sent in the initial burst of events before the
1162+ zwp_tablet_pad_v2.done event. This event is only sent when at least one
1163+ button is available.
1164+ </description>
1165+ <arg name="buttons" type="uint" summary="the number of buttons"/>
1166+ </event>
1167+
1168+ <event name="done">
1169+ <description summary="pad description event sequence complete">
1170+ This event signals the end of the initial burst of descriptive
1171+ events. A client may consider the static description of the pad to
1172+ be complete and finalize initialization of the pad.
1173+ </description>
1174+ </event>
1175+
1176+ <enum name="button_state">
1177+ <description summary="physical button state">
1178+ Describes the physical state of a button that caused the button
1179+ event.
1180+ </description>
1181+ <entry name="released" value="0" summary="the button is not pressed"/>
1182+ <entry name="pressed" value="1" summary="the button is pressed"/>
1183+ </enum>
1184+
1185+ <event name="button">
1186+ <description summary="physical button state">
1187+ Sent whenever the physical state of a button changes.
1188+ </description>
1189+ <arg name="time" type="uint" summary="the time of the event with millisecond granularity"/>
1190+ <arg name="button" type="uint" summary="the index of the button that changed state"/>
1191+ <arg name="state" type="uint" enum="button_state"/>
1192+ </event>
1193+
1194+ <event name="enter">
1195+ <description summary="enter event">
1196+ Notification that this pad is focused on the specified surface.
1197+ </description>
1198+ <arg name="serial" type="uint" summary="serial number of the enter event"/>
1199+ <arg name="tablet" type="object" interface="zwp_tablet_v2" summary="the tablet the pad is attached to"/>
1200+ <arg name="surface" type="object" interface="wl_surface" summary="surface the pad is focused on"/>
1201+ </event>
1202+
1203+ <event name="leave">
1204+ <description summary="leave event">
1205+ Notification that this pad is no longer focused on the specified
1206+ surface.
1207+ </description>
1208+ <arg name="serial" type="uint" summary="serial number of the leave event"/>
1209+ <arg name="surface" type="object" interface="wl_surface" summary="surface the pad is no longer focused on"/>
1210+ </event>
1211+
1212+ <event name="removed">
1213+ <description summary="pad removed event">
1214+ Sent when the pad has been removed from the system. When a tablet
1215+ is removed its pad(s) will be removed too.
1216+
1217+ When this event is received, the client must destroy all rings, strips
1218+ and groups that were offered by this pad, and issue zwp_tablet_pad_v2.destroy
1219+ the pad itself.
1220+ </description>
1221+ </event>
1222+ </interface>
1223+
1224+ <interface name="zwp_tablet_pad_dial_v2" version="2">
1225+ <description summary="pad dial">
1226+ A rotary control, e.g. a dial or a wheel.
1227+
1228+ Events on a dial are logically grouped by the zwp_tablet_pad_dial_v2.frame
1229+ event.
1230+ </description>
1231+
1232+ <request name="set_feedback">
1233+ <description summary="set compositor feedback">
1234+ Requests the compositor to use the provided feedback string
1235+ associated with this dial. This request should be issued immediately
1236+ after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
1237+ group is received, or whenever the dial is mapped to a different
1238+ action. See zwp_tablet_pad_group_v2.mode_switch for more details.
1239+
1240+ Clients are encouraged to provide context-aware descriptions for
1241+ the actions associated with the dial, and compositors may use this
1242+ information to offer visual feedback about the button layout
1243+ (eg. on-screen displays).
1244+
1245+ The provided string 'description' is a UTF-8 encoded string to be
1246+ associated with this ring, and is considered user-visible; general
1247+ internationalization rules apply.
1248+
1249+ The serial argument will be that of the last
1250+ zwp_tablet_pad_group_v2.mode_switch event received for the group of this
1251+ dial. Requests providing other serials than the most recent one will be
1252+ ignored.
1253+ </description>
1254+ <arg name="description" type="string" summary="dial description"/>
1255+ <arg name="serial" type="uint" summary="serial of the mode switch event"/>
1256+ </request>
1257+
1258+ <request name="destroy" type="destructor">
1259+ <description summary="destroy the dial object">
1260+ This destroys the client's resource for this dial object.
1261+ </description>
1262+ </request>
1263+
1264+ <event name="delta">
1265+ <description summary="delta movement">
1266+ Sent whenever the position on a dial changes.
1267+
1268+ This event carries the wheel delta as multiples or fractions
1269+ of 120 with each multiple of 120 representing one logical wheel detent.
1270+ For example, an axis_value120 of 30 is one quarter of
1271+ a logical wheel step in the positive direction, a value120 of
1272+ -240 are two logical wheel steps in the negative direction within the
1273+ same hardware event. See the wl_pointer.axis_value120 for more details.
1274+
1275+ The value120 must not be zero.
1276+ </description>
1277+ <arg name="value120" type="int" summary="rotation distance as fraction of 120"/>
1278+ </event>
1279+
1280+ <event name="frame">
1281+ <description summary="end of a dial event sequence">
1282+ Indicates the end of a set of events that represent one logical
1283+ hardware dial event. A client is expected to accumulate the data
1284+ in all events within the frame before proceeding.
1285+
1286+ All zwp_tablet_pad_dial_v2 events before a zwp_tablet_pad_dial_v2.frame event belong
1287+ logically together.
1288+
1289+ A zwp_tablet_pad_dial_v2.frame event is sent for every logical event
1290+ group, even if the group only contains a single zwp_tablet_pad_dial_v2
1291+ event. Specifically, a client may get a sequence: delta, frame,
1292+ delta, frame, etc.
1293+ </description>
1294+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
1295+ </event>
1296+ </interface>
1297+</protocol>
@@ -0,0 +1,1297 @@
1+<?xml version="1.0" encoding="UTF-8"?>
2+<protocol name="tablet_v2">
3+
4+ <copyright>
5+ Copyright 2014 © Stephen "Lyude" Chandler Paul
6+ Copyright 2015-2024 © Red Hat, Inc.
7+
8+ Permission is hereby granted, free of charge, to any person
9+ obtaining a copy of this software and associated documentation files
10+ (the "Software"), to deal in the Software without restriction,
11+ including without limitation the rights to use, copy, modify, merge,
12+ publish, distribute, sublicense, and/or sell copies of the Software,
13+ and to permit persons to whom the Software is furnished to do so,
14+ subject to the following conditions:
15+
16+ The above copyright notice and this permission notice (including the
17+ next paragraph) shall be included in all copies or substantial
18+ portions of the Software.
19+
20+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24+ BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25+ ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27+ SOFTWARE.
28+ </copyright>
29+
30+ <description summary="Wayland protocol for graphics tablets">
31+ This description provides a high-level overview of the interplay between
32+ the interfaces defined this protocol. For details, see the protocol
33+ specification.
34+
35+ More than one tablet may exist, and device-specifics matter. Tablets are
36+ not represented by a single virtual device like wl_pointer. A client
37+ binds to the tablet manager object which is just a proxy object. From
38+ that, the client requests zwp_tablet_manager_v2.get_tablet_seat(wl_seat)
39+ and that returns the actual interface that has all the tablets. With
40+ this indirection, we can avoid merging zwp_tablet_v2 into the actual Wayland
41+ protocol, a long-term benefit.
42+
43+ The zwp_tablet_seat_v2 sends a "tablet added" event for each tablet
44+ connected. That event is followed by descriptive events about the
45+ hardware; currently that includes events for name, vid/pid and
46+ a zwp_tablet_v2.path event that describes a local path. This path can be
47+ used to uniquely identify a tablet or get more information through
48+ libwacom. Emulated or nested tablets can skip any of those, e.g. a
49+ virtual tablet may not have a vid/pid. The sequence of descriptive
50+ events is terminated by a zwp_tablet_v2.done event to signal that a client
51+ may now finalize any initialization for that tablet.
52+
53+ Events from tablets require a tool in proximity. Tools are also managed
54+ by the tablet seat; a "tool added" event is sent whenever a tool is new
55+ to the compositor. That event is followed by a number of descriptive
56+ events about the hardware; currently that includes capabilities,
57+ hardware id and serial number, and tool type. Similar to the tablet
58+ interface, a zwp_tablet_tool_v2.done event is sent to terminate that initial
59+ sequence.
60+
61+ Any event from a tool happens on the zwp_tablet_tool_v2 interface. When the
62+ tool gets into proximity of the tablet, a proximity_in event is sent on
63+ the zwp_tablet_tool_v2 interface, listing the tablet and the surface. That
64+ event is followed by a motion event with the coordinates. After that,
65+ it's the usual motion, axis, button, etc. events. The protocol's
66+ serialisation means events are grouped by zwp_tablet_tool_v2.frame events.
67+
68+ Two special events (that don't exist in X) are down and up. They signal
69+ "tip touching the surface". For tablets without real proximity
70+ detection, the sequence is: proximity_in, motion, down, frame.
71+
72+ When the tool leaves proximity, a proximity_out event is sent. If any
73+ button is still down, a button release event is sent before this
74+ proximity event. These button events are sent in the same frame as the
75+ proximity event to signal to the client that the buttons were held when
76+ the tool left proximity.
77+
78+ If the tool moves out of the surface but stays in proximity (i.e.
79+ between windows), compositor-specific grab policies apply. This usually
80+ means that the proximity-out is delayed until all buttons are released.
81+
82+ Moving a tool physically from one tablet to the other has no real effect
83+ on the protocol, since we already have the tool object from the "tool
84+ added" event. All the information is already there and the proximity
85+ events on both tablets are all a client needs to reconstruct what
86+ happened.
87+
88+ Some extra axes are normalized, i.e. the client knows the range as
89+ specified in the protocol (e.g. [0, 65535]), the granularity however is
90+ unknown. The current normalized axes are pressure, distance, and slider.
91+
92+ Other extra axes are in physical units as specified in the protocol.
93+ The current extra axes with physical units are tilt, rotation and
94+ wheel rotation.
95+
96+ Since tablets work independently of the pointer controlled by the mouse,
97+ the focus handling is independent too and controlled by proximity.
98+ The zwp_tablet_tool_v2.set_cursor request sets a tool-specific cursor.
99+ This cursor surface may be the same as the mouse cursor, and it may be
100+ the same across tools but it is possible to be more fine-grained. For
101+ example, a client may set different cursors for the pen and eraser.
102+
103+ Tools are generally independent of tablets and it is
104+ compositor-specific policy when a tool can be removed. Common approaches
105+ will likely include some form of removing a tool when all tablets the
106+ tool was used on are removed.
107+ </description>
108+
109+ <interface name="zwp_tablet_manager_v2" version="2">
110+ <description summary="controller object for graphic tablet devices">
111+ An object that provides access to the graphics tablets available on this
112+ system. All tablets are associated with a seat, to get access to the
113+ actual tablets, use zwp_tablet_manager_v2.get_tablet_seat.
114+ </description>
115+
116+ <request name="get_tablet_seat">
117+ <description summary="get the tablet seat">
118+ Get the zwp_tablet_seat_v2 object for the given seat. This object
119+ provides access to all graphics tablets in this seat.
120+ </description>
121+ <arg name="tablet_seat" type="new_id" interface="zwp_tablet_seat_v2"/>
122+ <arg name="seat" type="object" interface="wl_seat" summary="The wl_seat object to retrieve the tablets for" />
123+ </request>
124+
125+ <request name="destroy" type="destructor">
126+ <description summary="release the memory for the tablet manager object">
127+ Destroy the zwp_tablet_manager_v2 object. Objects created from this
128+ object are unaffected and should be destroyed separately.
129+ </description>
130+ </request>
131+ </interface>
132+
133+ <interface name="zwp_tablet_seat_v2" version="2">
134+ <description summary="controller object for graphic tablet devices of a seat">
135+ An object that provides access to the graphics tablets available on this
136+ seat. After binding to this interface, the compositor sends a set of
137+ zwp_tablet_seat_v2.tablet_added and zwp_tablet_seat_v2.tool_added events.
138+ </description>
139+
140+ <request name="destroy" type="destructor">
141+ <description summary="release the memory for the tablet seat object">
142+ Destroy the zwp_tablet_seat_v2 object. Objects created from this
143+ object are unaffected and should be destroyed separately.
144+ </description>
145+ </request>
146+
147+ <event name="tablet_added">
148+ <description summary="new device notification">
149+ This event is sent whenever a new tablet becomes available on this
150+ seat. This event only provides the object id of the tablet, any
151+ static information about the tablet (device name, vid/pid, etc.) is
152+ sent through the zwp_tablet_v2 interface.
153+ </description>
154+ <arg name="id" type="new_id" interface="zwp_tablet_v2" summary="the newly added graphics tablet"/>
155+ </event>
156+
157+ <event name="tool_added">
158+ <description summary="a new tool has been used with a tablet">
159+ This event is sent whenever a tool that has not previously been used
160+ with a tablet comes into use. This event only provides the object id
161+ of the tool; any static information about the tool (capabilities,
162+ type, etc.) is sent through the zwp_tablet_tool_v2 interface.
163+ </description>
164+ <arg name="id" type="new_id" interface="zwp_tablet_tool_v2" summary="the newly added tablet tool"/>
165+ </event>
166+
167+ <event name="pad_added">
168+ <description summary="new pad notification">
169+ This event is sent whenever a new pad is known to the system. Typically,
170+ pads are physically attached to tablets and a pad_added event is
171+ sent immediately after the zwp_tablet_seat_v2.tablet_added.
172+ However, some standalone pad devices logically attach to tablets at
173+ runtime, and the client must wait for zwp_tablet_pad_v2.enter to know
174+ the tablet a pad is attached to.
175+
176+ This event only provides the object id of the pad. All further
177+ features (buttons, strips, rings) are sent through the zwp_tablet_pad_v2
178+ interface.
179+ </description>
180+ <arg name="id" type="new_id" interface="zwp_tablet_pad_v2" summary="the newly added pad"/>
181+ </event>
182+ </interface>
183+
184+ <interface name="zwp_tablet_tool_v2" version="2">
185+ <description summary="a physical tablet tool">
186+ An object that represents a physical tool that has been, or is
187+ currently in use with a tablet in this seat. Each zwp_tablet_tool_v2
188+ object stays valid until the client destroys it; the compositor
189+ reuses the zwp_tablet_tool_v2 object to indicate that the object's
190+ respective physical tool has come into proximity of a tablet again.
191+
192+ A zwp_tablet_tool_v2 object's relation to a physical tool depends on the
193+ tablet's ability to report serial numbers. If the tablet supports
194+ this capability, then the object represents a specific physical tool
195+ and can be identified even when used on multiple tablets.
196+
197+ A tablet tool has a number of static characteristics, e.g. tool type,
198+ hardware_serial and capabilities. These capabilities are sent in an
199+ event sequence after the zwp_tablet_seat_v2.tool_added event before any
200+ actual events from this tool. This initial event sequence is
201+ terminated by a zwp_tablet_tool_v2.done event.
202+
203+ Tablet tool events are grouped by zwp_tablet_tool_v2.frame events.
204+ Any events received before a zwp_tablet_tool_v2.frame event should be
205+ considered part of the same hardware state change.
206+ </description>
207+
208+ <request name="set_cursor">
209+ <description summary="set the tablet tool's surface">
210+ Sets the surface of the cursor used for this tool on the given
211+ tablet. This request only takes effect if the tool is in proximity
212+ of one of the requesting client's surfaces or the surface parameter
213+ is the current pointer surface. If there was a previous surface set
214+ with this request it is replaced. If surface is NULL, the cursor
215+ image is hidden.
216+
217+ The parameters hotspot_x and hotspot_y define the position of the
218+ pointer surface relative to the pointer location. Its top-left corner
219+ is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the
220+ coordinates of the pointer location, in surface-local coordinates.
221+
222+ On surface.attach requests to the pointer surface, hotspot_x and
223+ hotspot_y are decremented by the x and y parameters passed to the
224+ request. Attach must be confirmed by wl_surface.commit as usual.
225+
226+ The hotspot can also be updated by passing the currently set pointer
227+ surface to this request with new values for hotspot_x and hotspot_y.
228+
229+ The current and pending input regions of the wl_surface are cleared,
230+ and wl_surface.set_input_region is ignored until the wl_surface is no
231+ longer used as the cursor. When the use as a cursor ends, the current
232+ and pending input regions become undefined, and the wl_surface is
233+ unmapped.
234+
235+ This request gives the surface the role of a zwp_tablet_tool_v2 cursor. A
236+ surface may only ever be used as the cursor surface for one
237+ zwp_tablet_tool_v2. If the surface already has another role or has
238+ previously been used as cursor surface for a different tool, a
239+ protocol error is raised.
240+ </description>
241+ <arg name="serial" type="uint" summary="serial of the proximity_in event"/>
242+ <arg name="surface" type="object" interface="wl_surface" allow-null="true"/>
243+ <arg name="hotspot_x" type="int" summary="surface-local x coordinate"/>
244+ <arg name="hotspot_y" type="int" summary="surface-local y coordinate"/>
245+ </request>
246+
247+ <request name="destroy" type="destructor">
248+ <description summary="destroy the tool object">
249+ This destroys the client's resource for this tool object.
250+ </description>
251+ </request>
252+
253+ <enum name="type">
254+ <description summary="a physical tool type">
255+ Describes the physical type of a tool. The physical type of a tool
256+ generally defines its base usage.
257+
258+ The mouse tool represents a mouse-shaped tool that is not a relative
259+ device but bound to the tablet's surface, providing absolute
260+ coordinates.
261+
262+ The lens tool is a mouse-shaped tool with an attached lens to
263+ provide precision focus.
264+ </description>
265+ <entry name="pen" value="0x140" summary="Pen"/>
266+ <entry name="eraser" value="0x141" summary="Eraser"/>
267+ <entry name="brush" value="0x142" summary="Brush"/>
268+ <entry name="pencil" value="0x143" summary="Pencil"/>
269+ <entry name="airbrush" value="0x144" summary="Airbrush"/>
270+ <entry name="finger" value="0x145" summary="Finger"/>
271+ <entry name="mouse" value="0x146" summary="Mouse"/>
272+ <entry name="lens" value="0x147" summary="Lens"/>
273+ </enum>
274+
275+ <event name="type">
276+ <description summary="tool type">
277+ The tool type is the high-level type of the tool and usually decides
278+ the interaction expected from this tool.
279+
280+ This event is sent in the initial burst of events before the
281+ zwp_tablet_tool_v2.done event.
282+ </description>
283+ <arg name="tool_type" type="uint" enum="type" summary="the physical tool type"/>
284+ </event>
285+
286+ <event name="hardware_serial">
287+ <description summary="unique hardware serial number of the tool">
288+ If the physical tool can be identified by a unique 64-bit serial
289+ number, this event notifies the client of this serial number.
290+
291+ If multiple tablets are available in the same seat and the tool is
292+ uniquely identifiable by the serial number, that tool may move
293+ between tablets.
294+
295+ Otherwise, if the tool has no serial number and this event is
296+ missing, the tool is tied to the tablet it first comes into
297+ proximity with. Even if the physical tool is used on multiple
298+ tablets, separate zwp_tablet_tool_v2 objects will be created, one per
299+ tablet.
300+
301+ This event is sent in the initial burst of events before the
302+ zwp_tablet_tool_v2.done event.
303+ </description>
304+ <arg name="hardware_serial_hi" type="uint" summary="the unique serial number of the tool, most significant bits"/>
305+ <arg name="hardware_serial_lo" type="uint" summary="the unique serial number of the tool, least significant bits"/>
306+ </event>
307+
308+ <event name="hardware_id_wacom">
309+ <description summary="hardware id notification in Wacom's format">
310+ This event notifies the client of a hardware id available on this tool.
311+
312+ The hardware id is a device-specific 64-bit id that provides extra
313+ information about the tool in use, beyond the wl_tool.type
314+ enumeration. The format of the id is specific to tablets made by
315+ Wacom Inc. For example, the hardware id of a Wacom Grip
316+ Pen (a stylus) is 0x802.
317+
318+ This event is sent in the initial burst of events before the
319+ zwp_tablet_tool_v2.done event.
320+ </description>
321+ <arg name="hardware_id_hi" type="uint" summary="the hardware id, most significant bits"/>
322+ <arg name="hardware_id_lo" type="uint" summary="the hardware id, least significant bits"/>
323+ </event>
324+
325+ <enum name="capability">
326+ <description summary="capability flags for a tool">
327+ Describes extra capabilities on a tablet.
328+
329+ Any tool must provide x and y values, extra axes are
330+ device-specific.
331+ </description>
332+ <entry name="tilt" value="1" summary="Tilt axes"/>
333+ <entry name="pressure" value="2" summary="Pressure axis"/>
334+ <entry name="distance" value="3" summary="Distance axis"/>
335+ <entry name="rotation" value="4" summary="Z-rotation axis"/>
336+ <entry name="slider" value="5" summary="Slider axis"/>
337+ <entry name="wheel" value="6" summary="Wheel axis"/>
338+ </enum>
339+
340+ <event name="capability">
341+ <description summary="tool capability notification">
342+ This event notifies the client of any capabilities of this tool,
343+ beyond the main set of x/y axes and tip up/down detection.
344+
345+ One event is sent for each extra capability available on this tool.
346+
347+ This event is sent in the initial burst of events before the
348+ zwp_tablet_tool_v2.done event.
349+ </description>
350+ <arg name="capability" type="uint" enum="capability" summary="the capability"/>
351+ </event>
352+
353+ <event name="done">
354+ <description summary="tool description events sequence complete">
355+ This event signals the end of the initial burst of descriptive
356+ events. A client may consider the static description of the tool to
357+ be complete and finalize initialization of the tool.
358+ </description>
359+ </event>
360+
361+ <event name="removed">
362+ <description summary="tool removed">
363+ This event is sent when the tool is removed from the system and will
364+ send no further events. Should the physical tool come back into
365+ proximity later, a new zwp_tablet_tool_v2 object will be created.
366+
367+ It is compositor-dependent when a tool is removed. A compositor may
368+ remove a tool on proximity out, tablet removal or any other reason.
369+ A compositor may also keep a tool alive until shutdown.
370+
371+ If the tool is currently in proximity, a proximity_out event will be
372+ sent before the removed event. See zwp_tablet_tool_v2.proximity_out for
373+ the handling of any buttons logically down.
374+
375+ When this event is received, the client must zwp_tablet_tool_v2.destroy
376+ the object.
377+ </description>
378+ </event>
379+
380+ <event name="proximity_in">
381+ <description summary="proximity in event">
382+ Notification that this tool is focused on a certain surface.
383+
384+ This event can be received when the tool has moved from one surface to
385+ another, or when the tool has come back into proximity above the
386+ surface.
387+
388+ If any button is logically down when the tool comes into proximity,
389+ the respective button event is sent after the proximity_in event but
390+ within the same frame as the proximity_in event.
391+ </description>
392+ <arg name="serial" type="uint"/>
393+ <arg name="tablet" type="object" interface="zwp_tablet_v2" summary="The tablet the tool is in proximity of"/>
394+ <arg name="surface" type="object" interface="wl_surface" summary="The current surface the tablet tool is over"/>
395+ </event>
396+
397+ <event name="proximity_out">
398+ <description summary="proximity out event">
399+ Notification that this tool has either left proximity, or is no
400+ longer focused on a certain surface.
401+
402+ When the tablet tool leaves proximity of the tablet, button release
403+ events are sent for each button that was held down at the time of
404+ leaving proximity. These events are sent before the proximity_out
405+ event but within the same zwp_tablet_v2.frame.
406+
407+ If the tool stays within proximity of the tablet, but the focus
408+ changes from one surface to another, a button release event may not
409+ be sent until the button is actually released or the tool leaves the
410+ proximity of the tablet.
411+ </description>
412+ </event>
413+
414+ <event name="down">
415+ <description summary="tablet tool is making contact">
416+ Sent whenever the tablet tool comes in contact with the surface of the
417+ tablet.
418+
419+ If the tool is already in contact with the tablet when entering the
420+ input region, the client owning said region will receive a
421+ zwp_tablet_v2.proximity_in event, followed by a zwp_tablet_v2.down
422+ event and a zwp_tablet_v2.frame event.
423+
424+ Note that this event describes logical contact, not physical
425+ contact. On some devices, a compositor may not consider a tool in
426+ logical contact until a minimum physical pressure threshold is
427+ exceeded.
428+ </description>
429+ <arg name="serial" type="uint"/>
430+ </event>
431+
432+ <event name="up">
433+ <description summary="tablet tool is no longer making contact">
434+ Sent whenever the tablet tool stops making contact with the surface of
435+ the tablet, or when the tablet tool moves out of the input region
436+ and the compositor grab (if any) is dismissed.
437+
438+ If the tablet tool moves out of the input region while in contact
439+ with the surface of the tablet and the compositor does not have an
440+ ongoing grab on the surface, the client owning said region will
441+ receive a zwp_tablet_v2.up event, followed by a zwp_tablet_v2.proximity_out
442+ event and a zwp_tablet_v2.frame event. If the compositor has an ongoing
443+ grab on this device, this event sequence is sent whenever the grab
444+ is dismissed in the future.
445+
446+ Note that this event describes logical contact, not physical
447+ contact. On some devices, a compositor may not consider a tool out
448+ of logical contact until physical pressure falls below a specific
449+ threshold.
450+ </description>
451+ </event>
452+
453+ <event name="motion">
454+ <description summary="motion event">
455+ Sent whenever a tablet tool moves.
456+ </description>
457+ <arg name="x" type="fixed" summary="surface-local x coordinate"/>
458+ <arg name="y" type="fixed" summary="surface-local y coordinate"/>
459+ </event>
460+
461+ <event name="pressure">
462+ <description summary="pressure change event">
463+ Sent whenever the pressure axis on a tool changes. The value of this
464+ event is normalized to a value between 0 and 65535.
465+
466+ Note that pressure may be nonzero even when a tool is not in logical
467+ contact. See the down and up events for more details.
468+ </description>
469+ <arg name="pressure" type="uint" summary="The current pressure value"/>
470+ </event>
471+
472+ <event name="distance">
473+ <description summary="distance change event">
474+ Sent whenever the distance axis on a tool changes. The value of this
475+ event is normalized to a value between 0 and 65535.
476+
477+ Note that distance may be nonzero even when a tool is not in logical
478+ contact. See the down and up events for more details.
479+ </description>
480+ <arg name="distance" type="uint" summary="The current distance value"/>
481+ </event>
482+
483+ <event name="tilt">
484+ <description summary="tilt change event">
485+ Sent whenever one or both of the tilt axes on a tool change. Each tilt
486+ value is in degrees, relative to the z-axis of the tablet.
487+ The angle is positive when the top of a tool tilts along the
488+ positive x or y axis.
489+ </description>
490+ <arg name="tilt_x" type="fixed" summary="The current value of the X tilt axis"/>
491+ <arg name="tilt_y" type="fixed" summary="The current value of the Y tilt axis"/>
492+ </event>
493+
494+ <event name="rotation">
495+ <description summary="z-rotation change event">
496+ Sent whenever the z-rotation axis on the tool changes. The
497+ rotation value is in degrees clockwise from the tool's
498+ logical neutral position.
499+ </description>
500+ <arg name="degrees" type="fixed" summary="The current rotation of the Z axis"/>
501+ </event>
502+
503+ <event name="slider">
504+ <description summary="Slider position change event">
505+ Sent whenever the slider position on the tool changes. The
506+ value is normalized between -65535 and 65535, with 0 as the logical
507+ neutral position of the slider.
508+
509+ The slider is available on e.g. the Wacom Airbrush tool.
510+ </description>
511+ <arg name="position" type="int" summary="The current position of slider"/>
512+ </event>
513+
514+ <event name="wheel">
515+ <description summary="Wheel delta event">
516+ Sent whenever the wheel on the tool emits an event. This event
517+ contains two values for the same axis change. The degrees value is
518+ in the same orientation as the wl_pointer.vertical_scroll axis. The
519+ clicks value is in discrete logical clicks of the mouse wheel. This
520+ value may be zero if the movement of the wheel was less
521+ than one logical click.
522+
523+ Clients should choose either value and avoid mixing degrees and
524+ clicks. The compositor may accumulate values smaller than a logical
525+ click and emulate click events when a certain threshold is met.
526+ Thus, zwp_tablet_tool_v2.wheel events with non-zero clicks values may
527+ have different degrees values.
528+ </description>
529+ <arg name="degrees" type="fixed" summary="The wheel delta in degrees"/>
530+ <arg name="clicks" type="int" summary="The wheel delta in discrete clicks"/>
531+ </event>
532+
533+ <enum name="button_state">
534+ <description summary="physical button state">
535+ Describes the physical state of a button that produced the button event.
536+ </description>
537+ <entry name="released" value="0" summary="button is not pressed"/>
538+ <entry name="pressed" value="1" summary="button is pressed"/>
539+ </enum>
540+
541+ <event name="button">
542+ <description summary="button event">
543+ Sent whenever a button on the tool is pressed or released.
544+
545+ If a button is held down when the tool moves in or out of proximity,
546+ button events are generated by the compositor. See
547+ zwp_tablet_tool_v2.proximity_in and zwp_tablet_tool_v2.proximity_out for
548+ details.
549+ </description>
550+ <arg name="serial" type="uint"/>
551+ <arg name="button" type="uint" summary="The button whose state has changed"/>
552+ <arg name="state" type="uint" enum="button_state" summary="Whether the button was pressed or released"/>
553+ </event>
554+
555+ <event name="frame">
556+ <description summary="frame event">
557+ Marks the end of a series of axis and/or button updates from the
558+ tablet. The Wayland protocol requires axis updates to be sent
559+ sequentially, however all events within a frame should be considered
560+ one hardware event.
561+ </description>
562+ <arg name="time" type="uint" summary="The time of the event with millisecond granularity"/>
563+ </event>
564+
565+ <enum name="error">
566+ <entry name="role" value="0" summary="given wl_surface has another role"/>
567+ </enum>
568+ </interface>
569+
570+ <interface name="zwp_tablet_v2" version="2">
571+ <description summary="graphics tablet device">
572+ The zwp_tablet_v2 interface represents one graphics tablet device. The
573+ tablet interface itself does not generate events; all events are
574+ generated by zwp_tablet_tool_v2 objects when in proximity above a tablet.
575+
576+ A tablet has a number of static characteristics, e.g. device name and
577+ pid/vid. These capabilities are sent in an event sequence after the
578+ zwp_tablet_seat_v2.tablet_added event. This initial event sequence is
579+ terminated by a zwp_tablet_v2.done event.
580+ </description>
581+
582+ <request name="destroy" type="destructor">
583+ <description summary="destroy the tablet object">
584+ This destroys the client's resource for this tablet object.
585+ </description>
586+ </request>
587+
588+ <event name="name">
589+ <description summary="tablet device name">
590+ A descriptive name for the tablet device.
591+
592+ If the device has no descriptive name, this event is not sent.
593+
594+ This event is sent in the initial burst of events before the
595+ zwp_tablet_v2.done event.
596+ </description>
597+ <arg name="name" type="string" summary="the device name"/>
598+ </event>
599+
600+ <event name="id">
601+ <description summary="tablet device vendor/product id">
602+ The vendor and product IDs for the tablet device.
603+
604+ The interpretation of the id depends on the zwp_tablet_v2.bustype.
605+ Prior to version v2 of this protocol, the id was implied to be a USB
606+ vendor and product ID. If no zwp_tablet_v2.bustype is sent, the ID
607+ is to be interpreted as USB vendor and product ID.
608+
609+ If the device has no vendor/product ID, this event is not sent.
610+ This can happen for virtual devices or non-USB devices, for instance.
611+
612+ This event is sent in the initial burst of events before the
613+ zwp_tablet_v2.done event.
614+ </description>
615+ <arg name="vid" type="uint" summary="vendor id"/>
616+ <arg name="pid" type="uint" summary="product id"/>
617+ </event>
618+
619+ <event name="path">
620+ <description summary="path to the device">
621+ A system-specific device path that indicates which device is behind
622+ this zwp_tablet_v2. This information may be used to gather additional
623+ information about the device, e.g. through libwacom.
624+
625+ A device may have more than one device path. If so, multiple
626+ zwp_tablet_v2.path events are sent. A device may be emulated and not
627+ have a device path, and in that case this event will not be sent.
628+
629+ The format of the path is unspecified, it may be a device node, a
630+ sysfs path, or some other identifier. It is up to the client to
631+ identify the string provided.
632+
633+ This event is sent in the initial burst of events before the
634+ zwp_tablet_v2.done event.
635+ </description>
636+ <arg name="path" type="string" summary="path to local device"/>
637+ </event>
638+
639+ <event name="done">
640+ <description summary="tablet description events sequence complete">
641+ This event is sent immediately to signal the end of the initial
642+ burst of descriptive events. A client may consider the static
643+ description of the tablet to be complete and finalize initialization
644+ of the tablet.
645+ </description>
646+ </event>
647+
648+ <event name="removed">
649+ <description summary="tablet removed event">
650+ Sent when the tablet has been removed from the system. When a tablet
651+ is removed, some tools may be removed.
652+
653+ When this event is received, the client must zwp_tablet_v2.destroy
654+ the object.
655+ </description>
656+ </event>
657+
658+ <!-- Version 2 additions -->
659+
660+ <enum name="bustype" since="2">
661+ <description summary="bus type ">
662+ Describes the bus types this tablet is connected to.
663+ </description>
664+ <entry name="usb" value="3" summary="USB"/>
665+ <entry name="bluetooth" value="5" summary="Bluetooth"/>
666+ <entry name="virtual" value="6" summary="Virtual"/>
667+ <entry name="serial" value="17" summary="Serial"/>
668+ <entry name="i2c" value="24" summary="I2C"/>
669+ </enum>
670+
671+ <event name="bustype" since="2">
672+ <description summary="tablet device bus type">
673+ The bustype argument is one of the BUS_ defines in the Linux kernel's
674+ linux/input.h
675+
676+ If the device has no known bustype or the bustype cannot be
677+ queried, this event is not sent.
678+
679+ This event is sent in the initial burst of events before the
680+ zwp_tablet_v2.done event.
681+ </description>
682+ <arg name="bustype" type="uint" enum="bustype" summary="bus type"/>
683+ </event>
684+ </interface>
685+
686+ <interface name="zwp_tablet_pad_ring_v2" version="2">
687+ <description summary="pad ring">
688+ A circular interaction area, such as the touch ring on the Wacom Intuos
689+ Pro series tablets.
690+
691+ Events on a ring are logically grouped by the zwp_tablet_pad_ring_v2.frame
692+ event.
693+ </description>
694+
695+ <request name="set_feedback">
696+ <description summary="set compositor feedback">
697+ Request that the compositor use the provided feedback string
698+ associated with this ring. This request should be issued immediately
699+ after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
700+ group is received, or whenever the ring is mapped to a different
701+ action. See zwp_tablet_pad_group_v2.mode_switch for more details.
702+
703+ Clients are encouraged to provide context-aware descriptions for
704+ the actions associated with the ring; compositors may use this
705+ information to offer visual feedback about the button layout
706+ (eg. on-screen displays).
707+
708+ The provided string 'description' is a UTF-8 encoded string to be
709+ associated with this ring, and is considered user-visible; general
710+ internationalization rules apply.
711+
712+ The serial argument will be that of the last
713+ zwp_tablet_pad_group_v2.mode_switch event received for the group of this
714+ ring. Requests providing other serials than the most recent one will be
715+ ignored.
716+ </description>
717+ <arg name="description" type="string" summary="ring description"/>
718+ <arg name="serial" type="uint" summary="serial of the mode switch event"/>
719+ </request>
720+
721+ <request name="destroy" type="destructor">
722+ <description summary="destroy the ring object">
723+ This destroys the client's resource for this ring object.
724+ </description>
725+ </request>
726+
727+ <enum name="source">
728+ <description summary="ring axis source">
729+ Describes the source types for ring events. This indicates to the
730+ client how a ring event was physically generated; a client may
731+ adjust the user interface accordingly. For example, events
732+ from a "finger" source may trigger kinetic scrolling.
733+ </description>
734+ <entry name="finger" value="1" summary="finger"/>
735+ </enum>
736+
737+ <event name="source">
738+ <description summary="ring event source">
739+ Source information for ring events.
740+
741+ This event does not occur on its own. It is sent before a
742+ zwp_tablet_pad_ring_v2.frame event and carries the source information
743+ for all events within that frame.
744+
745+ The source specifies how this event was generated. If the source is
746+ zwp_tablet_pad_ring_v2.source.finger, a zwp_tablet_pad_ring_v2.stop event
747+ will be sent when the user lifts the finger off the device.
748+
749+ This event is optional. If the source is unknown for an interaction,
750+ no event is sent.
751+ </description>
752+ <arg name="source" type="uint" enum="source" summary="the event source"/>
753+ </event>
754+
755+ <event name="angle">
756+ <description summary="angle changed">
757+ Sent whenever the angle on a ring changes.
758+
759+ The angle is provided in degrees clockwise from the logical
760+ north of the ring in the pad's current rotation.
761+ </description>
762+ <arg name="degrees" type="fixed" summary="the current angle in degrees"/>
763+ </event>
764+
765+ <event name="stop">
766+ <description summary="interaction stopped">
767+ Stop notification for ring events.
768+
769+ For some zwp_tablet_pad_ring_v2.source types, a zwp_tablet_pad_ring_v2.stop
770+ event is sent to notify a client that the interaction with the ring
771+ has terminated. This enables the client to implement kinetic scrolling.
772+ See the zwp_tablet_pad_ring_v2.source documentation for information on
773+ when this event may be generated.
774+
775+ Any zwp_tablet_pad_ring_v2.angle events with the same source after this
776+ event should be considered as the start of a new interaction.
777+ </description>
778+ </event>
779+
780+ <event name="frame">
781+ <description summary="end of a ring event sequence">
782+ Indicates the end of a set of ring events that logically belong
783+ together. A client is expected to accumulate the data in all events
784+ within the frame before proceeding.
785+
786+ All zwp_tablet_pad_ring_v2 events before a zwp_tablet_pad_ring_v2.frame event belong
787+ logically together. For example, on termination of a finger interaction
788+ on a ring the compositor will send a zwp_tablet_pad_ring_v2.source event,
789+ a zwp_tablet_pad_ring_v2.stop event and a zwp_tablet_pad_ring_v2.frame event.
790+
791+ A zwp_tablet_pad_ring_v2.frame event is sent for every logical event
792+ group, even if the group only contains a single zwp_tablet_pad_ring_v2
793+ event. Specifically, a client may get a sequence: angle, frame,
794+ angle, frame, etc.
795+ </description>
796+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
797+ </event>
798+ </interface>
799+
800+ <interface name="zwp_tablet_pad_strip_v2" version="2">
801+ <description summary="pad strip">
802+ A linear interaction area, such as the strips found in Wacom Cintiq
803+ models.
804+
805+ Events on a strip are logically grouped by the zwp_tablet_pad_strip_v2.frame
806+ event.
807+ </description>
808+
809+ <request name="set_feedback">
810+ <description summary="set compositor feedback">
811+ Requests the compositor to use the provided feedback string
812+ associated with this strip. This request should be issued immediately
813+ after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
814+ group is received, or whenever the strip is mapped to a different
815+ action. See zwp_tablet_pad_group_v2.mode_switch for more details.
816+
817+ Clients are encouraged to provide context-aware descriptions for
818+ the actions associated with the strip, and compositors may use this
819+ information to offer visual feedback about the button layout
820+ (eg. on-screen displays).
821+
822+ The provided string 'description' is a UTF-8 encoded string to be
823+ associated with this ring, and is considered user-visible; general
824+ internationalization rules apply.
825+
826+ The serial argument will be that of the last
827+ zwp_tablet_pad_group_v2.mode_switch event received for the group of this
828+ strip. Requests providing other serials than the most recent one will be
829+ ignored.
830+ </description>
831+ <arg name="description" type="string" summary="strip description"/>
832+ <arg name="serial" type="uint" summary="serial of the mode switch event"/>
833+ </request>
834+
835+ <request name="destroy" type="destructor">
836+ <description summary="destroy the strip object">
837+ This destroys the client's resource for this strip object.
838+ </description>
839+ </request>
840+
841+ <enum name="source">
842+ <description summary="strip axis source">
843+ Describes the source types for strip events. This indicates to the
844+ client how a strip event was physically generated; a client may
845+ adjust the user interface accordingly. For example, events
846+ from a "finger" source may trigger kinetic scrolling.
847+ </description>
848+ <entry name="finger" value="1" summary="finger"/>
849+ </enum>
850+
851+ <event name="source">
852+ <description summary="strip event source">
853+ Source information for strip events.
854+
855+ This event does not occur on its own. It is sent before a
856+ zwp_tablet_pad_strip_v2.frame event and carries the source information
857+ for all events within that frame.
858+
859+ The source specifies how this event was generated. If the source is
860+ zwp_tablet_pad_strip_v2.source.finger, a zwp_tablet_pad_strip_v2.stop event
861+ will be sent when the user lifts their finger off the device.
862+
863+ This event is optional. If the source is unknown for an interaction,
864+ no event is sent.
865+ </description>
866+ <arg name="source" type="uint" enum="source" summary="the event source"/>
867+ </event>
868+
869+ <event name="position">
870+ <description summary="position changed">
871+ Sent whenever the position on a strip changes.
872+
873+ The position is normalized to a range of [0, 65535], the 0-value
874+ represents the top-most and/or left-most position of the strip in
875+ the pad's current rotation.
876+ </description>
877+ <arg name="position" type="uint" summary="the current position"/>
878+ </event>
879+
880+ <event name="stop">
881+ <description summary="interaction stopped">
882+ Stop notification for strip events.
883+
884+ For some zwp_tablet_pad_strip_v2.source types, a zwp_tablet_pad_strip_v2.stop
885+ event is sent to notify a client that the interaction with the strip
886+ has terminated. This enables the client to implement kinetic
887+ scrolling. See the zwp_tablet_pad_strip_v2.source documentation for
888+ information on when this event may be generated.
889+
890+ Any zwp_tablet_pad_strip_v2.position events with the same source after this
891+ event should be considered as the start of a new interaction.
892+ </description>
893+ </event>
894+
895+ <event name="frame">
896+ <description summary="end of a strip event sequence">
897+ Indicates the end of a set of events that represent one logical
898+ hardware strip event. A client is expected to accumulate the data
899+ in all events within the frame before proceeding.
900+
901+ All zwp_tablet_pad_strip_v2 events before a zwp_tablet_pad_strip_v2.frame event belong
902+ logically together. For example, on termination of a finger interaction
903+ on a strip the compositor will send a zwp_tablet_pad_strip_v2.source event,
904+ a zwp_tablet_pad_strip_v2.stop event and a zwp_tablet_pad_strip_v2.frame
905+ event.
906+
907+ A zwp_tablet_pad_strip_v2.frame event is sent for every logical event
908+ group, even if the group only contains a single zwp_tablet_pad_strip_v2
909+ event. Specifically, a client may get a sequence: position, frame,
910+ position, frame, etc.
911+ </description>
912+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
913+ </event>
914+ </interface>
915+
916+ <interface name="zwp_tablet_pad_group_v2" version="2">
917+ <description summary="a set of buttons, rings and strips">
918+ A pad group describes a distinct (sub)set of buttons, rings and strips
919+ present in the tablet. The criteria of this grouping is usually positional,
920+ eg. if a tablet has buttons on the left and right side, 2 groups will be
921+ presented. The physical arrangement of groups is undisclosed and may
922+ change on the fly.
923+
924+ Pad groups will announce their features during pad initialization. Between
925+ the corresponding zwp_tablet_pad_v2.group event and zwp_tablet_pad_group_v2.done, the
926+ pad group will announce the buttons, rings and strips contained in it,
927+ plus the number of supported modes.
928+
929+ Modes are a mechanism to allow multiple groups of actions for every element
930+ in the pad group. The number of groups and available modes in each is
931+ persistent across device plugs. The current mode is user-switchable, it
932+ will be announced through the zwp_tablet_pad_group_v2.mode_switch event both
933+ whenever it is switched, and after zwp_tablet_pad_v2.enter.
934+
935+ The current mode logically applies to all elements in the pad group,
936+ although it is at clients' discretion whether to actually perform different
937+ actions, and/or issue the respective .set_feedback requests to notify the
938+ compositor. See the zwp_tablet_pad_group_v2.mode_switch event for more details.
939+ </description>
940+
941+ <request name="destroy" type="destructor">
942+ <description summary="destroy the pad object">
943+ Destroy the zwp_tablet_pad_group_v2 object. Objects created from this object
944+ are unaffected and should be destroyed separately.
945+ </description>
946+ </request>
947+
948+ <event name="buttons">
949+ <description summary="buttons announced">
950+ Sent on zwp_tablet_pad_group_v2 initialization to announce the available
951+ buttons in the group. Button indices start at 0, a button may only be
952+ in one group at a time.
953+
954+ This event is first sent in the initial burst of events before the
955+ zwp_tablet_pad_group_v2.done event.
956+
957+ Some buttons are reserved by the compositor. These buttons may not be
958+ assigned to any zwp_tablet_pad_group_v2. Compositors may broadcast this
959+ event in the case of changes to the mapping of these reserved buttons.
960+ If the compositor happens to reserve all buttons in a group, this event
961+ will be sent with an empty array.
962+ </description>
963+ <arg name="buttons" type="array" summary="buttons in this group"/>
964+ </event>
965+
966+ <event name="ring">
967+ <description summary="ring announced">
968+ Sent on zwp_tablet_pad_group_v2 initialization to announce available rings.
969+ One event is sent for each ring available on this pad group.
970+
971+ This event is sent in the initial burst of events before the
972+ zwp_tablet_pad_group_v2.done event.
973+ </description>
974+ <arg name="ring" type="new_id" interface="zwp_tablet_pad_ring_v2"/>
975+ </event>
976+
977+ <event name="strip">
978+ <description summary="strip announced">
979+ Sent on zwp_tablet_pad_v2 initialization to announce available strips.
980+ One event is sent for each strip available on this pad group.
981+
982+ This event is sent in the initial burst of events before the
983+ zwp_tablet_pad_group_v2.done event.
984+ </description>
985+ <arg name="strip" type="new_id" interface="zwp_tablet_pad_strip_v2"/>
986+ </event>
987+
988+ <event name="modes">
989+ <description summary="mode-switch ability announced">
990+ Sent on zwp_tablet_pad_group_v2 initialization to announce that the pad
991+ group may switch between modes. A client may use a mode to store a
992+ specific configuration for buttons, rings and strips and use the
993+ zwp_tablet_pad_group_v2.mode_switch event to toggle between these
994+ configurations. Mode indices start at 0.
995+
996+ Switching modes is compositor-dependent. See the
997+ zwp_tablet_pad_group_v2.mode_switch event for more details.
998+
999+ This event is sent in the initial burst of events before the
1000+ zwp_tablet_pad_group_v2.done event. This event is only sent when
1001+ more than one mode is available.
1002+ </description>
1003+ <arg name="modes" type="uint" summary="the number of modes"/>
1004+ </event>
1005+
1006+ <event name="done">
1007+ <description summary="tablet group description events sequence complete">
1008+ This event is sent immediately to signal the end of the initial
1009+ burst of descriptive events. A client may consider the static
1010+ description of the tablet to be complete and finalize initialization
1011+ of the tablet group.
1012+ </description>
1013+ </event>
1014+
1015+ <event name="mode_switch">
1016+ <description summary="mode switch event">
1017+ Notification that the mode was switched.
1018+
1019+ A mode applies to all buttons, rings, strips and dials in a group
1020+ simultaneously, but a client is not required to assign different actions
1021+ for each mode. For example, a client may have mode-specific button
1022+ mappings but map the ring to vertical scrolling in all modes. Mode
1023+ indices start at 0.
1024+
1025+ Switching modes is compositor-dependent. The compositor may provide
1026+ visual cues to the user about the mode, e.g. by toggling LEDs on
1027+ the tablet device. Mode-switching may be software-controlled or
1028+ controlled by one or more physical buttons. For example, on a Wacom
1029+ Intuos Pro, the button inside the ring may be assigned to switch
1030+ between modes.
1031+
1032+ The compositor will also send this event after zwp_tablet_pad_v2.enter on
1033+ each group in order to notify of the current mode. Groups that only
1034+ feature one mode will use mode=0 when emitting this event.
1035+
1036+ If a button action in the new mode differs from the action in the
1037+ previous mode, the client should immediately issue a
1038+ zwp_tablet_pad_v2.set_feedback request for each changed button.
1039+
1040+ If a ring, strip or dial action in the new mode differs from the action
1041+ in the previous mode, the client should immediately issue a
1042+ zwp_tablet_ring_v2.set_feedback, zwp_tablet_strip_v2.set_feedback or
1043+ zwp_tablet_dial_v2.set_feedback request for each changed ring, strip or dial.
1044+ </description>
1045+ <arg name="time" type="uint" summary="the time of the event with millisecond granularity"/>
1046+ <arg name="serial" type="uint"/>
1047+ <arg name="mode" type="uint" summary="the new mode of the pad"/>
1048+ </event>
1049+
1050+ <!-- Version 2 additions -->
1051+
1052+ <event name="dial" since="2">
1053+ <description summary="dial announced">
1054+ Sent on zwp_tablet_pad_v2 initialization to announce available dials.
1055+ One event is sent for each dial available on this pad group.
1056+
1057+ This event is sent in the initial burst of events before the
1058+ zwp_tablet_pad_group_v2.done event.
1059+ </description>
1060+ <arg name="dial" type="new_id" interface="zwp_tablet_pad_dial_v2"/>
1061+ </event>
1062+ </interface>
1063+
1064+ <interface name="zwp_tablet_pad_v2" version="2">
1065+ <description summary="a set of buttons, rings, strips and dials">
1066+ A pad device is a set of buttons, rings, strips and dials
1067+ usually physically present on the tablet device itself. Some
1068+ exceptions exist where the pad device is physically detached, e.g. the
1069+ Wacom ExpressKey Remote.
1070+
1071+ Pad devices have no axes that control the cursor and are generally
1072+ auxiliary devices to the tool devices used on the tablet surface.
1073+
1074+ A pad device has a number of static characteristics, e.g. the number
1075+ of rings. These capabilities are sent in an event sequence after the
1076+ zwp_tablet_seat_v2.pad_added event before any actual events from this pad.
1077+ This initial event sequence is terminated by a zwp_tablet_pad_v2.done
1078+ event.
1079+
1080+ All pad features (buttons, rings, strips and dials) are logically divided into
1081+ groups and all pads have at least one group. The available groups are
1082+ notified through the zwp_tablet_pad_v2.group event; the compositor will
1083+ emit one event per group before emitting zwp_tablet_pad_v2.done.
1084+
1085+ Groups may have multiple modes. Modes allow clients to map multiple
1086+ actions to a single pad feature. Only one mode can be active per group,
1087+ although different groups may have different active modes.
1088+ </description>
1089+
1090+ <request name="set_feedback">
1091+ <description summary="set compositor feedback">
1092+ Requests the compositor to use the provided feedback string
1093+ associated with this button. This request should be issued immediately
1094+ after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
1095+ group is received, or whenever a button is mapped to a different
1096+ action. See zwp_tablet_pad_group_v2.mode_switch for more details.
1097+
1098+ Clients are encouraged to provide context-aware descriptions for
1099+ the actions associated with each button, and compositors may use
1100+ this information to offer visual feedback on the button layout
1101+ (e.g. on-screen displays).
1102+
1103+ Button indices start at 0. Setting the feedback string on a button
1104+ that is reserved by the compositor (i.e. not belonging to any
1105+ zwp_tablet_pad_group_v2) does not generate an error but the compositor
1106+ is free to ignore the request.
1107+
1108+ The provided string 'description' is a UTF-8 encoded string to be
1109+ associated with this ring, and is considered user-visible; general
1110+ internationalization rules apply.
1111+
1112+ The serial argument will be that of the last
1113+ zwp_tablet_pad_group_v2.mode_switch event received for the group of this
1114+ button. Requests providing other serials than the most recent one will
1115+ be ignored.
1116+ </description>
1117+ <arg name="button" type="uint" summary="button index"/>
1118+ <arg name="description" type="string" summary="button description"/>
1119+ <arg name="serial" type="uint" summary="serial of the mode switch event"/>
1120+ </request>
1121+
1122+ <request name="destroy" type="destructor">
1123+ <description summary="destroy the pad object">
1124+ Destroy the zwp_tablet_pad_v2 object. Objects created from this object
1125+ are unaffected and should be destroyed separately.
1126+ </description>
1127+ </request>
1128+
1129+ <event name="group">
1130+ <description summary="group announced">
1131+ Sent on zwp_tablet_pad_v2 initialization to announce available groups.
1132+ One event is sent for each pad group available.
1133+
1134+ This event is sent in the initial burst of events before the
1135+ zwp_tablet_pad_v2.done event. At least one group will be announced.
1136+ </description>
1137+ <arg name="pad_group" type="new_id" interface="zwp_tablet_pad_group_v2"/>
1138+ </event>
1139+
1140+ <event name="path">
1141+ <description summary="path to the device">
1142+ A system-specific device path that indicates which device is behind
1143+ this zwp_tablet_pad_v2. This information may be used to gather additional
1144+ information about the device, e.g. through libwacom.
1145+
1146+ The format of the path is unspecified, it may be a device node, a
1147+ sysfs path, or some other identifier. It is up to the client to
1148+ identify the string provided.
1149+
1150+ This event is sent in the initial burst of events before the
1151+ zwp_tablet_pad_v2.done event.
1152+ </description>
1153+ <arg name="path" type="string" summary="path to local device"/>
1154+ </event>
1155+
1156+ <event name="buttons">
1157+ <description summary="buttons announced">
1158+ Sent on zwp_tablet_pad_v2 initialization to announce the available
1159+ buttons.
1160+
1161+ This event is sent in the initial burst of events before the
1162+ zwp_tablet_pad_v2.done event. This event is only sent when at least one
1163+ button is available.
1164+ </description>
1165+ <arg name="buttons" type="uint" summary="the number of buttons"/>
1166+ </event>
1167+
1168+ <event name="done">
1169+ <description summary="pad description event sequence complete">
1170+ This event signals the end of the initial burst of descriptive
1171+ events. A client may consider the static description of the pad to
1172+ be complete and finalize initialization of the pad.
1173+ </description>
1174+ </event>
1175+
1176+ <enum name="button_state">
1177+ <description summary="physical button state">
1178+ Describes the physical state of a button that caused the button
1179+ event.
1180+ </description>
1181+ <entry name="released" value="0" summary="the button is not pressed"/>
1182+ <entry name="pressed" value="1" summary="the button is pressed"/>
1183+ </enum>
1184+
1185+ <event name="button">
1186+ <description summary="physical button state">
1187+ Sent whenever the physical state of a button changes.
1188+ </description>
1189+ <arg name="time" type="uint" summary="the time of the event with millisecond granularity"/>
1190+ <arg name="button" type="uint" summary="the index of the button that changed state"/>
1191+ <arg name="state" type="uint" enum="button_state"/>
1192+ </event>
1193+
1194+ <event name="enter">
1195+ <description summary="enter event">
1196+ Notification that this pad is focused on the specified surface.
1197+ </description>
1198+ <arg name="serial" type="uint" summary="serial number of the enter event"/>
1199+ <arg name="tablet" type="object" interface="zwp_tablet_v2" summary="the tablet the pad is attached to"/>
1200+ <arg name="surface" type="object" interface="wl_surface" summary="surface the pad is focused on"/>
1201+ </event>
1202+
1203+ <event name="leave">
1204+ <description summary="leave event">
1205+ Notification that this pad is no longer focused on the specified
1206+ surface.
1207+ </description>
1208+ <arg name="serial" type="uint" summary="serial number of the leave event"/>
1209+ <arg name="surface" type="object" interface="wl_surface" summary="surface the pad is no longer focused on"/>
1210+ </event>
1211+
1212+ <event name="removed">
1213+ <description summary="pad removed event">
1214+ Sent when the pad has been removed from the system. When a tablet
1215+ is removed its pad(s) will be removed too.
1216+
1217+ When this event is received, the client must destroy all rings, strips
1218+ and groups that were offered by this pad, and issue zwp_tablet_pad_v2.destroy
1219+ the pad itself.
1220+ </description>
1221+ </event>
1222+ </interface>
1223+
1224+ <interface name="zwp_tablet_pad_dial_v2" version="2">
1225+ <description summary="pad dial">
1226+ A rotary control, e.g. a dial or a wheel.
1227+
1228+ Events on a dial are logically grouped by the zwp_tablet_pad_dial_v2.frame
1229+ event.
1230+ </description>
1231+
1232+ <request name="set_feedback">
1233+ <description summary="set compositor feedback">
1234+ Requests the compositor to use the provided feedback string
1235+ associated with this dial. This request should be issued immediately
1236+ after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
1237+ group is received, or whenever the dial is mapped to a different
1238+ action. See zwp_tablet_pad_group_v2.mode_switch for more details.
1239+
1240+ Clients are encouraged to provide context-aware descriptions for
1241+ the actions associated with the dial, and compositors may use this
1242+ information to offer visual feedback about the button layout
1243+ (eg. on-screen displays).
1244+
1245+ The provided string 'description' is a UTF-8 encoded string to be
1246+ associated with this ring, and is considered user-visible; general
1247+ internationalization rules apply.
1248+
1249+ The serial argument will be that of the last
1250+ zwp_tablet_pad_group_v2.mode_switch event received for the group of this
1251+ dial. Requests providing other serials than the most recent one will be
1252+ ignored.
1253+ </description>
1254+ <arg name="description" type="string" summary="dial description"/>
1255+ <arg name="serial" type="uint" summary="serial of the mode switch event"/>
1256+ </request>
1257+
1258+ <request name="destroy" type="destructor">
1259+ <description summary="destroy the dial object">
1260+ This destroys the client's resource for this dial object.
1261+ </description>
1262+ </request>
1263+
1264+ <event name="delta">
1265+ <description summary="delta movement">
1266+ Sent whenever the position on a dial changes.
1267+
1268+ This event carries the wheel delta as multiples or fractions
1269+ of 120 with each multiple of 120 representing one logical wheel detent.
1270+ For example, an axis_value120 of 30 is one quarter of
1271+ a logical wheel step in the positive direction, a value120 of
1272+ -240 are two logical wheel steps in the negative direction within the
1273+ same hardware event. See the wl_pointer.axis_value120 for more details.
1274+
1275+ The value120 must not be zero.
1276+ </description>
1277+ <arg name="value120" type="int" summary="rotation distance as fraction of 120"/>
1278+ </event>
1279+
1280+ <event name="frame">
1281+ <description summary="end of a dial event sequence">
1282+ Indicates the end of a set of events that represent one logical
1283+ hardware dial event. A client is expected to accumulate the data
1284+ in all events within the frame before proceeding.
1285+
1286+ All zwp_tablet_pad_dial_v2 events before a zwp_tablet_pad_dial_v2.frame event belong
1287+ logically together.
1288+
1289+ A zwp_tablet_pad_dial_v2.frame event is sent for every logical event
1290+ group, even if the group only contains a single zwp_tablet_pad_dial_v2
1291+ event. Specifically, a client may get a sequence: delta, frame,
1292+ delta, frame, etc.
1293+ </description>
1294+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
1295+ </event>
1296+ </interface>
1297+</protocol>
A protocol/tablet/tablet-v2_generated.go +2302 -0 large diff (2302 lines changed): collapsed
load diff

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 8

↑↓ moveenter openesc close