wayland::server::pointer_t(3)

📦
version 1.0.1 · 11 versions
, in ubuntu stonking

🌸 NAME 🌸

wayland::server::pointer_t — pointer input device 💅

(okay so this is the Wayland++ manual, section 3, and we're talking about wayland::server::pointer_t(3) — say it with me bestie)

✨ SYNOPSIS ✨

#include <wayland-server-protocol.hpp>

🫶 Public Member Functions

  • std::function< void(uint32_t, surface_t, int32_t, int32_t)> & on_set_cursor () — set the pointer surface 🖱️
  • std::function< void()> & on_release () — release the pointer object 🫶
  • void enter (uint32_t serial, surface_t const &surface, double surface_x, double surface_y, bool post=true) — enter event ✨
  • void leave (uint32_t serial, surface_t const &surface, bool post=true) — leave event 👋
  • void motion (uint32_t time, double surface_x, double surface_y, bool post=true) — pointer motion event 💫
  • void button (uint32_t serial, uint32_t time, uint32_t button, pointer_button_state const &state, bool post=true) — pointer button event 🔘
  • void axis (uint32_t time, pointer_axis const &axis, double value, bool post=true) — axis event 🌀
  • void frame (bool post=true) — end of a pointer event sequence 🎬
  • bool can_frame () const — Check whether the frame function is available with the currently bound version of the protocol.
  • void axis_source (pointer_axis_source const &axis_source, bool post=true) — axis source event 🌊
  • bool can_axis_source () const — Check whether the axis_source function is available with the currently bound version of the protocol.
  • void axis_stop (uint32_t time, pointer_axis const &axis, bool post=true) — axis stop event 🛑
  • bool can_axis_stop () const — Check whether the axis_stop function is available with the currently bound version of the protocol.
  • void axis_discrete (pointer_axis const &axis, int32_t discrete, bool post=true) — axis click event 🖱️
  • bool can_axis_discrete () const — Check whether the axis_discrete function is available with the currently bound version of the protocol.
  • void axis_value120 (pointer_axis const &axis, int32_t value120, bool post=true) — axis high-resolution scroll event 🎢
  • bool can_axis_value120 () const — Check whether the axis_value120 function is available with the currently bound version of the protocol.
  • void post_role (std::string const &msg) — Post error: given wl_surface has another role. 💀
  • bool proxy_has_object () const — Check whether this wrapper actually wraps an object. 👀
  • void post_no_memory () const — (no blurb in the original, it's just vibes and memory errors, ngl)
  • uint32_t get_id () const — (getter, it gets the id, that's the whole bit 🫡)
  • client_t get_client () const — (getter for the client, lowkey essential)
  • unsigned int get_version () const — (getter for the version)
  • std::string get_class () const — (getter for the class name)

🎀 Static Public Attributes

  • static constexpr std::uint32_t enter_since_version = 1 — Minimum protocol version required for the enter function.
  • static constexpr std::uint32_t leave_since_version = 1 — Minimum protocol version required for the leave function.
  • static constexpr std::uint32_t motion_since_version = 1 — Minimum protocol version required for the motion function.
  • static constexpr std::uint32_t button_since_version = 1 — Minimum protocol version required for the button function.
  • static constexpr std::uint32_t axis_since_version = 1 — Minimum protocol version required for the axis function.
  • static constexpr std::uint32_t frame_since_version = 5 — Minimum protocol version required for the frame function.
  • static constexpr std::uint32_t axis_source_since_version = 5 — Minimum protocol version required for the axis_source function.
  • static constexpr std::uint32_t axis_stop_since_version = 5 — Minimum protocol version required for the axis_stop function.
  • static constexpr std::uint32_t axis_discrete_since_version = 5 — Minimum protocol version required for the axis_discrete function.
  • static constexpr std::uint32_t axis_value120_since_version = 8 — Minimum protocol version required for the axis_value120 function.

💜 Detailed Description 💜

pointer input device. iconic. 🖱️👑

The wl_pointer interface represents one or more input devices, such as mice, which control the pointer location and pointer_focus of a seat.

The wl_pointer interface generates motion, enter and leave events for the surfaces that the pointer is located over, and button and axis events for button presses, button releases and scrolling. literally the whole mouse saga 🐭

Definition at line 2810 of file wayland-server-protocol.hpp.

🎀 Member Function Documentation 🎀

void pointer_t::axis (uint32_t time, pointer_axis const & axis, double value, bool post = true)

axis event 🌀

Parameters

  • time — timestamp with millisecond granularity ⏱️
  • axis — axis type
  • value — length of vector in surface-local coordinate space

Scroll and other axis notifications.

For scroll events (vertical and horizontal scroll axes), the value parameter is the length of a vector along the specified axis in a coordinate space identical to those of motion events, representing a relative movement along the specified axis.

For devices that support movements non-parallel to axes multiple axis events will be emitted. (multiple!! it's giving overachiever ✨)

When applicable, for example for touch pads, the server can choose to emit scroll events where the motion vector is equivalent to a motion event vector.

When applicable, a client can transform its content relative to the scroll distance.

Definition at line 2688 of file wayland-server-protocol.cpp.

void pointer_t::axis_discrete (pointer_axis const & axis, int32_t discrete, bool post = true)

axis click event 🖱️

Parameters

  • axis — axis type
  • discrete — number of steps

Discrete step information for scroll and other axes.

This event carries the axis value of the wl_pointer.axis event in discrete steps (e.g. mouse wheel clicks).

⚠️ heads up bestie, this one is deprecated with wl_pointer version 8 — this event is not sent to clients supporting version 8 or later. it's giving retired icon 💀

This event does not occur on its own, it is coupled with a wl_pointer.axis event that represents this axis value on a continuous scale. The protocol guarantees that each axis_discrete event is always followed by exactly one axis event with the same axis number within the same wl_pointer.frame. Note that the protocol allows for other events to occur between the axis_discrete and its coupled axis event, including other axis_discrete or axis events.

This event is optional; continuous scrolling devices like two-finger scrolling on touchpads do not have discrete steps and do not generate this event.

The discrete value carries the directional information. e.g. a value of -2 is two steps towards the negative direction of this axis.

The axis number is identical to the axis number in the associated axis event.

The order of wl_pointer.axis_discrete and wl_pointer.axis_source is not guaranteed. 🙈

Definition at line 2723 of file wayland-server-protocol.cpp.

void pointer_t::axis_source (pointer_axis_source const & axis_source, bool post = true)

axis source event 🌊

Parameters

  • axis_source — source of the axis event

Source information for scroll and other axes.

This event does not occur on its own. It is sent before a wl_pointer.frame event and carries the source information for all events within that frame.

The source specifies how this event was generated. If the source is wl_pointer.axis_source.finger, a wl_pointer.axis_stop event will be sent when the user lifts the finger off the device. 👆

If the source is wl_pointer.axis_source.wheel, wl_pointer.axis_source.wheel_tilt or wl_pointer.axis_source.continuous, a wl_pointer.axis_stop event may or may not be sent. Whether a compositor sends an axis_stop event for these sources is hardware-specific and implementation-dependent; clients must not rely on receiving an axis_stop event for these scroll sources and should treat scroll sequences from these scroll sources as unterminated by default. 😭 no cap, don't build on that

This event is optional. If the source is unknown for a particular axis event sequence, no event is sent. Only one wl_pointer.axis_source event is permitted per frame.

The order of wl_pointer.axis_discrete and wl_pointer.axis_source is not guaranteed.

Definition at line 2703 of file wayland-server-protocol.cpp.

void pointer_t::axis_stop (uint32_t time, pointer_axis const & axis, bool post = true)

axis stop event 🛑

Parameters

  • time — timestamp with millisecond granularity ⏱️
  • axis — the axis stopped with this event

Stop notification for scroll and other axes.

For some wl_pointer.axis_source types, a wl_pointer.axis_stop event is sent to notify a client that the axis sequence has terminated. This enables the client to implement kinetic scrolling. See the wl_pointer.axis_source documentation for information on when this event may be generated.

Any wl_pointer.axis events with the same axis_source after this event should be considered as the start of a new axis motion.

The timestamp is to be interpreted identical to the timestamp in the wl_pointer.axis event. The timestamp value may be the same as a preceding wl_pointer.axis event.

Definition at line 2713 of file wayland-server-protocol.cpp.

void pointer_t::axis_value120 (pointer_axis const & axis, int32_t value120, bool post = true)

axis high-resolution scroll event 🎢

Parameters

  • axis — axis type
  • value120 — scroll distance as fraction of 120

Discrete high-resolution scroll information.

This event carries high-resolution wheel scroll information, with each multiple of 120 representing one logical scroll step (a wheel detent). For example, an axis_value120 of 30 is one quarter of a logical scroll step in the positive direction, a value120 of -240 are two logical scroll steps in the negative direction within the same hardware event. Clients that rely on discrete scrolling should accumulate the value120 to multiples of 120 before processing the event.

The value120 must not be zero. 🚫

This event replaces the wl_pointer.axis_discrete event in clients supporting wl_pointer version 8 or later. glow-up era ✨

Where a wl_pointer.axis_source event occurs in the same wl_pointer.frame, the axis source applies to this event.

The order of wl_pointer.axis_value120 and wl_pointer.axis_source is not guaranteed.

Definition at line 2733 of file wayland-server-protocol.cpp.

void pointer_t::button (uint32_t serial, uint32_t time, uint32_t button, pointer_button_state const & state, bool post = true)

pointer button event 🔘

Parameters

  • serial — serial number of the button event
  • time — timestamp with millisecond granularity ⏱️
  • button — button that produced the event
  • state — physical state of the button

Mouse button click and release notifications. click clack 💅

The location of the click is given by the last motion or enter event. The time argument is a timestamp with millisecond granularity, with an undefined base.

The button is a button code as defined in the Linux kernel's linux/input-event-codes.h header file, e.g. BTN_LEFT.

...any 16-bit button code value is reserved for future additions to the kernel's event code list, bestie. And every other button code above 0xFFFF? Currently undefined, but like... they might get used in future versions of this protocol. So don't go wild with them yet. 💅

Definition at line 2683 of file wayland-server-protocol.cpp.

🦋 bool pointer_t::can_axis_discrete () const

Vibe check on axis_discrete: is this function even available with the version of the protocol you're currently bound to? That's all this tells you. Yes/no, that's it. ✨

Definition at line 2728 of file wayland-server-protocol.cpp.

🦋 bool pointer_t::can_axis_source () const

Same deal, different function — checks whether axis_source is available with the currently bound version of the protocol. 🫶

Definition at line 2708 of file wayland-server-protocol.cpp.

🦋 bool pointer_t::can_axis_stop () const

And this one checks whether axis_stop is available with the currently bound version of the protocol. Iconic consistency, honestly. ⭐

Definition at line 2718 of file wayland-server-protocol.cpp.

🦋 bool pointer_t::can_axis_value120 () const

Checks whether axis_value120 is available with the currently bound version of the protocol. 🎀

Definition at line 2738 of file wayland-server-protocol.cpp.

🦋 bool pointer_t::can_frame () const

Checks whether frame is available with the currently bound version of the protocol. That's the whole thing, no notes. 💜

Definition at line 2698 of file wayland-server-protocol.cpp.

👑 void pointer_t::enter (uint32_t serial, surface_t const & surface, double surface_x, double surface_y, bool post = true)

The enter event, babes. Main character moment for a surface. 💫

The parameters, laid out:

  • serial — serial number of the enter event
  • surface — surface entered by the pointer
  • surface_x — surface-local x coordinate
  • surface_y — surface-local y coordinate

So basically: notification that this seat's pointer is focused on a certain surface. 🫶

And okay, important caveat: when a seat's focus enters a surface, the pointer image is undefined — like, genuinely undefined, not "figure it out later" undefined — and a client should respond to this event by setting an appropriate pointer image with the set_cursor request. So don't just sit there. 😭

Definition at line 2668 of file wayland-server-protocol.cpp.

🔥 void pointer_t::frame (bool post = true)

End of a pointer event sequence, periodt. Indicates the end of a set of events that logically belong together. A client is expected to accumulate the data in all events within the frame before proceeding. 🧚

So the lore is: all wl_pointer events before a wl_pointer.frame event belong logically together. For example — and this example ate, ngl — in a diagonal scroll motion the compositor will send an optional wl_pointer.axis_source event, two wl_pointer.axis events (horizontal and vertical) and finally a wl_pointer.frame event. The client may use this information to calculate a diagonal vector for scrolling. Math queen behavior. 📐✨

More rules, bestie, write these down:

  • When multiple wl_pointer.axis events occur within the same frame, the motion vector is the combined motion of all events.
  • When a wl_pointer.axis and a wl_pointer.axis_stop event occur within the same frame, this indicates that axis movement in one axis has stopped but continues in the other axis.
  • When multiple wl_pointer.axis_stop events occur within the same frame, this indicates that these axes stopped in the same instance.

A wl_pointer.frame event is sent for every logical event group, even if the group only contains a single wl_pointer event. Specifically, a client may get a sequence:

motion, frame, button, frame, axis, frame, axis_stop, frame

Look at that little parade. 🌈

Now the messy part — the wl_pointer.enter and wl_pointer.leave events are logical events generated by the compositor and not the hardware. They're also grouped by a wl_pointer.frame. When a pointer moves from one surface to another, a compositor should group the wl_pointer.leave event within the same wl_pointer.frame. However — and this is the part where you don't get to assume things — a client must not rely on wl_pointer.leave and wl_pointer.enter being in the same wl_pointer.frame. Compositor-specific policies may require the wl_pointer.leave and wl_pointer.enter event being split across multiple wl_pointer.frame groups. So like... be flexible. 💀

Definition at line 2693 of file wayland-server-protocol.cpp.

🌸 std::string wayland::server::resource_t::get_class () [inherited]

Retrieves 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]

Gets the associated client. Your plus-one for this resource. 🫶

Returns: the client that owns the resource.

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

Gets the internal ID of the resource. ✨

Returns: the internal ID of the resource.

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

Gets the interface version. 📜

Returns: interface version this resource has been constructed with.

💜 void pointer_t::leave (uint32_t serial, surface_t const & surface, bool post = true)

The leave event — the breakup text of the pointer world. 😭

  • serial — serial number of the leave event
  • surface — surface left by the pointer

Notification that this seat's pointer is no longer focused on a certain surface. 🦋

And the ordering tea: the leave notification is sent before the enter notification for the new focus.</bold> So leave first, enter second, always that order.

Definition at line 2673 of file wayland-server-protocol.cpp.

⭐ void pointer_t::motion (uint32_t time, double surface_x, double surface_y, bool post = true)

Pointer motion event — the "she's moving" of it all. 💫

  • time — timestamp with millisecond granularity
  • surface_x — surface-local x coordinate
  • surface_y — surface-local y coordinate

Notification of pointer location change. The arguments surface_x and surface_y are the location relative to the focused surface. Trackpad girlies, this is your moment. 🎀

Definition at line 2678 of file wayland-server-protocol.cpp.

🧚 std::function< void()> & pointer_t::on_release ()

Release the pointer object. Using this request a client can tell the server that it is not going to use the pointer object anymore. It's giving "we need to talk." 💅

⚠️ Lowkey crucial: this request destroys the pointer proxy object, so clients must not call wl_pointer_destroy() after using this request. Like, don't. It's already gone. 😭

Definition at line 2662 of file wayland-server-protocol.cpp.

🔥 std::function< void(uint32_t, surface_t, int32_t, int32_t)> & pointer_t::on_set_cursor ()

Set the pointer surface. Big one, okay, so settle in. 🫶

The parameters:

  • serial — serial number of the enter event
  • surface — pointer surface
  • hotspot_x — surface-local x coordinate
  • hotspot_y — surface-local y coordinate

Set the pointer surface, i.e., the surface that contains the pointer image (cursor). This request gives the surface the role of a cursor. And if the surface already has another role? It raises a protocol error. One role per surface, no double-dipping. 💀

The cursor actually changes only if the pointer focus for this device is one of the requesting client's surfaces or the surface parameter is the current pointer surface. If there was a previous surface set with this request, it is replaced. If surface is NULL, the pointer image is hidden. 🙈

The parameters hotspot_x and hotspot_y define the position of the pointer surface relative to the pointer location. Its top-left corner is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the coordinates of the pointer location, in surface-local coordinates. ✨ Bear with the math, it's actually cute.

On surface.attach requests to the pointer surface, hotspot_x and hotspot_y are decremented by the x and y parameters passed to the request. Attach must be confirmed by wl_surface.commit as usual. The hotspot can also be updated by passing the currently set pointer surface to this request with new values for hotspot_x and hotspot_y. 🎯

Now the cleanup bit: the current and pending input regions of the wl_surface are cleared, and wl_surface.set_input_region is ignored until the wl_surface is no longer used as the cursor. When the use as a cursor ends, the current and pending input regions become undefined, and the wl_surface is unmapped. 🦋

And the gatekeeping rule: the serial parameter must match the latest wl_pointer.enter serial number sent to the client. Otherwise the request will be ignored. No serial, no cursor, no exceptions. 💅

Definition at line 2656 of file wayland-server-protocol.cpp.

🌈 void wayland::server::resource_t::post_no_memory () const [inherited]

Posts a "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" — we keep the typo, it's part of the lore now. 🎀)

💜 void pointer_t::post_role (std::string const & msg)

Posts an error: given wl_surface has another role. That's the whole function, it's a one-job icon. 👑

Definition at line 2743 of file wayland-server-protocol.cpp.

🦋 bool wayland::server::resource_t::proxy_has_object () const [inherited]

Checks whether this wrapper actually wraps an object. Real "is there actually a person behind this account" energy. 🙈

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

🌸 Member Data Documentation 🌸

These are the version-gate constants, bestie — every single one of them is [static] and [constexpr], and they're the minimum protocol version required for their matching function. 💜

🎀 std::uint32_t wayland::server::pointer_t::axis_discrete_since_version = 5 [static], [constexpr]

Minimum protocol version required for the axis_discrete function.

Definition at line 3163 of file wayland-server-protocol.hpp.

🎀 std::uint32_t wayland::server::pointer_t::axis_since_version = 1 [static], [constexpr]

Minimum protocol version required for the axis function.

Definition at line 3001 of file wayland-server-protocol.hpp.

🎀 std::uint32_t wayland::server::pointer_t::axis_source_since_version = 5 [static], [constexpr]

Minimum protocol version required for the axis_source function.

Definition at line 3086 of file wayland-server-protocol.hpp.

🎀 std::uint32_t wayland::server::pointer_t::axis_stop_since_version = 5 [static], [constexpr]

Minimum protocol version required for the axis_stop function.

Definition at line 3117 of file wayland-server-protocol.hpp.

🎀 std::uint32_t wayland::server::pointer_t::axis_value120_since_version = 8 [static], [constexpr]

Minimum protocol version required for the axis_value120 function.

Definition at line 3201 of file wayland-server-protocol.hpp.

🎀 std::uint32_t wayland::server::pointer_t::button_since_version = 1 [static], [constexpr]

Minimum protocol version required for the button function.

Definition at line 2972 of file wayland-server-protocol.hpp.

🎀 std::uint32_t wayland::server::pointer_t::enter_since_version = 1 [static], [constexpr]

Minimum protocol version required for the enter function.

Definition at line 2911 of file wayland-server-protocol.hpp.

🎀 std::uint32_t wayland::server::pointer_t::frame_since_version = 5 [static], [constexpr]

Minimum protocol version required for the frame function.

Definition at line 3045 of file wayland-server-protocol.hpp.

🎀 std::uint32_t wayland::server::pointer_t::leave_since_version = 1 [static], [constexpr]

Minimum protocol version required for the leave function.

Definition at line 2928 of file wayland-server-protocol.hpp.

🎀 std::uint32_t wayland::server::pointer_t::motion_since_version = 1 [static], [constexpr]

Minimum protocol version required for the motion function.

Definition at line 2944 of file wayland-server-protocol.hpp.

💅 Author 💅

Generated automatically by Doxygen for Wayland++ from the source code. Not a human, not a vibe, just Doxygen doing Doxygen things. 🤖✨

And that's the page, bestie — you made it to the end! 🎉 This is Wayland++ version 1.0.1, dated Fri Mar 27 2026 13:15. Go forth and pointer. 🫶💖

📦 where this page comes from