wayland::serv...blet_tool_v1_t(3)

📦

version 1.0.1 · 11 versions

💖 NAME 💖

okay bestie, meet wayland::server::zwp_tablet_tool_v1_t — she’s a physical tablet tool 💅 and she lives in Wayland++. no cap, this is the server-side wrapper for one very real pen/stylus/tablet-tool vibe.

✨ SYNOPSIS ✨

#include <wayland-server-protocol-unstable.hpp>

🫶 Public Member Functions

std::function< void(uint32_t, surface_t, int32_t, int32_t)> & on_set_cursor () — set the tablet tool's surface 🖼️
std::function< void()> & on_destroy () — destroy the tool object 💥
void type (zwp_tablet_tool_v1_type const &tool_type, bool post=true) — tool type 🖊️
void hardware_serial (uint32_t hardware_serial_hi, uint32_t hardware_serial_lo, bool post=true) — unique hardware serial number of the tool 🔢
void hardware_id_wacom (uint32_t hardware_id_hi, uint32_t hardware_id_lo, bool post=true) — hardware id notification in Wacom's format 🟡
void capability (zwp_tablet_tool_v1_capability const &capability, bool post=true) — tool capability notification 🛠️
void done (bool post=true) — tool description events sequence complete ✅
void removed (bool post=true) — tool removed 👋
void proximity_in (uint32_t serial, zwp_tablet_v1_t const &tablet, surface_t const &surface, bool post=true) — proximity in event 📍
void proximity_out (bool post=true) — proximity out event 🚪
void down (uint32_t serial, bool post=true) — tablet tool is making contact 👇
void up (bool post=true) — tablet tool is no longer making contact ☝️
void motion (double x, double y, bool post=true) — motion event 🌀
void pressure (uint32_t pressure, bool post=true) — pressure change event 🫳
void distance (uint32_t distance, bool post=true) — distance change event 📏
void tilt (int32_t tilt_x, int32_t tilt_y, bool post=true) — tilt change event 📐
void rotation (int32_t degrees, bool post=true) — z-rotation change event 🔄
void slider (int32_t position, bool post=true) — Slider position change event. 🎚️
void wheel (int32_t degrees, int32_t clicks, bool post=true) — Wheel delta event. 🎡
void button (uint32_t serial, uint32_t button, zwp_tablet_tool_v1_button_state const &state, bool post=true) — button event 🔘
void frame (uint32_t time, bool post=true) — frame event 🖼️
void post_role (std::string const &msg) — Post error: given wl_surface has another role. 🚨
bool proxy_has_object () const — Check whether this wrapper actually wraps an object. 🔍
void post_no_memory () const — no description given in the original, just the signature (iykyk) 💀
uint32_t get_id () const — signature only in the list; details down in Member Function Documentation 🪪
client_t get_client () const — signature only in the list; details down in Member Function Documentation 👥
unsigned int get_version () const — signature only in the list; details down in Member Function Documentation 🔖
std::string get_class () — signature only in the list; details down in Member Function Documentation 🏷️

🎀 Static Public Attributes

static constexpr std::uint32_t type_since_version = 1 — minimum protocol version required for the type function.
static constexpr std::uint32_t hardware_serial_since_version = 1 — minimum protocol version required for the hardware_serial function.
static constexpr std::uint32_t hardware_id_wacom_since_version = 1 — minimum protocol version required for the hardware_id_wacom function.
static constexpr std::uint32_t capability_since_version = 1 — minimum protocol version required for the capability function.
static constexpr std::uint32_t done_since_version = 1 — minimum protocol version required for the done function.
static constexpr std::uint32_t removed_since_version = 1 — minimum protocol version required for the removed function.
static constexpr std::uint32_t proximity_in_since_version = 1 — minimum protocol version required for the proximity_in function.
static constexpr std::uint32_t proximity_out_since_version = 1 — minimum protocol version required for the proximity_out function.
static constexpr std::uint32_t down_since_version = 1 — minimum protocol version required for the down function.
static constexpr std::uint32_t up_since_version = 1 — minimum protocol version required for the up function.
static constexpr std::uint32_t motion_since_version = 1 — minimum protocol version required for the motion function.
static constexpr std::uint32_t pressure_since_version = 1 — minimum protocol version required for the pressure function.
static constexpr std::uint32_t distance_since_version = 1 — minimum protocol version required for the distance function.
static constexpr std::uint32_t tilt_since_version = 1 — minimum protocol version required for the tilt function.
static constexpr std::uint32_t rotation_since_version = 1 — minimum protocol version required for the rotation function.
static constexpr std::uint32_t slider_since_version = 1 — minimum protocol version required for the slider function.
static constexpr std::uint32_t wheel_since_version = 1 — minimum protocol version required for the wheel function.
static constexpr std::uint32_t button_since_version = 1 — minimum protocol version required for the button function.
static constexpr std::uint32_t frame_since_version = 1 — minimum protocol version required for the frame function.

