wayland::serve...wp_tablet_v2_t(3)

📦
version 1.0.1 · 11 versions
, in ubuntu stonking

💅 NAME 💅

bestie, this is the manual page for wayland::server::zwp_tablet_v2_t — it's the graphics tablet device situation, and yes it's part of the Wayland++ manual. 🎀

✨ SYNOPSIS ✨

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

🌸 Public Member Functions 🌸

  • std::function< void()> & on_destroy () — destroys the tablet object, okurrr 🫶
  • void name (std::string const &name, bool post=true) — the tablet device's name
  • void id (uint32_t vid, uint32_t pid, bool post=true) — the tablet device's USB vendor/product id
  • void path (std::string const &path, bool post=true) — the path to the device
  • void done (bool post=true) — the tablet description events sequence is complete, we're done here ✨
  • void removed (bool post=true) — the tablet removed event
  • bool proxy_has_object () const — checks whether this wrapper actually wraps an object
  • void post_no_memory () const
  • uint32_t get_id () const
  • client_t get_client () const
  • unsigned int get_version () const
  • std::string get_class ()

🦋 Static Public Attributes 🦋

  • static constexpr std::uint32_t name_since_version = 1 — the minimum protocol version required for the name function
  • static constexpr std::uint32_t id_since_version = 1 — the minimum protocol version required for the id function
  • static constexpr std::uint32_t path_since_version = 1 — the minimum protocol version required for the path function
  • static constexpr std::uint32_t done_since_version = 1 — the minimum protocol version required for the done function
  • static constexpr std::uint32_t removed_since_version = 1 — the minimum protocol version required for the removed function

🎀 Detailed Description 🎀

graphics tablet device

okay so the wp_tablet interface represents one graphics tablet device, periodt. The tablet interface itself does not generate events — literally none, it's giving silent main character energy 💀 — all events are generated by wp_tablet_tool objects when they're in proximity above a tablet.

A tablet has a bunch of static characteristics, like the device name and the pid/vid. These capabilities get sent in an event sequence after the wp_tablet_seat.tablet_added event. That initial event sequence is terminated by a wp_tablet.done event. slay. 💅

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

🔥 Member Function Documentation 🔥

void zwp_tablet_v2_t::done (bool post = true)

tablet description events sequence complete — this event is sent immediately to signal the end of the initial burst of descriptive events. A client may consider the static description of the tablet to be complete and finalize initialization of the tablet. You're all caught up bestie, go initialize ✨

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

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

Retrieves the interface name (class) of a resource object.

Returns Interface name of the resource object. 💜

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

Gets the associated client.

Returns the client that owns the resource.

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

Gets the internal ID of the resource.

Returns the internal ID of the resource

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

Get interface version.

Returns Interface version this resource has been constructed with.

void zwp_tablet_v2_t::id (uint32_t vid, uint32_t pid, bool post = true)

tablet device USB vendor/product id

Parameters

  • vid — USB vendor id
  • pid — USB product id

This event is sent in the initial burst of events before the wp_tablet.done event. iykyk 🫶

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

void zwp_tablet_v2_t::name (std::string const & name, bool post = true)

tablet device name

Parameters

  • name — the device name

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

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

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

destroy the tablet object — this destroys the client's resource for this tablet object. bye bestie 👋

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

void zwp_tablet_v2_t::path (std::string const & path, bool post = true)

path to the device

Parameters

  • path — path to local device

A system-specific device path that indicates which device is behind this wp_tablet. This information may be used to gather additional information about the device, e.g. through libwacom. (obsessed with that tbh 🧚)

A device may have more than one device path. If so, multiple wp_tablet.path events are sent. A device may be emulated and not have a device path at all, and in that case this event will not be sent — no path, no problem 💅

The format of the path is unspecified — it may be a device node, a sysfs path, or some other identifier. It is up to the client to identify the string provided. (yes that's on you, no cap 🙈)

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

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

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

Posts a "not enough memory" error to the client 😭

If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance. (yes, "certail" is literally how it's spelled in the source, we don't make the rules 🍓)

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

Checks whether this wrapper actually wraps an object. vibe check for wrappers basically ⭐

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

void zwp_tablet_v2_t::removed (bool post = true)

tablet removed event — sent when the tablet has been removed from the system. When a tablet is removed, some tools may be removed too.

🚨 heads up bestie: when this event is received, the client must wp_tablet.destroy the object. Not optional. Not a suggestion. must. 💀

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

👑 Member Data Documentation 👑

std::uint32_t wayland::server::zwp_tablet_v2_t::done_since_version = 1

[static], [constexpr]

Minimum protocol version required for the done function.

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

std::uint32_t wayland::server::zwp_tablet_v2_t::id_since_version = 1

[static], [constexpr]

Minimum protocol version required for the id function.

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

std::uint32_t wayland::server::zwp_tablet_v2_t::name_since_version = 1

[static], [constexpr]

Minimum protocol version required for the name function.

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

std::uint32_t wayland::server::zwp_tablet_v2_t::path_since_version = 1

[static], [constexpr]

Minimum protocol version required for the path function.

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

std::uint32_t wayland::server::zwp_tablet_v2_t::removed_since_version = 1

[static], [constexpr]

Minimum protocol version required for the removed function.

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

🌈 Author 🌈

Generated automatically by Doxygen for Wayland++ from the source code. (the robots wrote it, not me, but it ate fr fr 🔥)

✨ that's a wrap bestie ✨ this page is from Version 1.0.1, dated Fri Mar 27 2026, and it's the wayland::serve...wp_tablet_v2_t(3) page in the Wayland++ manual — go forth and tablet, you've got this 💖🦋🌸

📦 where this page comes from