---
name: "wayland_zwp_tablet_tool_v1_t"
section: "3"
platform: "linux"
package: "waylandpp-dev"
version: "1.0.0-6+b2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/wayland_zwp_tablet_tool_v1_t"
---

# wayland\_zwp\_tablet\_tool\_v1\_t(3)

a physical tablet tool

## NAME

wayland::zwp\_tablet\_tool\_v1\_t - a physical tablet tool

## SYNOPSIS

`#include <wayland-client-protocol-unstable.hpp>`

Inherits **wayland::proxy\_t**.

### Public Types

enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\

### Public Member Functions

void **set\_cursor** (uint32\_t serial, **surface\_t** const &surface, int32\_t hotspot\_x, int32\_t hotspot\_y)\
 set the tablet tool's surface  std::function\< void(zwp\_tablet\_tool\_v1\_type)\> & **on\_type** ()\
 tool type  std::function\< void(uint32\_t, uint32\_t)\> & **on\_hardware\_serial** ()\
 unique hardware serial number of the tool  std::function\< void(uint32\_t, uint32\_t)\> & **on\_hardware\_id\_wacom** ()\
 hardware id notification in Wacom's format  std::function\< void(zwp\_tablet\_tool\_v1\_capability)\> & **on\_capability** ()\
 tool capability notification  std::function\< void()\> & **on\_done** ()\
 tool description events sequence complete  std::function\< void()\> & **on\_removed** ()\
 tool removed  std::function\< void(uint32\_t, **zwp\_tablet\_v1\_t**, **surface\_t**)\> & **on\_proximity\_in** ()\
 proximity in event  std::function\< void()\> & **on\_proximity\_out** ()\
 proximity out event  std::function\< void(uint32\_t)\> & **on\_down** ()\
 tablet tool is making contact  std::function\< void()\> & **on\_up** ()\
 tablet tool is no longer making contact  std::function\< void(double, double)\> & **on\_motion** ()\
 motion event  std::function\< void(uint32\_t)\> & **on\_pressure** ()\
 pressure change event  std::function\< void(uint32\_t)\> & **on\_distance** ()\
 distance change event  std::function\< void(int32\_t, int32\_t)\> & **on\_tilt** ()\
 tilt change event  std::function\< void(int32\_t)\> & **on\_rotation** ()\
 z-rotation change event  std::function\< void(int32\_t)\> & **on\_slider** ()\
 Slider position change event.  std::function\< void(int32\_t, int32\_t)\> & **on\_wheel** ()\
 Wheel delta event.  std::function\< void(uint32\_t, uint32\_t, zwp\_tablet\_tool\_v1\_button\_state)\> & **on\_button** ()\
 button event  std::function\< void(uint32\_t)\> & **on\_frame** ()\
 frame event  uint32\_t **get\_id** () const\
 Get the id of a proxy object.  std::string **get\_class** () const\
 Get the interface name (class) of a proxy object.  uint32\_t **get\_version** () const\
 Get the protocol object version of a proxy object.  **wrapper\_type** **get\_wrapper\_type** () const\
 Get the type of a proxy object.  void **set\_queue** (**event\_queue\_t** queue)\
 Assign a proxy to an event queue.  wl\_proxy \* **c\_ptr** () const\
 Get a pointer to the underlying C struct.  bool **proxy\_has\_object** () const\
 Check whether this wrapper actually wraps an object.  **operator bool** () const\
 Check whether this wrapper actually wraps an object.  bool **operator==** (const **proxy\_t** &right) const\
 Check whether two wrappers refer to the same object.  bool **operator!=** (const **proxy\_t** &right) const\
 Check whether two wrappers refer to different objects.  void **proxy\_release** ()\
 Release the wrapped object (if any), making this an empty wrapper.

### Static Public Attributes

static constexpr std::uint32\_t **set\_cursor\_since\_version** = 1\
 Minimum protocol version required for the **set\_cursor** function.

## Detailed Description

a physical tablet tool

An object that represents a physical 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 **3667** of file **wayland-client-protocol-unstable.hpp**.

## Member Enumeration Documentation

### enum class wayland::proxy\_t::wrapper\_type` [strong]`, ` [inherited]`

Underlying wl\_proxy type and properties of a **proxy\_t** that affect construction, destruction, and event handling

**Enumerator**

- *standard*

  *C pointer is a standard type compatible with wl\_proxy\*. Events are dispatched and it is destructed when the* **proxy\_t** *is destructed. User data is set.*