🌸 Detailed Description 🌸

ok so picture this: an object that represents a physical tablet tool that has been, or is currently in use with a tablet in this seat. Each wp_tablet_tool object stays valid until the client destroys it; the compositor reuses the wp_tablet_tool object to indicate that the object's respective physical tool has come into proximity of a tablet again. 🔁

A wp_tablet_tool object's relation to a physical tool depends on the tablet's ability to report serial numbers. If the tablet supports this capability, then the object represents a specific physical tool and can be identified even when used on multiple tablets. 🫶

A tablet tool has a number of static characteristics, e.g. tool type, hardware_serial and capabilities. These capabilities are sent in an event sequence after the wp_tablet_seat.tool_added event before any actual events from this tool. This initial event sequence is terminated by a wp_tablet_tool.done event. ✨

Tablet tool events are grouped by wp_tablet_tool.frame events. Any events received before a wp_tablet_tool.frame event should be considered part of the same hardware state change. 🧩

🧾 Definition at line 4135 of file wayland-server-protocol-unstable.hpp.

🔥 Member Function Documentation 🔥

🖲️ `zwp_tablet_tool_v1_t::button`

void zwp_tablet_tool_v1_t::button (uint32_t serial, uint32_t button,
    zwp_tablet_tool_v1_button_state const & state, bool post = true)

button event — yes bestie, the actual clicky moment 🔘

serial — no description in the original, but she's there 💅
button — The button whose state has changed
state — Whether the button was pressed or released

Sent whenever a button on the tool is pressed or released. 🫡

If a button is held down when the tool moves in or out of proximity, button events are generated by the compositor. See wp_tablet_tool.proximity_in and wp_tablet_tool.proximity_out for details. 👀

🧾 Definition at line 6274 of file wayland-server-protocol-unstable.cpp.

🛠️ `zwp_tablet_tool_v1_t::capability`

void zwp_tablet_tool_v1_t::capability (zwp_tablet_tool_v1_capability const &
    capability, bool post = true)

tool capability notification 🛠️

capability — the capability

This event notifies the client of any capabilities of this tool, beyond the main set of x/y axes and tip up/down detection. 🎯

One event is sent for each extra capability available on this tool. 🔢

This event is sent in the initial burst of events before the wp_tablet_tool.done event. ✨

🧾 Definition at line 6204 of file wayland-server-protocol-unstable.cpp.

📏 `zwp_tablet_tool_v1_t::distance`

void zwp_tablet_tool_v1_t::distance (uint32_t distance, bool post = true)

distance change event 📏

distance — The current distance value

Sent whenever the distance axis on a tool changes. The value of this event is normalized to a value between 0 and 65535. 🔢

💡 Note that distance may be nonzero even when a tool is not in logical contact. See the down and up events for more details.

🧾 Definition at line 6249 of file wayland-server-protocol-unstable.cpp.

✅ `zwp_tablet_tool_v1_t::done`

void zwp_tablet_tool_v1_t::done (bool post = true)

tool description events sequence complete — the “okay I’m done describing myself” event ✅

This event signals the end of the initial burst of descriptive events. A client may consider the static description of the tool to be complete and finalize initialization of the tool. 🫶

