wayland::serve...wp_tablet_v1_t(3)

📦
version 1.0.1 · 11 versions
, in ubuntu stonking

💅 wayland::server::zwp_tablet_v1_t — graphics tablet device ✨

okay bestie, so this is a page from the Wayland++ manual, section 3, and it's all about zwp_tablet_v1_t — literally just one graphics tablet device. it's giving "server-side wrapper, main character energy" and honestly? we're obsessed. let's get into it 🫶

🌸 NAME 🌸

wayland::server::zwp_tablet_v1_t — graphics tablet device. that's it, that's the vibe. one tablet. one wrapper. periodt 💅

🦋 SYNOPSIS 🦋

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

✨ Public Member Functions ✨

  • std::function< void()> & on_destroy() — destroy the tablet object. yeah. bye bye tablet 👋
  • void name(std::string const &name, bool post=true) — tablet device name, so the client knows what it's working with 🏷️
  • void id(uint32_t vid, uint32_t pid, bool post=true) — tablet device USB vendor/product id. the classic vid/pid duo 🔢
  • void path(std::string const &path, bool post=true) — path to the device. like a little address for your tablet 🛣️
  • void done(bool post=true) — tablet description events sequence complete. the "we're so done here" event (affectionate) ✅
  • void removed(bool post=true) — tablet removed event. it's gone, bestie 💀
  • bool proxy_has_object() const — Check whether this wrapper actually wraps an object. true = there's a real object underneath, false = empty wrapper, kind of a vibe check on the wrapper itself 🔍
  • void post_no_memory() const — posts the "not enough memory" error, no extra details given sorry 😭
  • uint32_t get_id() const — gets the internal ID, no extra details given 🌟
  • client_t get_client() const — gets the client, no extra details given 🧚
  • unsigned int get_version() const — gets the version, no extra details given 🔥
  • std::string get_class() — gets the class, no extra details given 🎀

🧚 Static Public Attributes 🧚

  • static constexpr std::uint32_t name_since_version = 1 — Minimum protocol version required for the name function.
  • static constexpr std::uint32_t id_since_version = 1 — Minimum protocol version required for the id function.
  • static constexpr std::uint32_t path_since_version = 1 — Minimum protocol version required for the path 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.

(they're all 1 btw. every single one. iconic consistency 💜)

🌈 Detailed Description 🌈

okay so wp_tablet — the wp_tablet interface — represents one graphics tablet device. one. singular. it's a whole individual, not a collective.

the thing is, the tablet interface itself does not generate events. like, at all. zero. all the events come from wp_tablet_tool objects, and only when those tools are in proximity above a tablet. so the tablet is like the stage, and the tools are the performers ✨🎭

a tablet has a number of static characteristics — for example, device name and pid/vid. these capabilities are sent in an event sequence after the wp_tablet_seat.tablet_added event. and that whole initial event sequence? it's terminated by a wp_tablet.done event. so done is the "okay we're finished introducing ourselves" moment 🎬

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

💖 Member Function Documentation 💖

🍓 void zwp_tablet_v1_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. like, congrats client, you now officially know your tablet 😌🎉

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

🦋 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. slay 🏷️

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

Get the associated client.

Returns the client that owns the resource. she owns it, fr fr 👑

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

Get the internal ID of the resource.

Returns the internal ID of the resource. that's the whole thing 🔢

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

Get interface version.

Returns Interface version this resource has been constructed with. yes, "constructed with," that's the exact wording, don't @ me 🎀

💅 void zwp_tablet_v1_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. so yes, it shows up early, before the big finale 🌟

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

🎀 void zwp_tablet_v1_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. early bird energy 🐦✨

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

🔥 std::function< void()> & zwp_tablet_v1_t::on_destroy ()

destroy the tablet object

This destroys the client's resource for this tablet object. gone, reduced to atoms 💀

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

🛣️ void zwp_tablet_v1_t::path (std::string const & path, bool post = true)

path to the device

Parameters

  • path — path to local device

okay this one has lore, pay attention bestie:

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.

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, and in that case this event will not be sent. so like, zero paths = perfectly valid outcome, no cap 🌈

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. literally "figure it out bestie," and that's the spec 🙈

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

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

💜 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 certail request of the client, this function can be called to notify the client of this circumstance. ("certail" is literally how it's spelled in the original, bestie — we don't fix, we preserve 😭💀)

🔍 bool wayland::server::resource_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. it's a proxy vibe check, essentially ✨

💀 void zwp_tablet_v1_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.

When this event is received, the client must wp_tablet.destroy the object. no like, must. capital-M Must. don't skip this step bestie 🙏
Definition at line 6353 of file wayland-server-protocol-unstable.cpp.

🌟 Member Data Documentation 🌟

⭐ std::uint32_t wayland::server::zwp_tablet_v1_t::done_since_version = 1

[static], [constexpr]

Minimum protocol version required for the done function.

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

🔢 std::uint32_t wayland::server::zwp_tablet_v1_t::id_since_version = 1

[static], [constexpr]

Minimum protocol version required for the id function.

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

🏷️ std::uint32_t wayland::server::zwp_tablet_v1_t::name_since_version = 1

[static], [constexpr]

Minimum protocol version required for the name function.

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

🛣️ std::uint32_t wayland::server::zwp_tablet_v1_t::path_since_version = 1

[static], [constexpr]

Minimum protocol version required for the path function.

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

💀 std::uint32_t wayland::server::zwp_tablet_v1_t::removed_since_version = 1

[static], [constexpr]

Minimum protocol version required for the removed function.

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

👑 Author 👑

Generated automatically by Doxygen for Wayland++ from the source code. so nobody hand-wrote this, it's a whole robot situation 🤖✨

and that's the whole page, bestie!! 🫶 this was Version 1.0.1, dated Fri Mar 27 2026 — mwah, stan Wayland++, catch you in the next manpage 💖🎀🦋

📦 where this page comes from