cursor shape manager

This global offers an alternative, optional way to set cursor images. This new way uses enumerated cursors instead of a wl_surface like wl_pointer.set_cursor does.

Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.

destroy()
destroy the manager

Destroy the cursor shape manager.

manage the cursor shape of a pointer device

Obtain a wp_cursor_shape_device_v1 for a wl_pointer object.

manage the cursor shape of a tablet tool device

Obtain a wp_cursor_shape_device_v1 for a zwp_tablet_tool_v2 object.


cursor shape for a device

This interface allows clients to set the cursor shape.

destroy()
destroy the cursor shape device

Destroy the cursor shape device.

The device cursor shape remains unchanged.

Argument
Type
Description
serialuint
serial number of the enter event
shapeuint<wp_cursor_shape_device_v1.shape>
set device cursor to the shape

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.

Argument
Value
Description
default1
default cursor
context_menu2
a context menu is available for the object under the cursor
help3
help is available for the object under the cursor
pointer4
pointer that indicates a link or another interactive element
progress5
progress indicator
wait6
program is busy, user should wait
cell7
a cell or set of cells may be selected
crosshair8
simple crosshair
text9
text may be selected
vertical_text10
vertical text may be selected
alias11
drag-and-drop: alias of/shortcut to something is to be created
copy12
drag-and-drop: something is to be copied
move13
drag-and-drop: something is to be moved
no_drop14
drag-and-drop: the dragged item cannot be dropped at the current cursor location
not_allowed15
drag-and-drop: the requested action will not be carried out
grab16
drag-and-drop: something can be grabbed
grabbing17
drag-and-drop: something is being grabbed
e_resize18
resizing: the east border is to be moved
n_resize19
resizing: the north border is to be moved
ne_resize20
resizing: the north-east corner is to be moved
nw_resize21
resizing: the north-west corner is to be moved
s_resize22
resizing: the south border is to be moved
se_resize23
resizing: the south-east corner is to be moved
sw_resize24
resizing: the south-west corner is to be moved
w_resize25
resizing: the west border is to be moved
ew_resize26
resizing: the east and west borders are to be moved
ns_resize27
resizing: the north and south borders are to be moved
nesw_resize28
resizing: the north-east and south-west corners are to be moved
nwse_resize29
resizing: the north-west and south-east corners are to be moved
col_resize30
resizing: that the item/column can be resized horizontally
row_resize31
resizing: that the item/row can be resized vertically
all_scroll32
something can be scrolled in any direction
zoom_in33
something can be zoomed in
zoom_out34
something can be zoomed out
cursor shapes

This enum describes cursor shapes.

The names are taken from the CSS W3C specification: https://w3c.github.io/csswg-drafts/css-ui/#cursor

error { invalid_shape } 
Argument
Value
Description
invalid_shape1
the specified shape value is invalid

Compositor Support

Mutter
Mutter
46
KWin
KWin
6.1
Sway
Sway
1.9
COSMIC
COSMIC
1.0.0
Hyprland
Hyprland
0.42.0
niri
0.1.8
Weston
Weston
13
Mir
Mir
2.17
GameScope
GameScope
3.14.22
wp_cursor_shape_manager_v1
x
1
1
x
1
1
x
x
x

Copyright 2018 The Chromium Authors Copyright 2023 Simon Ser

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.