🧾 Definition at line 6209 of file wayland-server-protocol-unstable.cpp.

👇 `zwp_tablet_tool_v1_t::down`

void zwp_tablet_tool_v1_t::down (uint32_t serial, bool post = true)

tablet tool is making contact 👇

serial — no description in the original, but she's there 💅

Sent whenever the tablet tool comes in contact with the surface of the tablet. 🫳

If the tool is already in contact with the tablet when entering the input region, the client owning said region will receive a wp_tablet.proximity_in event, followed by a wp_tablet.down event and a wp_tablet.frame event. 🧩

💡 Note that this event describes logical contact, not physical contact. On some devices, a compositor may not consider a tool in logical contact until a minimum physical pressure threshold is exceeded.

🧾 Definition at line 6229 of file wayland-server-protocol-unstable.cpp.

🖼️ `zwp_tablet_tool_v1_t::frame`

void zwp_tablet_tool_v1_t::frame (uint32_t time, bool post = true)

frame event 🖼️

time — The time of the event with millisecond granularity

Marks the end of a series of axis and/or button updates from the tablet. The Wayland protocol requires axis updates to be sent sequentially, however all events within a frame should be considered one hardware event. 🧩

🧾 Definition at line 6279 of file wayland-server-protocol-unstable.cpp.

🏷️ `wayland::server::resource_t::get_class`

std::string wayland::server::resource_t::get_class () [inherited]

Retrieve the interface name (class) of a resource object. 🏷️

Returns: Interface name of the resource object.

👥 `wayland::server::resource_t::get_client`

client_t wayland::server::resource_t::get_client () const [inherited]

Get the associated client 👥

Returns: the client that owns the resource.

🪪 `wayland::server::resource_t::get_id`

uint32_t wayland::server::resource_t::get_id () const [inherited]

Get the internal ID of the resource 🪪

Returns: the internal ID of the resource

🔖 `wayland::server::resource_t::get_version`

unsigned int wayland::server::resource_t::get_version () const [inherited]

Get interface version 🔖

Returns: Interface version this resource has been constructed with.

🟡 `zwp_tablet_tool_v1_t::hardware_id_wacom`

void zwp_tablet_tool_v1_t::hardware_id_wacom (uint32_t hardware_id_hi,
    uint32_t hardware_id_lo, bool post = true)

hardware id notification in Wacom's format 🟡

hardware_id_hi — the hardware id, most significant bits
hardware_id_lo — the hardware id, least significant bits

This event notifies the client of a hardware id available on this tool. 🫶

The hardware id is a device-specific 64-bit id that provides extra information about the tool in use, beyond the wl_tool.type enumeration. The format of the id is specific to tablets made by Wacom Inc. For example, the hardware id of a Wacom Grip Pen (a stylus) is 0x802. 🖊️

This event is sent in the initial burst of events before the wp_tablet_tool.done event. ✨

🧾 Definition at line 6199 of file wayland-server-protocol-unstable.cpp.

💾 `hardware_serial` — unique hardware serial number of the tool

   void zwp_tablet_tool_v1_t::hardware_serial (uint32_t hardware_serial_hi,
       uint32_t hardware_serial_lo, bool post = true)

okay so bestie, this one is giving “hi, I have a unique 64-bit serial number” energy. If the physical tool can be identified by a unique 64-bit serial number, this event notifies the client of that serial number. ✨

hardware_serial_hi — the unique serial number of the tool, most significant bits
hardware_serial_lo — the unique serial number of the tool, least significant bits

If multiple tablets are available in the same seat and the tool is uniquely identifiable by the serial number, that tool may move between tablets. 🦋

Otherwise, if the tool has no serial number and this event is missing, the tool is tied to the tablet it first comes into proximity with. Even if the physical tool is used on multiple tablets, separate wp_tablet_tool objects will be created, one per tablet. No cap.

This event is sent in the initial burst of events before the wp_tablet_tool.done event.

📍 Definition at line 6194 of file wayland-server-protocol-unstable.cpp.

🛸 `motion` — motion event

   void zwp_tablet_tool_v1_t::motion (double x, double y, bool post = true)

