wayland::serv...ure_swipe_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 NAME 💅

okay so bestie, welcome to wayland::server::zwp_pointer_gesture_swipe_v1_t — literally just a swipe gesture object. that's it, that's the whole vibe. this is a page from the Wayland++ docs, so like, hi, you're in the right place 🫶

✨ SYNOPSIS ✨

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

🌸 Public Member Functions

  • std::function< void()> & on_destroy () — destroy the pointer swipe gesture object. bye bestie 👋
  • void begin (uint32_t serial, uint32_t time, surface_t const &surface, uint32_t fingers, bool post=true) — multi-finger swipe begin, the opening act
  • void update (uint32_t time, double dx, double dy, bool post=true) — multi-finger swipe motion, the middle part where things actually move
  • void end (uint32_t serial, uint32_t time, int32_t cancelled, bool post=true) — multi-finger swipe end, closing credits
  • bool proxy_has_object () const — Check whether this wrapper actually wraps an object.
  • void post_no_memory () const — no description on this one in the docs, she's mysterious, respect it 💅
  • uint32_t get_id () const — get the ID
  • client_t get_client () const — get the client
  • unsigned int get_version () const — get the version
  • std::string get_class () — get the class

🎀 Static Public Attributes

  • static constexpr std::uint32_t begin_since_version = 1 — Minimum protocol version required for the begin function.
  • static constexpr std::uint32_t update_since_version = 1 — Minimum protocol version required for the update function.
  • static constexpr std::uint32_t end_since_version = 1 — Minimum protocol version required for the end function.

🦋 DETAILED DESCRIPTION 🦋

a swipe gesture object

so like, a swipe gesture object notifies a client about a multi-finger swipe gesture detected on an indirect input device such as a touchpad. ngl the gesture is usually initiated by multiple fingers moving in the same direction, but once initiated the direction may change. the precise conditions of when such a gesture is detected are implementation-dependent — i.e. don't @ me, it's up to whoever built the compositor ✨

a gesture consists of three stages: begin, update (optional) and end. there cannot be multiple simultaneous hold, pinch or swipe gestures on a same pointer/seat, and how compositors prevent these situations is implementation-dependent. yes, she's monogamous, one gesture at a time bestie 💀

a gesture may be cancelled by the compositor or the hardware. clients should not consider performing permanent or irreversible actions until the end of a gesture has been received.

🚨 fr fr do NOT commit to anything permanent mid-gesture. wait for the end event. that's the whole rule. periodt.

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

💖 MEMBER FUNCTION DOCUMENTATION 💖

🌈 void zwp_pointer_gesture_swipe_v1_t::begin (uint32_t serial, uint32_t time, surface_t const & surface, uint32_t fingers, bool post = true)

multi-finger swipe begin

Parameters

  • serial — the serial, iconic, no notes
  • time — timestamp with millisecond granularity
  • surface — the surface, the stage where this all goes down
  • fingers — number of fingers 🫶

This event is sent when a multi-finger swipe gesture is detected on the device.

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

🌈 void zwp_pointer_gesture_swipe_v1_t::end (uint32_t serial, uint32_t time, int32_t cancelled, bool post = true)

multi-finger swipe end

Parameters

  • serial — the serial again
  • time — timestamp with millisecond granularity
  • cancelled — 1 if the gesture was cancelled, 0 otherwise

This event is sent when a multi-finger swipe gesture ceases to be valid. This may happen when one or more fingers are lifted or the gesture is cancelled.

When a gesture is cancelled, the client should undo state changes caused by this gesture. What causes a gesture to be cancelled is implementation-dependent.

💀 cancelled?? undoing the state changes. it's giving "the swipe didn't work out, reverse everything".

Definition at line 5633 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.

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

Get the associated client

Returns the client that owns the resource.

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

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

🌈 std::function< void()> & zwp_pointer_gesture_swipe_v1_t::on_destroy ()

destroy the pointer swipe gesture object

Definition at line 5617 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.

yes, "certail" is exactly how it's spelled in the original docs, i'm not fixing it, she's perfect 🙈

🌈 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

🌈 void zwp_pointer_gesture_swipe_v1_t::update (uint32_t time, double dx, double dy, bool post = true)

multi-finger swipe motion

Parameters

  • time — timestamp with millisecond granularity
  • dx — delta x coordinate in surface coordinate space
  • dy — delta y coordinate in surface coordinate space

This event is sent when a multi-finger swipe gesture changes the position of the logical center.

The dx and dy coordinates are relative coordinates of the logical center of the gesture compared to the previous event.

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

⭐ MEMBER DATA DOCUMENTATION ⭐

🌟 std::uint32_t wayland::server::zwp_pointer_gesture_swipe_v1_t::begin_since_version = 1 [static], [constexpr]

Minimum protocol version required for the begin function.

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

🌟 std::uint32_t wayland::server::zwp_pointer_gesture_swipe_v1_t::end_since_version = 1 [static], [constexpr]

Minimum protocol version required for the end function.

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

🌟 std::uint32_t wayland::server::zwp_pointer_gesture_swipe_v1_t::update_since_version = 1 [static], [constexpr]

Minimum protocol version required for the update function.

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

👑 AUTHOR 👑

Generated automatically by Doxygen for Wayland++ from the source code. not a human, a machine, and honestly? she ate 🤖💅

✨ that's the whole page bestie ✨ this was Version 1.0.1, dated Fri Mar 27 2026 — mwah, go write some gestures, ily 🎀🦋💜

📦 where this page comes from