- *display*

  *C pointer is a wl\_display\*. No events are dispatched, wl\_display\_disconnect is called when the* **proxy\_t** *is destructed. User data is set.*

- *foreign*

  *C pointer is a standard type compatible with wl\_proxy\*, but another library owns it and it should not be touched in a way that could affect the operation of the other library. No events are dispatched, wl\_proxy\_destroy is not called when the* **proxy\_t** *is destructed, user data is not touched. Consequently, there is no reference counting for the* **proxy\_t***. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl\_proxy.*

- *proxy\_wrapper*

  *C pointer is a wl\_proxy\* that was constructed with wl\_proxy\_create\_wrapper. No events are dispatched, wl\_proxy\_wrapper\_destroy is called when the* **proxy\_t** *is destroyed. Reference counting is active. A reference to the* **proxy\_t** *creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed.*

*Definition at line* **116** *of file* **wayland-client.hpp***.*

## Member Function Documentation

### wl\_proxy \* wayland::proxy\_t::c\_ptr () const` [inherited]`

*Get a pointer to the underlying C struct.*

**Returns**

*The underlying wl\_proxy wrapped by this* **proxy\_t** *if it exists, otherwise an exception is thrown*

### std::string wayland::proxy\_t::get\_class () const` [inherited]`

*Get the interface name (class) of a proxy object.*

**Returns**

*The interface name of the object associated with the proxy*

### uint32\_t wayland::proxy\_t::get\_id () const` [inherited]`

*Get the id of a proxy object.*

**Returns**

*The id the object associated with the proxy*

### uint32\_t wayland::proxy\_t::get\_version () const` [inherited]`

*Get the protocol object version of a proxy object. Gets the protocol object version of a proxy object, or 0 if the proxy was created with unversioned API.*

*A returned value of 0 means that no version information is available, so the caller must make safe assumptions about the object's real version.*

**display\_t** *will always return version 0.*

**Returns**

*The protocol object version of the proxy or 0*

### wrapper\_type wayland::proxy\_t::get\_wrapper\_type () const` [inline]`, ` [inherited]`

*Get the type of a proxy object.*

*Definition at line* **302** *of file* **wayland-client.hpp***.*

### std::function\< void(uint32\_t, uint32\_t, zwp\_tablet\_tool\_v1\_button\_state)\> & zwp\_tablet\_tool\_v1\_t::on\_button ()

*button event*

**Parameters**

*serial* \
 *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* **7001** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(zwp\_tablet\_tool\_v1\_capability)\> & zwp\_tablet\_tool\_v1\_t::on\_capability ()

*tool capability notification*

**Parameters**

*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* **6931** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(uint32\_t)\> & zwp\_tablet\_tool\_v1\_t::on\_distance ()

*distance change event*

**Parameters**

*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* **6976** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void()\> & zwp\_tablet\_tool\_v1\_t::on\_done ()

*tool description events sequence complete 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* **6936** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(uint32\_t)\> & zwp\_tablet\_tool\_v1\_t::on\_down ()

*tablet tool is making contact*

**Parameters**

*serial*

*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* **6956** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(uint32\_t)\> & zwp\_tablet\_tool\_v1\_t::on\_frame ()

*frame event*

**Parameters**

*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* **7006** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(uint32\_t, uint32\_t)\> & zwp\_tablet\_tool\_v1\_t::on\_hardware\_id\_wacom ()

*hardware id notification in Wacom's format*

**Parameters**

*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* **6926** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(uint32\_t, uint32\_t)\> & zwp\_tablet\_tool\_v1\_t::on\_hardware\_serial ()

*unique hardware serial number of the tool*

**Parameters**

*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 the physical tool can be identified by a unique 64-bit serial number, this event notifies the client of this serial number.*

*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.*

*This event is sent in the initial burst of events before the wp\_tablet\_tool.done event.*

*Definition at line* **6921** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(double, double)\> & zwp\_tablet\_tool\_v1\_t::on\_motion ()

*motion event*

**Parameters**

*x surface-local x coordinate* \
 *y surface-local y coordinate*

*Sent whenever a tablet tool moves.*

*Definition at line* **6966** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(uint32\_t)\> & zwp\_tablet\_tool\_v1\_t::on\_pressure ()

*pressure change event*

**Parameters**

*pressure The current pressure value*

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

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