Sent whenever a tablet tool moves. literally the “it's moving” event.

x — surface-local x coordinate
y — surface-local y coordinate

📍 Definition at line 6239 of file wayland-server-protocol-unstable.cpp.

💥 `on_destroy` — destroy the tool object

   std::function< void()> & zwp_tablet_tool_v1_t::on_destroy ()

This destroys the client's resource for this tool object. bye-bye tool resource, you served 💅

📍 Definition at line 6183 of file wayland-server-protocol-unstable.cpp.

🎯 `on_set_cursor` — set the tablet tool's surface

   std::function< void(uint32_t, surface_t, int32_t, int32_t)> &
       zwp_tablet_tool_v1_t::on_set_cursor ()

Sets the surface of the cursor used for this tool on the given tablet. This request only takes effect if the tool is in proximity of one of the requesting client's surfaces or the surface parameter is the current pointer surface. If there was a previous surface set with this request, it is replaced. If surface is NULL, the cursor image is hidden. 🙈

serial — serial of the enter event
surface — the surface (yep, the original leaves it at that 🫶)
hotspot_x — surface-local x coordinate
hotspot_y — surface-local y coordinate

The parameters hotspot_x and hotspot_y define the position of the pointer surface relative to the pointer location. Its top-left corner is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the coordinates of the pointer location, in surface-local coordinates. math girlies rise 😭

On surface.attach requests to the pointer surface, hotspot_x and hotspot_y are decremented by the x and y parameters passed to the request. Attach must be confirmed by wl_surface.commit as usual.

The hotspot can also be updated by passing the currently set pointer surface to this request with new values for hotspot_x and hotspot_y.

⚠️ The current and pending input regions of the wl_surface are cleared, and wl_surface.set_input_region is ignored until the wl_surface is no longer used as the cursor. When the use as a cursor ends, the current and pending input regions become undefined, and the wl_surface is unmapped. that's a whole lot, bestie, read it twice 💀

This request gives the surface the role of a cursor. The role assigned by this request is the same as assigned by wl_pointer.set_cursor, meaning the same surface can be used both as a wl_pointer cursor and a wp_tablet cursor. If the surface already has another role, it raises a protocol error. The surface may be used on multiple tablets and across multiple seats.

📍 Definition at line 6177 of file wayland-server-protocol-unstable.cpp.

🧬 `post_no_memory` — inherited from `wayland::server::resource_t`

   void wayland::server::resource_t::post_no_memory () const [inherited]

Post "not enough memory" error to the client. If the compositor has not enough memory to fulfill a certain request of the client, this function can be called to notify the client of this circumstance. 🫠

🚫 `post_role` — post error: given `wl_surface` has another role

   void zwp_tablet_tool_v1_t::post_role (std::string const & msg)

Post error: given wl_surface has another role. yep, that's the whole vibe. role conflict = not slay.

📍 Definition at line 6284 of file wayland-server-protocol-unstable.cpp.

🌡️ `pressure` — pressure change event

   void zwp_tablet_tool_v1_t::pressure (uint32_t pressure, bool post = true)

Sent whenever the pressure axis on a tool changes. The value of this event is normalized to a value between 0 and 65535.

pressure — The current pressure value

👀 Note that pressure may be nonzero even when a tool is not in logical contact. See the down and up events for more details. don't let the numbers lie to you, bestie.

📍 Definition at line 6244 of file wayland-server-protocol-unstable.cpp.

🫧 `proximity_in` — proximity in event

   void zwp_tablet_tool_v1_t::proximity_in (uint32_t serial, zwp_tablet_v1_t
       const & tablet, surface_t const & surface, bool post = true)

Notification that this tool is focused on a certain surface. ✨

serial — the serial (the original just says serial, iykyk)
tablet — The tablet the tool is in proximity of
surface — The current surface the tablet tool is over

This event can be received when the tool has moved from one surface to another, or when the tool has come back into proximity above the surface.

If any button is logically down when the tool comes into proximity, the respective button event is sent after the proximity_in event but within the same frame as the proximity_in event. group-chat order matters 💅

📍 Definition at line 6219 of file wayland-server-protocol-unstable.cpp.

🫥 `proximity_out` — proximity out event

   void zwp_tablet_tool_v1_t::proximity_out (bool post = true)

Notification that this tool has either left proximity, or is no longer focused on a certain surface.

When the tablet tool leaves proximity of the tablet, button release events are sent for each button that was held down at the time of leaving proximity. These events are sent before the proximity_out event but within the same wp_tablet.frame.

If the tool stays within proximity of the tablet, but the focus changes from one surface to another, a button release event may not be sent until the button is actually released or the tool leaves the proximity of the tablet.

📍 Definition at line 6224 of file wayland-server-protocol-unstable.cpp.

🧬 `proxy_has_object` — inherited from `wayland::server::resource_t`

   bool wayland::server::resource_t::proxy_has_object () const [inherited]

Check whether this wrapper actually wraps an object. the vibe check for wrappers 🦋

Returns: true if there is an underlying object, false if this wrapper is empty

🗑️ `removed` — tool removed

   void zwp_tablet_tool_v1_t::removed (bool post = true)

This event is sent when the tool is removed from the system and will send no further events. Should the physical tool come back into proximity later, a new wp_tablet_tool object will be created. RIP to that object, but a new one said “main character energy” 👑

It is compositor-dependent when a tool is removed. A compositor may remove a tool on proximity out, tablet removal or any other reason. A compositor may also keep a tool alive until shutdown. so… compositor's choice, bestie.

If the tool is currently in proximity, a proximity_out event will be sent before the removed event. See wp_tablet_tool.proximity_out for the handling of any buttons logically down.

⚠️ When this event is received, the client must wp_tablet_tool.destroy the object. no ghosting the cleanup, fr fr.

📍 Definition at line 6214 of file wayland-server-protocol-unstable.cpp.

🔄 `rotation` — z-rotation change event

   void zwp_tablet_tool_v1_t::rotation (int32_t degrees, bool post = true)

Sent whenever the z-rotation axis on the tool changes. The rotation value is in 0.01 of a degree clockwise from the tool's logical neutral position.

degrees — The current rotation of the Z axis

📍 Definition at line 6259 of file wayland-server-protocol-unstable.cpp.

🎚️ `slider` — slider position change event

   void zwp_tablet_tool_v1_t::slider (int32_t position, bool post = true)

Sent whenever the slider position on the tool changes. The value is normalized between -65535 and 65535, with 0 as the logical neutral position of the slider. 🎀

position — The current position of slider

The slider is available on e.g. the Wacom Airbrush tool. iconic hardware tbh.

📍 Definition at line 6264 of file wayland-server-protocol-unstable.cpp.

📐 `tilt` — tilt change event

   void zwp_tablet_tool_v1_t::tilt (int32_t tilt_x, int32_t tilt_y, bool post =
       true)

Sent whenever one or both of the tilt axes on a tool change. Each tilt value is in 0.01 of a degree, relative to the z-axis of the tablet. The angle is positive when the top of a tool tilts along the positive x or y axis. angles are giving geometry class but make it fashion ✨

tilt_x — The current value of the X tilt axis
tilt_y — The current value of the Y tilt axis

📍 Definition at line 6254 of file wayland-server-protocol-unstable.cpp.

🏷️ `type` — tool type

   void zwp_tablet_tool_v1_t::type (zwp_tablet_tool_v1_type const & tool_type,
       bool post = true)

The tool type is the high-level type of the tool and usually decides the interaction expected from this tool. highkey the tool's whole personality.

tool_type — the physical tool type

This event is sent in the initial burst of events before the wp_tablet_tool.done event.

📍 Definition at line 6189 of file wayland-server-protocol-unstable.cpp.

⬆️ `up` — tablet tool is no longer making contact

   void zwp_tablet_tool_v1_t::up (bool post = true)

Sent whenever the tablet tool stops making contact with the surface of the tablet, or when the tablet tool moves out of the input region and the compositor grab (if any) is dismissed.

