wayland::zwp_t...pad_group_v2_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💖 NAME 💖

Bestie, welcome to the wayland::zwp_tablet_pad_group_v2_t(3) page from Wayland++, and it's literally all about a set of buttons, rings and strips. That's the whole vibe: wayland::zwp_tablet_pad_group_v2_t — a pad group, no cap. 🎀

✨ SYNOPSIS ✨

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

It inherits wayland::proxy_t, so yes, the proxy energy is inherited too. 🫶

🌸 Public Types 🌸

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the wrapper-type enum, sitting here looking all official. 👑

🎀 Public Member Functions 🎀

  • std::function< void(array_t)> & on_buttons () — buttons announced — this is the callback for when the buttons get announced. 💅
  • std::function< void(zwp_tablet_pad_ring_v2_t)> & on_ring () — ring announced — fires for a ring announcement. 🌀
  • std::function< void(zwp_tablet_pad_strip_v2_t)> & on_strip () — strip announced — fires for a strip announcement. ✨
  • std::function< void(uint32_t)> & on_modes () — mode-switch ability announced — tells you when the mode-switch ability is announced. 🔥
  • std::function< void()> & on_done () — tablet group description events sequence complete — the "okay, the tablet group description events sequence is complete" callback. ✅
  • std::function< void(uint32_t, uint32_t, uint32_t)> & on_mode_switch () — mode switch event — the mode switch event callback, with its three uint32_t values. 🎛️
  • 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. (Yes, again — it's the bool-flavored check.) 💀
  • 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. 🫥

🌈 Detailed Description 🌈

Okay so picture this: a pad group describes a distinct (sub)set of buttons, rings and strips that are present in the tablet. The criteria of this grouping is usually positional — for example, if a tablet has buttons on the left and right side, 2 groups will be presented. The physical arrangement of groups is undisclosed and may change on the fly. Iconic behavior, honestly. 🦋

Pad groups will announce their features during pad initialization. Between the corresponding wp_tablet_pad.group event and wp_tablet_pad_group.done, the pad group will announce the buttons, rings and strips contained in it, plus the number of supported modes. Slay, that's the whole announcement sequence. ✨

Modes are a mechanism to allow multiple groups of actions for every element in the pad group. The number of groups and available modes in each is persistent across device plugs. The current mode is user-switchable, it will be announced through the wp_tablet_pad_group.mode_switch event both whenever it is switched, and after wp_tablet_pad.enter. Track that, bestie. 🔁

The current mode logically applies to all elements in the pad group, although it is at clients' discretion whether to actually perform different actions, and/or issue the respective .set_feedback requests to notify the compositor. See the wp_tablet_pad_group.mode_switch event for more details. 👀

Definition at line 5250 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. This enum is inherited, and it's giving very "know your wrapper's origin story" energy. 💅

  • 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. 🚨 > Heads up: this one belongs to somebody else — hands off in ways that could mess with the owning library, fr fr.
  • 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 117 of file wayland-client.hpp. 🌟

💖 MEMBER FUNCTION DOCUMENTATION 💖

okay bestie, this is the big one — every single member function, in order, nothing skipped. grab a snack 🍓

🔌 c_ptr() — the "give me the raw thing" hookup

wl_proxy * wayland::proxy_t::c_ptr () const [inherited]

Gets you a pointer to the underlying C struct. that's it, that's the whole vibe.

Returns — the underlying wl_proxy wrapped by this proxy_t if it exists… otherwise an exception gets thrown 😭 so like, check first maybe?

🏷️ get_class() — what even are you

std::string wayland::proxy_t::get_class () const [inherited]

Gets the interface name (the class, bestie) of a proxy object.

Returns — the interface name of the object associated with the proxy ✨

🔢 get_id() — everybody's got a number

uint32_t wayland::proxy_t::get_id () const [inherited]

Gets the id of a proxy object.

Returns — the id of the object associated with the proxy 🎀

🧾 get_version() — the protocol tea

uint32_t wayland::proxy_t::get_version () const [inherited]

Gets the protocol object version of a proxy object. and if the proxy was created with the unversioned API you get 0 — yeah, zero, as in "no info, good luck".

⚠️ a returned value of 0 means no version information is available, so the caller must make safe assumptions about the object's real version. no vibes-based guessing, fr fr.

display_t will always return version 0. always. no cap.

Returns — the protocol object version of the proxy, or 0 💅

🦋 get_wrapper_type() — what flavour of wrapper

wrapper_type wayland::proxy_t::get_wrapper_type () const [inline], [inherited]

Gets the type of a proxy object.

Definition at line 303 of file wayland-client.hpp.

🔘 on_buttons() — the button announcement

std::function< void(array_t)> & zwp_tablet_pad_group_v2_t::on_buttons ()

buttons announced 🎉

Parameters

  • buttons — buttons in this group

Sent on wp_tablet_pad_group initialization to announce the available buttons in the group. Button indices start at 0, and a button may only be in one group at a time — no double dipping, bestie.

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

Some buttons are reserved by the compositor. These buttons may not be assigned to any wp_tablet_pad_group. Compositors may broadcast this event in the case of changes to the mapping of these reserved buttons. And if the compositor happens to reserve all the buttons in a group, this event will be sent with an empty array — iconic "nothing to see here" behaviour 💀

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

✅ on_done() — that's a wrap

std::function< void()> & zwp_tablet_pad_group_v2_t::on_done ()

tablet group 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 group. go ahead, you're done, you can breathe 🫶

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

🔄 on_mode_switch() — we're changing modes, get into it

std::function< void(uint32_t, uint32_t, uint32_t)> & zwp_tablet_pad_group_v2_t::on_mode_switch ()

mode switch event 🌈

Parameters

  • time — the time of the event with millisecond granularity
  • serial
  • mode — the new mode of the pad

Notification that the mode was switched.

A mode applies to all buttons, rings and strips in a group simultaneously, but a client is not required to assign different actions for each mode. like, do the bare minimum if you want. For example, a client may have mode-specific button mappings but map the ring to vertical scrolling in all modes. Mode indices start at 0.

Switching modes is compositor-dependent. The compositor may provide visual cues to the client about the mode, e.g. by toggling LEDs on the tablet device 👑 Mode-switching may be software-controlled or controlled by one or more physical buttons. For example, on a Wacom Intuos Pro, the button inside the ring may be assigned to switch between modes. cute!

The compositor will also send this event after wp_tablet_pad.enter on each group in order to notify of the current mode. Groups that only feature one mode will use mode=0 when emitting this event.

  • If a button action in the new mode differs from the action in the previous mode, the client should immediately issue a wp_tablet_pad.set_feedback request for each changed button.
  • If a ring or strip action in the new mode differs from the action in the previous mode, the client should immediately issue a wp_tablet_ring.set_feedback or wp_tablet_strip.set_feedback request for each changed ring or strip.

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

🎚️ on_modes() — how many modes we working with

std::function< void(uint32_t)> & zwp_tablet_pad_group_v2_t::on_modes ()

mode-switch ability announced 🦋

Parameters

  • modes — the number of modes

Sent on wp_tablet_pad_group initialization to announce that the pad group may switch between modes. A client may use a mode to store a specific configuration for buttons, rings and strips and use the wl_tablet_pad_group.mode_switch event to toggle between these configurations. Mode indices start at 0.

Switching modes is compositor-dependent. See the wp_tablet_pad_group.mode_switch event for more details.

This event is sent in the initial burst of events before the wp_tablet_pad_group.done event. This event is only sent when more than one mode is available — so if you get it, congrats, you have options 🎀

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

💍 on_ring() — ring o'clock

std::function< void(zwp_tablet_pad_ring_v2_t)> & zwp_tablet_pad_group_v2_t::on_ring ()

ring announced 💫

Parameters

  • ring

Sent on wp_tablet_pad_group initialization to announce available rings. One event is sent for each ring available on this pad group.

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

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

🎀 on_strip() — strip announced, bestie

std::function< void(zwp_tablet_pad_strip_v2_t)> & zwp_tablet_pad_group_v2_t::on_strip ()

strip announced ✨

Parameters

  • strip

Sent on wp_tablet_pad initialization to announce available strips. One event is sent for each strip available on this pad group.

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

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

🫶 operator bool() — is there actually anything in here

wayland::proxy_t::operator bool () const [inherited]

Checks whether this wrapper actually wraps an object. the vibe check, essentially.

Returns — true if there's an underlying object, false if this wrapper is empty 💀

🙅‍♀️ operator!= — not the same one

bool wayland::proxy_t::operator!= (const proxy_t & right) const [inherited]

Checks whether two wrappers refer to different objects.

🫱 operator== — literally the same one

bool wayland::proxy_t::operator== (const proxy_t & right) const [inherited]

Checks whether two wrappers refer to the same object. twins fr.

🧐 proxy_has_object() — same question, different spelling

bool wayland::proxy_t::proxy_has_object () const [inherited]

Checks whether this wrapper actually wraps an object.

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

🕊️ proxy_release() — letting go

void wayland::proxy_t::proxy_release () [inherited]

Releases 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 just ignored. like talking to a wall, but politer.

Examples — foreign_display.cpp.

📬 set_queue() — put it in the right inbox

void wayland::proxy_t::set_queue (event_queue_t queue) [inherited]

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

🌟 AUTHOR 🌟

Generated automatically by Doxygen for Wayland++ from the source code. (yes, a robot wrote this, and it ate 💅)

and that's the whole page bestie!! 🎉💖 for the receipts: this is Version 1.0.1, dated Fri Mar 27 2026, freshly generated for Wayland++ — go forth and talk to your tablets, no cap 🦋✨🎀

📦 where this page comes from