--- name: "wayland_server_zwp_locked_pointer_v1_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_server_zwp_locked_pointer_v1_t" --- # wayland\_server\_zwp\_locked\_pointer\_v1\_t(3) receive relative pointer motion events ## NAME wayland::server::zwp\_locked\_pointer\_v1\_t - receive relative pointer motion events ## SYNOPSIS `#include ` Inherits wayland::server::resource\_t. ### Public Member Functions std::function\< void()\> & **on\_destroy** ()\ destroy the locked pointer object std::function\< void(double, double)\> & **on\_set\_cursor\_position\_hint** ()\ set the pointer cursor position hint std::function\< void(**region\_t**)\> & **on\_set\_region** ()\ set a new lock region void **locked** (bool post=true)\ lock activation event void **unlocked** (bool post=true)\ lock deactivation event bool **proxy\_has\_object** () const\ Check whether this wrapper actually wraps an object. void **post\_no\_memory** () const\ uint32\_t **get\_id** () const\ client\_t **get\_client** () const\ unsigned int **get\_version** () const\ std::string **get\_class** ()\ ### Static Public Attributes static constexpr std::uint32\_t **locked\_since\_version** = 1\ Minimum protocol version required for the **locked** function. static constexpr std::uint32\_t **unlocked\_since\_version** = 1\ Minimum protocol version required for the **unlocked** function. ## Detailed Description receive relative pointer motion events The wp\_locked\_pointer interface represents a locked pointer state. While the lock of this object is active, the wl\_pointer objects of the associated seat will not emit any wl\_pointer.motion events. This object will send the event 'locked' when the lock is activated. Whenever the lock is activated, it is guaranteed that the locked surface will already have received pointer focus and that the pointer will be within the region passed to the request creating this object. To unlock the pointer, send the destroy request. This will also destroy the wp\_locked\_pointer object. If the compositor decides to unlock the pointer the unlocked event is sent. See wp\_locked\_pointer.unlock for details. When unlocking, the compositor may warp the cursor position to the set cursor position hint. If it does, it will not result in any relative motion events emitted via wp\_relative\_pointer. If the surface the lock was requested on is destroyed and the lock is not yet activated, the wp\_locked\_pointer object is now defunct and must be destroyed. Definition at line **2880** 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. ### void zwp\_locked\_pointer\_v1\_t::locked (bool post = `true`) lock activation event Notification that the pointer lock of the seat's pointer is activated. Definition at line **5450** of file **wayland-server-protocol-unstable.cpp**. ### std::function\< void()\> & zwp\_locked\_pointer\_v1\_t::on\_destroy () destroy the locked pointer object Destroy the locked pointer object. If applicable, the compositor will unlock the pointer. Definition at line **5432** of file **wayland-server-protocol-unstable.cpp**. ### std::function\< void(double, double)\> & zwp\_locked\_pointer\_v1\_t::on\_set\_cursor\_position\_hint () set the pointer cursor position hint **Parameters** *surface\_x* surface-local x coordinate \ *surface\_y* surface-local y coordinate Set the cursor position hint relative to the top left corner of the surface. If the client is drawing its own cursor, it should update the position hint to the position of its own cursor. A compositor may use this information to warp the pointer upon unlock in order to avoid pointer jumps. The cursor position hint is double buffered. The new hint will only take effect when the associated surface gets it pending state applied. See wl\_surface.commit for details. Definition at line **5438** of file **wayland-server-protocol-unstable.cpp**. ### std::function\< void(region\_t)\> & zwp\_locked\_pointer\_v1\_t::on\_set\_region () set a new lock region **Parameters** *region* region of surface Set a new region used to lock the pointer. The new lock region is double-buffered. The new lock region will only take effect when the associated surface gets its pending state applied. See wl\_surface.commit for details. For details about the lock region, see wp\_locked\_pointer. Definition at line **5444** 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. ### 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\_locked\_pointer\_v1\_t::unlocked (bool post = `true`) lock deactivation event Notification that the pointer lock of the seat's pointer is no longer active. If this is a oneshot pointer lock (see wp\_pointer\_constraints.lifetime) this object is now defunct and should be destroyed. If this is a persistent pointer lock (see wp\_pointer\_constraints.lifetime) this pointer lock may again reactivate in the future. Definition at line **5455** of file **wayland-server-protocol-unstable.cpp**. ## Member Data Documentation ### constexpr std::uint32\_t wayland::server::zwp\_locked\_pointer\_v1\_t::locked\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **locked** function. Definition at line **2958** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zwp\_locked\_pointer\_v1\_t::unlocked\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **unlocked** function. Definition at line **2974** of file **wayland-server-protocol-unstable.hpp**. ## Author Generated automatically by Doxygen for Wayland++ from the source code.