If the tablet tool moves out of the input region while in contact with the surface of the tablet and the compositor does not have an ongoing grab on the surface, the client owning said region will receive a wp_tablet.up event, followed by a wp_tablet.proximity_out event and a wp_tablet.frame event. If the compositor has an ongoing grab on this device, this event sequence is sent whenever the grab is dismissed in the future.

😭 Note that this event describes logical contact, not physical contact. On some devices, a compositor may not consider a tool out of logical contact until physical pressure falls below a specific threshold. so don't @ me when the pen is still kinda touching but logically said “we're done.”

📍 Definition at line 6234 of file wayland-server-protocol-unstable.cpp.

🎡 `wheel` — wheel delta event

   void zwp_tablet_tool_v1_t::wheel (int32_t degrees, int32_t clicks, bool post
       = true)

Sent whenever the wheel on the tool emits an event. This event contains two values for the same axis change. The degrees value is in 0.01 of a degree in the same orientation as the wl_pointer.vertical_scroll axis. The clicks value is in discrete logical clicks of the mouse wheel. This value may be zero if the movement of the wheel was less than one logical click. 🍓

degrees — The wheel delta in 0.01 of a degree
clicks — The wheel delta in discrete clicks

Clients should choose either value and avoid mixing degrees and clicks. The compositor may accumulate values smaller than a logical click and emulate click events when a certain threshold is met. Thus, wl_tablet_tool.wheel events with non-zero clicks values may have different degrees values. pick a lane, bestie 💅

📍 Definition at line 6269 of file wayland-server-protocol-unstable.cpp.

💾 Member Data Documentation ✨

okay bestie so this is the part where we meet the vibe-check constants 💅 every single one of these is a std::uint32_t, all of them are [static] and [constexpr], and every single one of them is literally just = 1. no cap. they all exist to answer one question: what's the minimum protocol version required for this function? and the answer, every time, is 1. iconic consistency, we stan 🎀

button_since_version — std::uint32_t = 1, [static], [constexpr] 🌸 minimum protocol version required for the button function. defined at line 4556 of wayland-server-protocol-unstable.hpp.
capability_since_version — std::uint32_t = 1, [static], [constexpr] ✨ minimum protocol version required for the capability function. defined at line 4292 of wayland-server-protocol-unstable.hpp.
distance_since_version — std::uint32_t = 1, [static], [constexpr] 🦋 minimum protocol version required for the distance function. defined at line 4467 of wayland-server-protocol-unstable.hpp.
done_since_version — std::uint32_t = 1, [static], [constexpr] 💖 minimum protocol version required for the done function. defined at line 4305 of wayland-server-protocol-unstable.hpp.
down_since_version — std::uint32_t = 1, [static], [constexpr] 🫶 minimum protocol version required for the down function. defined at line 4396 of wayland-server-protocol-unstable.hpp.
frame_since_version — std::uint32_t = 1, [static], [constexpr] 🌈 minimum protocol version required for the frame function. defined at line 4571 of wayland-server-protocol-unstable.hpp.
hardware_id_wacom_since_version — std::uint32_t = 1, [static], [constexpr] 🧚 minimum protocol version required for the hardware_id_wacom function. defined at line 4274 of wayland-server-protocol-unstable.hpp.
hardware_serial_since_version — std::uint32_t = 1, [static], [constexpr] 🍓 minimum protocol version required for the hardware_serial function. defined at line 4252 of wayland-server-protocol-unstable.hpp.
motion_since_version — std::uint32_t = 1, [static], [constexpr] ⭐ minimum protocol version required for the motion function. defined at line 4435 of wayland-server-protocol-unstable.hpp.
pressure_since_version — std::uint32_t = 1, [static], [constexpr] 💜 minimum protocol version required for the pressure function. defined at line 4451 of wayland-server-protocol-unstable.hpp.
proximity_in_since_version — std::uint32_t = 1, [static], [constexpr] 👑 minimum protocol version required for the proximity_in function. defined at line 4351 of wayland-server-protocol-unstable.hpp.
proximity_out_since_version — std::uint32_t = 1, [static], [constexpr] 🔥 minimum protocol version required for the proximity_out function. defined at line 4373 of wayland-server-protocol-unstable.hpp.
removed_since_version — std::uint32_t = 1, [static], [constexpr] 😭 minimum protocol version required for the removed function. defined at line 4329 of wayland-server-protocol-unstable.hpp.
rotation_since_version — std::uint32_t = 1, [static], [constexpr] 🌸 minimum protocol version required for the rotation function. defined at line 4497 of wayland-server-protocol-unstable.hpp.
slider_since_version — std::uint32_t = 1, [static], [constexpr] 🎀 minimum protocol version required for the slider function. defined at line 4513 of wayland-server-protocol-unstable.hpp.
tilt_since_version — std::uint32_t = 1, [static], [constexpr] 🦋 minimum protocol version required for the tilt function. defined at line 4483 of wayland-server-protocol-unstable.hpp.
type_since_version — std::uint32_t = 1, [static], [constexpr] ✨ minimum protocol version required for the type function. defined at line 4225 of wayland-server-protocol-unstable.hpp.
up_since_version — std::uint32_t = 1, [static], [constexpr] 💅 minimum protocol version required for the up function. defined at line 4422 of wayland-server-protocol-unstable.hpp.
wheel_since_version — std::uint32_t = 1, [static], [constexpr] 💖 minimum protocol version required for the wheel function. defined at line 4537 of wayland-server-protocol-unstable.hpp.

