summaryrefslogtreecommitdiff
path: root/cursor-shape-v1-protocol.h
diff options
context:
space:
mode:
authorpants <niklasjo2004@gmail.com>2026-09-21 14:16:41 -0700
committerpants <niklasjo2004@gmail.com>2026-09-21 14:16:41 -0700
commitf0195bf50445b32f6b63b83bf3c8dc050befdb89 (patch)
treeed3ce0a516799b2dac609a292d6ade061aa8683a /cursor-shape-v1-protocol.h
Diffstat (limited to 'cursor-shape-v1-protocol.h')
-rw-r--r--cursor-shape-v1-protocol.h507
1 files changed, 507 insertions, 0 deletions
diff --git a/cursor-shape-v1-protocol.h b/cursor-shape-v1-protocol.h
new file mode 100644
index 0000000..08714b3
--- /dev/null
+++ b/cursor-shape-v1-protocol.h
@@ -0,0 +1,507 @@
+/* Generated by wayland-scanner 1.25.0 */
+
+#ifndef CURSOR_SHAPE_V1_SERVER_PROTOCOL_H
+#define CURSOR_SHAPE_V1_SERVER_PROTOCOL_H
+
+#include <stdint.h>
+#include <stddef.h>
+#include "wayland-server.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct wl_client;
+struct wl_resource;
+
+/**
+ * @page page_cursor_shape_v1 The cursor_shape_v1 protocol
+ * @section page_ifaces_cursor_shape_v1 Interfaces
+ * - @subpage page_iface_wp_cursor_shape_manager_v1 - cursor shape manager
+ * - @subpage page_iface_wp_cursor_shape_device_v1 - cursor shape for a device
+ * @section page_copyright_cursor_shape_v1 Copyright
+ * <pre>
+ *
+ * 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.
+ * </pre>
+ */
+struct wl_pointer;
+struct wp_cursor_shape_device_v1;
+struct wp_cursor_shape_manager_v1;
+struct zwp_tablet_tool_v2;
+
+#ifndef WP_CURSOR_SHAPE_MANAGER_V1_INTERFACE
+#define WP_CURSOR_SHAPE_MANAGER_V1_INTERFACE
+/**
+ * @page page_iface_wp_cursor_shape_manager_v1 wp_cursor_shape_manager_v1
+ * @section page_iface_wp_cursor_shape_manager_v1_desc Description
+ *
+ * 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.
+ * @section page_iface_wp_cursor_shape_manager_v1_api API
+ * See @ref iface_wp_cursor_shape_manager_v1.
+ */
+/**
+ * @defgroup iface_wp_cursor_shape_manager_v1 The wp_cursor_shape_manager_v1 interface
+ *
+ * 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.
+ */
+extern const struct wl_interface wp_cursor_shape_manager_v1_interface;
+#endif
+#ifndef WP_CURSOR_SHAPE_DEVICE_V1_INTERFACE
+#define WP_CURSOR_SHAPE_DEVICE_V1_INTERFACE
+/**
+ * @page page_iface_wp_cursor_shape_device_v1 wp_cursor_shape_device_v1
+ * @section page_iface_wp_cursor_shape_device_v1_desc Description
+ *
+ * This interface allows clients to set the cursor shape.
+ * @section page_iface_wp_cursor_shape_device_v1_api API
+ * See @ref iface_wp_cursor_shape_device_v1.
+ */
+/**
+ * @defgroup iface_wp_cursor_shape_device_v1 The wp_cursor_shape_device_v1 interface
+ *
+ * This interface allows clients to set the cursor shape.
+ */
+extern const struct wl_interface wp_cursor_shape_device_v1_interface;
+#endif
+
+/**
+ * @ingroup iface_wp_cursor_shape_manager_v1
+ * @struct wp_cursor_shape_manager_v1_interface
+ */
+struct wp_cursor_shape_manager_v1_interface {
+ /**
+ * destroy the manager
+ *
+ * Destroy the cursor shape manager.
+ */
+ void (*destroy)(struct wl_client *client,
+ struct wl_resource *resource);
+ /**
+ * manage the cursor shape of a pointer device
+ *
+ * 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.
+ */
+ void (*get_pointer)(struct wl_client *client,
+ struct wl_resource *resource,
+ uint32_t cursor_shape_device,
+ struct wl_resource *pointer);
+ /**
+ * manage the cursor shape of a tablet tool device
+ *
+ * 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.
+ */
+ void (*get_tablet_tool_v2)(struct wl_client *client,
+ struct wl_resource *resource,
+ uint32_t cursor_shape_device,
+ struct wl_resource *tablet_tool);
+};
+
+
+/**
+ * @ingroup iface_wp_cursor_shape_manager_v1
+ */
+#define WP_CURSOR_SHAPE_MANAGER_V1_DESTROY_SINCE_VERSION 1
+/**
+ * @ingroup iface_wp_cursor_shape_manager_v1
+ */
+#define WP_CURSOR_SHAPE_MANAGER_V1_GET_POINTER_SINCE_VERSION 1
+/**
+ * @ingroup iface_wp_cursor_shape_manager_v1
+ */
+#define WP_CURSOR_SHAPE_MANAGER_V1_GET_TABLET_TOOL_V2_SINCE_VERSION 1
+
+#ifndef WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ENUM
+#define WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ENUM
+/**
+ * @ingroup iface_wp_cursor_shape_device_v1
+ * 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
+ * with a few additions.
+ *
+ * Note that there are some groups of cursor shapes that are related:
+ * The first group is drag-and-drop cursors which are used to indicate
+ * the selected action during dnd operations. The second group is resize
+ * cursors which are used to indicate resizing and moving possibilities
+ * on window borders. It is recommended that the shapes in these groups
+ * should use visually compatible images and metaphors.
+ */
+enum wp_cursor_shape_device_v1_shape {
+ /**
+ * default cursor
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_DEFAULT = 1,
+ /**
+ * a context menu is available for the object under the cursor
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_CONTEXT_MENU = 2,
+ /**
+ * help is available for the object under the cursor
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_HELP = 3,
+ /**
+ * pointer that indicates a link or another interactive element
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_POINTER = 4,
+ /**
+ * progress indicator
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_PROGRESS = 5,
+ /**
+ * program is busy, user should wait
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_WAIT = 6,
+ /**
+ * a cell or set of cells may be selected
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_CELL = 7,
+ /**
+ * simple crosshair
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_CROSSHAIR = 8,
+ /**
+ * text may be selected
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_TEXT = 9,
+ /**
+ * vertical text may be selected
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_VERTICAL_TEXT = 10,
+ /**
+ * drag-and-drop: alias of/shortcut to something is to be created
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ALIAS = 11,
+ /**
+ * drag-and-drop: something is to be copied
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_COPY = 12,
+ /**
+ * drag-and-drop: something is to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_MOVE = 13,
+ /**
+ * drag-and-drop: the dragged item cannot be dropped at the current cursor location
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NO_DROP = 14,
+ /**
+ * drag-and-drop: the requested action will not be carried out
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NOT_ALLOWED = 15,
+ /**
+ * drag-and-drop: something can be grabbed
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_GRAB = 16,
+ /**
+ * drag-and-drop: something is being grabbed
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_GRABBING = 17,
+ /**
+ * resizing: the east border is to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_E_RESIZE = 18,
+ /**
+ * resizing: the north border is to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_N_RESIZE = 19,
+ /**
+ * resizing: the north-east corner is to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NE_RESIZE = 20,
+ /**
+ * resizing: the north-west corner is to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NW_RESIZE = 21,
+ /**
+ * resizing: the south border is to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_S_RESIZE = 22,
+ /**
+ * resizing: the south-east corner is to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_SE_RESIZE = 23,
+ /**
+ * resizing: the south-west corner is to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_SW_RESIZE = 24,
+ /**
+ * resizing: the west border is to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_W_RESIZE = 25,
+ /**
+ * resizing: the east and west borders are to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_EW_RESIZE = 26,
+ /**
+ * resizing: the north and south borders are to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NS_RESIZE = 27,
+ /**
+ * resizing: the north-east and south-west corners are to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NESW_RESIZE = 28,
+ /**
+ * resizing: the north-west and south-east corners are to be moved
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NWSE_RESIZE = 29,
+ /**
+ * resizing: that the item/column can be resized horizontally
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_COL_RESIZE = 30,
+ /**
+ * resizing: that the item/row can be resized vertically
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ROW_RESIZE = 31,
+ /**
+ * something can be scrolled in any direction
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ALL_SCROLL = 32,
+ /**
+ * something can be zoomed in
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ZOOM_IN = 33,
+ /**
+ * something can be zoomed out
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ZOOM_OUT = 34,
+ /**
+ * drag-and-drop: the user will select which action will be carried out (non-css value)
+ * @since 2
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_DND_ASK = 35,
+ /**
+ * resizing: something can be moved or resized in any direction (non-css value)
+ * @since 2
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ALL_RESIZE = 36,
+};
+/**
+ * @ingroup iface_wp_cursor_shape_device_v1
+ */
+#define WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_DND_ASK_SINCE_VERSION 2
+/**
+ * @ingroup iface_wp_cursor_shape_device_v1
+ */
+#define WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ALL_RESIZE_SINCE_VERSION 2
+#endif /* WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ENUM */
+
+#ifndef WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ENUM_IS_VALID
+#define WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ENUM_IS_VALID
+/**
+ * @ingroup iface_wp_cursor_shape_device_v1
+ * Validate a wp_cursor_shape_device_v1 shape value.
+ *
+ * @return true on success, false on error.
+ * @ref wp_cursor_shape_device_v1_shape
+ */
+static inline bool
+wp_cursor_shape_device_v1_shape_is_valid(uint32_t value, uint32_t version) {
+ switch (value) {
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_DEFAULT:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_CONTEXT_MENU:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_HELP:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_POINTER:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_PROGRESS:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_WAIT:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_CELL:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_CROSSHAIR:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_TEXT:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_VERTICAL_TEXT:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ALIAS:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_COPY:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_MOVE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NO_DROP:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NOT_ALLOWED:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_GRAB:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_GRABBING:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_E_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_N_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NE_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NW_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_S_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_SE_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_SW_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_W_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_EW_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NS_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NESW_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_NWSE_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_COL_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ROW_RESIZE:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ALL_SCROLL:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ZOOM_IN:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ZOOM_OUT:
+ return version >= 1;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_DND_ASK:
+ return version >= 2;
+ case WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ALL_RESIZE:
+ return version >= 2;
+ default:
+ return false;
+ }
+}
+#endif /* WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_ENUM_IS_VALID */
+
+#ifndef WP_CURSOR_SHAPE_DEVICE_V1_ERROR_ENUM
+#define WP_CURSOR_SHAPE_DEVICE_V1_ERROR_ENUM
+enum wp_cursor_shape_device_v1_error {
+ /**
+ * the specified shape value is invalid
+ */
+ WP_CURSOR_SHAPE_DEVICE_V1_ERROR_INVALID_SHAPE = 1,
+};
+#endif /* WP_CURSOR_SHAPE_DEVICE_V1_ERROR_ENUM */
+
+#ifndef WP_CURSOR_SHAPE_DEVICE_V1_ERROR_ENUM_IS_VALID
+#define WP_CURSOR_SHAPE_DEVICE_V1_ERROR_ENUM_IS_VALID
+/**
+ * @ingroup iface_wp_cursor_shape_device_v1
+ * Validate a wp_cursor_shape_device_v1 error value.
+ *
+ * @return true on success, false on error.
+ * @ref wp_cursor_shape_device_v1_error
+ */
+static inline bool
+wp_cursor_shape_device_v1_error_is_valid(uint32_t value, uint32_t version) {
+ switch (value) {
+ case WP_CURSOR_SHAPE_DEVICE_V1_ERROR_INVALID_SHAPE:
+ return version >= 1;
+ default:
+ return false;
+ }
+}
+#endif /* WP_CURSOR_SHAPE_DEVICE_V1_ERROR_ENUM_IS_VALID */
+
+/**
+ * @ingroup iface_wp_cursor_shape_device_v1
+ * @struct wp_cursor_shape_device_v1_interface
+ */
+struct wp_cursor_shape_device_v1_interface {
+ /**
+ * destroy the cursor shape device
+ *
+ * Destroy the cursor shape device.
+ *
+ * The device cursor shape remains unchanged.
+ */
+ void (*destroy)(struct wl_client *client,
+ struct wl_resource *resource);
+ /**
+ * 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.
+ * @param serial serial number of the enter event
+ */
+ void (*set_shape)(struct wl_client *client,
+ struct wl_resource *resource,
+ uint32_t serial,
+ uint32_t shape);
+};
+
+
+/**
+ * @ingroup iface_wp_cursor_shape_device_v1
+ */
+#define WP_CURSOR_SHAPE_DEVICE_V1_DESTROY_SINCE_VERSION 1
+/**
+ * @ingroup iface_wp_cursor_shape_device_v1
+ */
+#define WP_CURSOR_SHAPE_DEVICE_V1_SET_SHAPE_SINCE_VERSION 1
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif