--- name: "wayland_pointer_t" section: "3" platform: "linux" package: "waylandpp-dev" version: "1.0.0-6+b2" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/wayland_pointer_t" --- # wayland\_pointer\_t(3) pointer input device ## NAME wayland::pointer\_t - pointer input device ## SYNOPSIS `#include ` Inherits **wayland::proxy\_t**. ### Public Types enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\ ### Public Member Functions void **set\_cursor** (uint32\_t serial, **surface\_t** const &surface, int32\_t hotspot\_x, int32\_t hotspot\_y)\ set the pointer surface void **release** ()\ release the pointer object bool **can\_release** () const\ Check whether the **release** function is available with the currently bound version of the protocol. std::function\< void(uint32\_t, **surface\_t**, double, double)\> & **on\_enter** ()\ enter event std::function\< void(uint32\_t, **surface\_t**)\> & **on\_leave** ()\ leave event std::function\< void(uint32\_t, double, double)\> & **on\_motion** ()\ pointer motion event std::function\< void(uint32\_t, uint32\_t, uint32\_t, pointer\_button\_state)\> & **on\_button** ()\ pointer button event std::function\< void(uint32\_t, pointer\_axis, double)\> & **on\_axis** ()\ axis event std::function\< void()\> & **on\_frame** ()\ end of a pointer event sequence std::function\< void(pointer\_axis\_source)\> & **on\_axis\_source** ()\ axis source event std::function\< void(uint32\_t, pointer\_axis)\> & **on\_axis\_stop** ()\ axis stop event std::function\< void(pointer\_axis, int32\_t)\> & **on\_axis\_discrete** ()\ axis click event std::function\< void(pointer\_axis, int32\_t)\> & **on\_axis\_value120** ()\ axis high-resolution scroll event 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 **set\_cursor\_since\_version** = 1\ Minimum protocol version required for the **set\_cursor** function. static constexpr std::uint32\_t **release\_since\_version** = 3\ Minimum protocol version required for the **release** function. ## Detailed Description pointer input device 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. **Examples** **egl.cpp**, and **shm.cpp**. Definition at line **2688** of file **wayland-client-protocol.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* **116** *of file* **wayland-client.hpp***.* ## Member Function Documentation ### wl\_proxy \* wayland::proxy\_t::c\_ptr () const` [inherited]` *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* ### bool pointer\_t::can\_release () const *Check whether the* **release** *function is available with the currently bound version of the protocol.* *Definition at line* **2971** *of file* **wayland-client-protocol.cpp***.* ### std::string wayland::proxy\_t::get\_class () const` [inherited]` *Get the interface name (class) of a proxy object.* **Returns** *The interface name of the object associated with the proxy* ### uint32\_t wayland::proxy\_t::get\_id () const` [inherited]` *Get the id of a proxy object.* **Returns** *The id the object associated with the proxy* ### uint32\_t wayland::proxy\_t::get\_version () const` [inherited]` *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* ### wrapper\_type wayland::proxy\_t::get\_wrapper\_type () const` [inline]`, ` [inherited]` *Get the type of a proxy object.* *Definition at line* **302** *of file* **wayland-client.hpp***.* ### std::function\< void(uint32\_t, pointer\_axis, double)\> & pointer\_t::on\_axis () *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.* *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* **2997** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(pointer\_axis, int32\_t)\> & pointer\_t::on\_axis\_discrete () *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).* *This event is deprecated with wl\_pointer version 8 - this event is not sent to clients supporting version 8 or later.* *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* **3017** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(pointer\_axis\_source)\> & pointer\_t::on\_axis\_source () *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.* *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* **3007** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(uint32\_t, pointer\_axis)\> & pointer\_t::on\_axis\_stop () *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* **3012** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(pointer\_axis, int32\_t)\> & pointer\_t::on\_axis\_value120 () *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.* *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* **3022** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(uint32\_t, uint32\_t, uint32\_t, pointer\_button\_state)\> & pointer\_t::on\_button () *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.* *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. All other button codes above 0xFFFF are currently undefined but may be used in future versions of this protocol.* **Examples** **egl.cpp***, and* **shm.cpp***.* *Definition at line* **2992** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(uint32\_t, surface\_t, double, double)\> & pointer\_t::on\_enter () *enter event* **Parameters** *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* *Notification that this seat's pointer is focused on a certain surface.* *When a seat's focus enters a surface, the pointer image is undefined and a client should respond to this event by setting an appropriate pointer image with the set\_cursor request.* **Examples** **egl.cpp***, and* **shm.cpp***.* *Definition at line* **2977** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void()\> & pointer\_t::on\_frame () *end of a pointer event sequence 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.* *All wl\_pointer events before a wl\_pointer.frame event belong logically together. For example, 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.* *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.* *The wl\_pointer.enter and wl\_pointer.leave events are logical events generated by the compositor and not the hardware. These events are 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, 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.* *Definition at line* **3002** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(uint32\_t, surface\_t)\> & pointer\_t::on\_leave () *leave event* **Parameters** *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.* *The leave notification is sent before the enter notification for the new focus.* *Definition at line* **2982** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(uint32\_t, double, double)\> & pointer\_t::on\_motion () *pointer motion event* **Parameters** *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.* *Definition at line* **2987** *of file* **wayland-client-protocol.cpp***.* ### wayland::proxy\_t::operator bool () const` [inherited]` *Check whether this wrapper actually wraps an object.* **Returns** *true if there is an underlying object, false if this wrapper is empty* ### bool wayland::proxy\_t::operator!= (const proxy\_t & right) const` [inherited]` *Check whether two wrappers refer to different objects.* ### bool wayland::proxy\_t::operator== (const proxy\_t & right) const` [inherited]` *Check whether two wrappers refer to the same object.* ### bool wayland::proxy\_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 wayland::proxy\_t::proxy\_release ()` [inherited]` *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***.* ### void pointer\_t::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.* *This request destroys the pointer proxy object, so clients must not call wl\_pointer\_destroy() after using this request.* *Definition at line* **2966** *of file* **wayland-client-protocol.cpp***.* ### void pointer\_t::set\_cursor (uint32\_t serial, surface\_t const & surface, int32\_t hotspot\_x, int32\_t hotspot\_y) *set the pointer surface* **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. If the surface already has another role, it raises a protocol error.* *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.* *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.* *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.* *The serial parameter must match the latest wl\_pointer.enter serial number sent to the client. Otherwise the request will be ignored.* **Examples** **egl.cpp***, and* **shm.cpp***.* *Definition at line* **2960** *of file* **wayland-client-protocol.cpp***.* ### void wayland::proxy\_t::set\_queue (event\_queue\_t queue)` [inherited]` *Assign 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***.* ## Member Data Documentation ### constexpr std::uint32\_t wayland::pointer\_t::release\_since\_version = 3` [static]`, ` [constexpr]` *Minimum protocol version required for the* **release** *function.* *Definition at line* **2782** *of file* **wayland-client-protocol.hpp***.* ### constexpr std::uint32\_t wayland::pointer\_t::set\_cursor\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **set\_cursor** *function.* *Definition at line* **2767** *of file* **wayland-client-protocol.hpp***.* ## Author *Generated automatically by Doxygen for Wayland++ from the source code.*