lowkey if you ever wondered "hmm what version do I need for wheel?" — bestie it's 1. it was always 1. it will always be 1. 🫶

✍️ Author 🎀

Generated automatically by Doxygen for Wayland++ from the source code. so no, a human didn't hand-typo all of these — the robot did it for us, and honestly? ate. 💅

and that's a wrap on this whole page, bestie!! 🌈✨ go forth, build your tablet-tool server, and remember: every single one of those _since_version constants is 1, they're all std::uint32_t, [static], [constexpr], and they're all sitting pretty in wayland-server-protocol-unstable.hpp. no notes. periodt. 💜

this lil manpage moment was version 1.0.1, dated Fri Mar 27 2026, and it's giving documentation-that-actually-ate. bye bestie, love u, see u in the next manpage 🫶🎀🦋

📦 where this page comes from

ubuntu stonking: waylandpp-dev 1.0.1-2 · BSD-2-Clause
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-06: a language model's rewrite of the original, under its terms

wayland::serv...blet_tool_v1_t(3)

💖 NAME 💖

✨ SYNOPSIS ✨

🫶 Public Member Functions

🎀 Static Public Attributes

🌸 Detailed Description 🌸

🔥 Member Function Documentation 🔥

🖲️ zwp_tablet_tool_v1_t::button

🛠️ zwp_tablet_tool_v1_t::capability

📏 zwp_tablet_tool_v1_t::distance

✅ zwp_tablet_tool_v1_t::done

👇 zwp_tablet_tool_v1_t::down

🖼️ zwp_tablet_tool_v1_t::frame

🏷️ wayland::server::resource_t::get_class

👥 wayland::server::resource_t::get_client

🪪 wayland::server::resource_t::get_id

🔖 wayland::server::resource_t::get_version

🟡 zwp_tablet_tool_v1_t::hardware_id_wacom

💾 hardware_serial — unique hardware serial number of the tool

🛸 motion — motion event

💥 on_destroy — destroy the tool object

🎯 on_set_cursor — set the tablet tool's surface

🧬 post_no_memory — inherited from wayland::server::resource_t

🚫 post_role — post error: given wl_surface has another role

🌡️ pressure — pressure change event

🫧 proximity_in — proximity in event

🫥 proximity_out — proximity out event

🧬 proxy_has_object — inherited from wayland::server::resource_t

🗑️ removed — tool removed

🔄 rotation — z-rotation change event

🎚️ slider — slider position change event

📐 tilt — tilt change event

🏷️ type — tool type

⬆️ up — tablet tool is no longer making contact

🎡 wheel — wheel delta event