wayland::zwp_p..._gestures_v1_t(3)

📦

version 1.0.1 · 10 versions

1.0.1 · ubuntu stonking (latest)
1.0.1-devman · nixos 26.05, nixpkgs unstable
1.0.0 · alpine 3.24
1.0.0 · ubuntu questing
1.0.1 · fedora 43
1.0.1 · fedora 44
1.0.0 · ubuntu noble
1.0.0 · debian bookworm
1.0.1 · ubuntu resolute
1.0.0 · debian trixie

🌸 NAME 🌸

wayland::zwp_pointer_gestures_v1_t — touchpad gestures. This is the Wayland++ manual page for wayland::zwp_p..._gestures_v1_t(3), bestie, and yes it's literally all about touchpad gestures. 💅

✨ SYNOPSIS ✨

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

Inherits wayland::proxy_t.

💖 Public Types 💖

enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the wrapper-type enum, icon behavior.

🫶 Public Member Functions 🫶

zwp_pointer_gesture_swipe_v1_t get_swipe_gesture (pointer_t const &pointer) — get swipe gesture.
zwp_pointer_gesture_pinch_v1_t get_pinch_gesture (pointer_t const &pointer) — get pinch gesture.
void release () — destroy the pointer gesture object.
bool can_release () const — Check whether the release function is available with the currently bound version of the protocol.
zwp_pointer_gesture_hold_v1_t get_hold_gesture (pointer_t const &pointer) — get hold gesture.
bool can_get_hold_gesture () const — Check whether the get_hold_gesture function is available with the currently bound version of the protocol.
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 get_swipe_gesture_since_version = 1 — Minimum protocol version required for the get_swipe_gesture function.
static constexpr std::uint32_t get_pinch_gesture_since_version = 1 — Minimum protocol version required for the get_pinch_gesture function.
static constexpr std::uint32_t release_since_version = 2 — Minimum protocol version required for the release function.
static constexpr std::uint32_t get_hold_gesture_since_version = 3 — Minimum protocol version required for the get_hold_gesture function.

🔥 Detailed Description 🔥

touchpad gestures — okay so this is a global interface that provides semantic touchpad gestures for a given pointer. It's giving "your trackpad finally speaks a language the compositor understands." 🦋

Three gestures are currently supported: swipe, pinch, and hold. Pinch and swipe gestures follow a three-stage cycle: begin, update, end, hold gestures follow a two-stage cycle: begin and end. All gestures are identified by a unique id.

Warning! The protocol described in this file is experimental and backward incompatible changes may be made. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes are done by bumping the version number in the protocol and interface names and resetting the interface version. Once the protocol is to be declared stable, the 'z' prefix and the version number in the protocol and interface names are removed and the interface version number is reset. 💀

Definition at line 2810 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 117 of file wayland-client.hpp.

💀 Member Function Documentation 💀

c_ptr [inherited]

wl_proxy * c_ptr () const

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.

can_get_hold_gesture

bool can_get_hold_gesture () const

Check whether the get_hold_gesture function is available with the currently bound version of the protocol.

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

can_release

bool can_release () const

Check whether the release function is available with the currently bound version of the protocol.

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

get_class [inherited]

std::string get_class () const

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

Returns: The interface name of the object associated with the proxy.

get_hold_gesture

zwp_pointer_gesture_hold_v1_t get_hold_gesture (pointer_t const & pointer)

get hold gesture

Parameters: pointer

Create a hold gesture object. See the wl_pointer_gesture_hold interface for details.

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

get_id [inherited]

uint32_t get_id () const

Get the id of a proxy object.

Returns: The id of the object associated with the proxy.

get_pinch_gesture

zwp_pointer_gesture_pinch_v1_t get_pinch_gesture (pointer_t const & pointer)

get pinch gesture

Parameters: pointer

Create a pinch gesture object. See the wl_pointer_gesture_pinch interface for details.

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

get_swipe_gesture

zwp_pointer_gesture_swipe_v1_t get_swipe_gesture (pointer_t const & pointer)

get swipe gesture

Parameters: pointer

Create a swipe gesture object. See the wl_pointer_gesture_swipe interface for details.

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

get_version [inherited]

uint32_t get_version () const

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.

get_wrapper_type [inline], [inherited]

wrapper_type get_wrapper_type () const

Get the type of a proxy object.

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

operator bool [inherited]

wayland::proxy_t::operator bool () const

Check whether this wrapper actually wraps an object.

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

operator!= [inherited]

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

Check whether two wrappers refer to different objects.

operator== [inherited]

bool wayland::proxy_t::operator== (const proxy_t & right) const

Check whether two wrappers refer to the same object.

proxy_has_object [inherited]

bool wayland::proxy_t::proxy_has_object () const

Check whether this wrapper actually wraps an object.

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

proxy_release [inherited]

void wayland::proxy_t::proxy_release ()

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.

release

void release ()

destroy the pointer gesture object. Destroy the pointer gesture object. Swipe, pinch and hold objects created via this gesture object remain valid.

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

set_queue [inherited]

void wayland::proxy_t::set_queue (event_queue_t 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 🍓

std::uint32_t wayland::zwp_pointer_gestures_v1_t::get_hold_gesture_since_version = 3 [static], [constexpr] — Minimum protocol version required for the get_hold_gesture function.

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

std::uint32_t wayland::zwp_pointer_gestures_v1_t::get_pinch_gesture_since_version = 1 [static], [constexpr] — Minimum protocol version required for the get_pinch_gesture function.

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

std::uint32_t wayland::zwp_pointer_gestures_v1_t::get_swipe_gesture_since_version = 1 [static], [constexpr] — Minimum protocol version required for the get_swipe_gesture function.

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

std::uint32_t wayland::zwp_pointer_gestures_v1_t::release_since_version = 2 [static], [constexpr] — Minimum protocol version required for the release function.

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

🌟 Author 🌟

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

That's the whole page, bestie! 💖 Wayland++ Version 1.0.1 • Fri Mar 27 2026 • page wayland::zwp_p..._gestures_v1_t(3) — bye! 🦋

📦 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