*Definition at line* **6971** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(uint32\_t, zwp\_tablet\_v1\_t, surface\_t)\> & zwp\_tablet\_tool\_v1\_t::on\_proximity\_in ()

*proximity in event*

**Parameters**

*serial* \
 *tablet The tablet the tool is in proximity of* \
 *surface The current surface the tablet tool is over*

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

*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.*

*Definition at line* **6946** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void()\> & zwp\_tablet\_tool\_v1\_t::on\_proximity\_out ()

*proximity out event 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* **6951** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void()\> & zwp\_tablet\_tool\_v1\_t::on\_removed ()

*tool removed 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.*

*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.*

*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.*

*Definition at line* **6941** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(int32\_t)\> & zwp\_tablet\_tool\_v1\_t::on\_rotation ()

*z-rotation change event*

**Parameters**

*degrees The current rotation of the Z axis*

*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.*

*Definition at line* **6986** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(int32\_t)\> & zwp\_tablet\_tool\_v1\_t::on\_slider ()

*Slider position change event.*

**Parameters**

*position The current position of slider*

*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.*

*The slider is available on e.g. the Wacom Airbrush tool.*

*Definition at line* **6991** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(int32\_t, int32\_t)\> & zwp\_tablet\_tool\_v1\_t::on\_tilt ()

*tilt change event*

**Parameters**

*tilt\_x The current value of the X tilt axis* \
 *tilt\_y The current value of the Y tilt axis*

*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.*

*Definition at line* **6981** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(zwp\_tablet\_tool\_v1\_type)\> & zwp\_tablet\_tool\_v1\_t::on\_type ()

*tool type*

**Parameters**

*tool\_type the physical tool type*

*The tool type is the high-level type of the tool and usually decides the interaction expected from this tool.*

*This event is sent in the initial burst of events before the wp\_tablet\_tool.done event.*

*Definition at line* **6916** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void()\> & zwp\_tablet\_tool\_v1\_t::on\_up ()

*tablet tool is no longer making contact 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.*

*Definition at line* **6961** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(int32\_t, int32\_t)\> & zwp\_tablet\_tool\_v1\_t::on\_wheel ()

*Wheel delta event.*

**Parameters**

*degrees The wheel delta in 0.01 of a degree* \
 *clicks The wheel delta in discrete clicks*

*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.*

*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.*

*Definition at line* **6996** *of file* **wayland-client-protocol-unstable.cpp***.*

### wayland::proxy\_t::operator bool () const` [inherited]`

*Check whether this wrapper actually wraps an object.*

**Returns**

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

### bool wayland::proxy\_t::operator!= (const proxy\_t & right) const` [inherited]`

*Check whether two wrappers refer to different objects.*

### bool wayland::proxy\_t::operator== (const proxy\_t & right) const` [inherited]`

*Check whether two wrappers refer to the same object.*

### bool wayland::proxy\_t::proxy\_has\_object () const` [inherited]`

*Check whether this wrapper actually wraps an object.*

**Returns**

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

### void wayland::proxy\_t::proxy\_release ()` [inherited]`

*Release the wrapped object (if any), making this an empty wrapper. Note that* **display\_t** *instances cannot be released this way. Attempts to do so are ignored.*

**Examples** **foreign\_display.cpp***.*

### void zwp\_tablet\_tool\_v1\_t::set\_cursor (uint32\_t serial, surface\_t const & surface, int32\_t hotspot\_x, int32\_t hotspot\_y)

*set the tablet tool's surface*

**Parameters**

*serial serial of the enter event* \
 *surface* \
 *hotspot\_x surface-local x coordinate* \
 *hotspot\_y surface-local y coordinate*

*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.*

*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.*

*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.*

*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* **6910** *of file* **wayland-client-protocol-unstable.cpp***.*

### void wayland::proxy\_t::set\_queue (event\_queue\_t queue)` [inherited]`

*Assign a proxy to an event queue.*

**Parameters**

*queue The event queue that will handle this proxy*

*Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's main queue.*

*See also:* **display\_t::dispatch\_queue()***.*

**Examples** **proxy\_wrapper.cpp***.*

## Member Data Documentation

### constexpr std::uint32\_t wayland::zwp\_tablet\_tool\_v1\_t::set\_cursor\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_cursor** *function.*

*Definition at line* **3752** *of file* **wayland-client-protocol-unstable.hpp***.*

## Author

*Generated automatically by Doxygen for Wayland++ from the source code.*