wayland::serve...e_pointer_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 NAME 💅

Okay so this is the wayland::serve...e_pointer_v1_t(3) manual page, from the Wayland++ manual (section 3, bestie), and the actual main character is wayland::server::zwp_relative_pointer_v1_t — the relative pointer object. Iconic. ✨

🌸 SYNOPSIS 🌸

Start here, bestie:

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

🫶 Public Member Functions 🫶

  • std::function< void()> & on_destroy () — release the relative pointer object.
  • void relative_motion (uint32_t utime_hi, uint32_t utime_lo, double dx, double dy, double dx_unaccel, double dy_unaccel, bool post=true) — relative pointer motion.
  • bool proxy_has_object () const — Check whether this wrapper actually wraps an object.
  • void post_no_memory () const — the "not enough memory" error-poster, full tea below.
  • uint32_t get_id () const — resource helper, details below.
  • client_t get_client () const — resource helper, details below.
  • unsigned int get_version () const — resource helper, details below.
  • std::string get_class () — resource helper, details below.

🦋 Static Public Attributes 🦋

  • static constexpr std::uint32_t relative_motion_since_version = 1 — Minimum protocol version required for the relative_motion function.

✨ Detailed Description ✨

zwp_relative_pointer_v1_t is a relative pointer object.

A wp_relative_pointer object is an extension to the wl_pointer interface used for emitting relative pointer events. It shares the same focus as wl_pointer objects of the same seat and will only emit events when it has focus.

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

💖 Member Function Documentation 💖

🎀 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_relative_pointer_v1_t::on_destroy ()

release the relative pointer object

Definition at line 6042 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 doesn't have enough memory to fulfill a certain request from the client, you can call this function to notify the client about that circumstance.

🎀 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_relative_pointer_v1_t::relative_motion (...)

void zwp_relative_pointer_v1_t::relative_motion (uint32_t utime_hi, uint32_t
       utime_lo, double dx, double dy, double dx_unaccel, double dy_unaccel,
       bool post = true)

relative pointer motion

Parameters

  • utime_hi — high 32 bits of a 64 bit timestamp with microsecond granularity.
  • utime_lo — low 32 bits of a 64 bit timestamp with microsecond granularity.
  • dx — the x component of the motion vector.
  • dy — the y component of the motion vector.
  • dx_unaccel — the x component of the unaccelerated motion vector.
  • dy_unaccel — the y component of the unaccelerated motion vector.

Relative x/y pointer motion from the pointer of the seat associated with this object.

A relative motion is in the same dimension as regular wl_pointer motion events, except they do not represent an absolute position. For example, moving a pointer from (x, y) to (x', y') would have the equivalent relative motion (x' - x, y' - y). If a pointer motion caused the absolute pointer position to be clipped by, for example, the edge of the monitor, the relative motion is unaffected by the clipping and will represent the unclipped motion.

This event also contains non-accelerated motion deltas. The non-accelerated delta is, when applicable, the regular pointer motion delta as it was before having applied motion acceleration and other transformations such as normalization.

Note that the non-accelerated delta does not represent 'raw' events as they were read from some device. Pointer motion acceleration is device- and configuration-specific and non-accelerated deltas and accelerated deltas may have the same value on some devices.

Relative motions are not coupled to wl_pointer.motion events, and can be sent in combination with such events, but also independently. There may also be scenarios where wl_pointer.motion is sent, but there is no relative motion. The order of an absolute and relative motion event originating from the same physical motion is not guaranteed.

If the client needs button events or focus state, it can receive them from a wl_pointer object of the same seat that the wp_relative_pointer object is associated with.

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

🌈 Member Data Documentation 🌈

🍓 std::uint32_t wayland::server::zwp_relative_pointer_v1_t::relative_motion_since_version = 1 [static], [constexpr]

std::uint32_t
       wayland::server::zwp_relative_pointer_v1_t::relative_motion_since_version
       = 1 [static],  [constexpr]

Minimum protocol version required for the relative_motion function.

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

👑 Author 👑

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

That's the whole manual page, bestie: Version 1.0.1, dated Fri Mar 27 2026, page 1wayland::serve...e_pointer_v1_t(3). Stay slay and read your man pages. 💅✨

📦 where this page comes from