--- name: "wayland_zwp_pointer_constraints_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_zwp_pointer_constraints_v1_t" --- # wayland\_zwp\_pointer\_constraints\_v1\_t(3) constrain the movement of a pointer ## NAME wayland::zwp\_pointer\_constraints\_v1\_t - constrain the movement of a pointer ## SYNOPSIS `#include ` Inherits **wayland::proxy\_t**. ### Public Types enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\ ### Public Member Functions **zwp\_locked\_pointer\_v1\_t** **lock\_pointer** (**surface\_t** const &surface, **pointer\_t** const &pointer, **region\_t** const ®ion, zwp\_pointer\_constraints\_v1\_lifetime const &lifetime)\ lock pointer to a position **zwp\_confined\_pointer\_v1\_t** **confine\_pointer** (**surface\_t** const &surface, **pointer\_t** const &pointer, **region\_t** const ®ion, zwp\_pointer\_constraints\_v1\_lifetime const &lifetime)\ confine pointer to a region 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 **lock\_pointer\_since\_version** = 1\ Minimum protocol version required for the **lock\_pointer** function. static constexpr std::uint32\_t **confine\_pointer\_since\_version** = 1\ Minimum protocol version required for the **confine\_pointer** function. ## Detailed Description constrain the movement of a pointer The global interface exposing pointer constraining functionality. It exposes two requests: lock\_pointer for locking the pointer to its position, and confine\_pointer for locking the pointer to a region. The lock\_pointer and confine\_pointer requests create the objects wp\_locked\_pointer and wp\_confined\_pointer respectively, and the client can use these objects to interact with the lock. For any surface, only one lock or confinement may be active across all wl\_pointer objects of the same seat. If a lock or confinement is requested when another lock or confinement is active or requested on the same surface and with any of the wl\_pointer objects of the same seat, an 'already\_constrained' error will be raised. Definition at line **2452** of file **wayland-client-protocol-unstable.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* ### zwp\_confined\_pointer\_v1\_t zwp\_pointer\_constraints\_v1\_t::confine\_pointer (surface\_t const & surface, pointer\_t const & pointer, region\_t const & region, zwp\_pointer\_constraints\_v1\_lifetime const & lifetime) *confine pointer to a region* **Parameters** *surface surface to lock pointer to* \ *pointer the pointer that should be confined* \ *region region of surface* \ *lifetime confinement lifetime* *The confine\_pointer request lets the client request to confine the pointer cursor to a given region. This request may not take effect immediately; in the future, when the compositor deems implementation- specific constraints are satisfied, the pointer confinement will be activated and the compositor sends a confined event.* *The intersection of the region passed with this request and the input region of the surface is used to determine where the pointer must be in order for the confinement to activate. It is up to the compositor whether to warp the pointer or require some kind of user interaction for the confinement to activate. If the region is null the surface input region is used.* *The request will create a new object wp\_confined\_pointer which is used to interact with the confinement as well as receive updates about its state. See the the description of wp\_confined\_pointer for further information.* *Definition at line* **5762** *of file* **wayland-client-protocol-unstable.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***.* ### zwp\_locked\_pointer\_v1\_t zwp\_pointer\_constraints\_v1\_t::lock\_pointer (surface\_t const & surface, pointer\_t const & pointer, region\_t const & region, zwp\_pointer\_constraints\_v1\_lifetime const & lifetime) *lock pointer to a position* **Parameters** *surface surface to lock pointer to* \ *pointer the pointer that should be locked* \ *region region of surface* \ *lifetime lock lifetime* *The lock\_pointer request lets the client request to disable movements of the virtual pointer (i.e. the cursor), effectively locking the pointer to a position. This request may not take effect immediately; in the future, when the compositor deems implementation-specific constraints are satisfied, the pointer lock will be activated and the compositor sends a locked event.* *The protocol provides no guarantee that the constraints are ever satisfied, and does not require the compositor to send an error if the constraints cannot ever be satisfied. It is thus possible to request a lock that will never activate.* *There may not be another pointer constraint of any kind requested or active on the surface for any of the wl\_pointer objects of the seat of the passed pointer when requesting a lock. If there is, an error will be raised. See general pointer lock documentation for more details.* *The intersection of the region passed with this request and the input region of the surface is used to determine where the pointer must be in order for the lock to activate. It is up to the compositor whether to warp the pointer or require some kind of user interaction for the lock to activate. If the region is null the surface input region is used.* *A surface may receive pointer focus without the lock being activated.* *The request creates a new object wp\_locked\_pointer which is used to interact with the lock as well as receive updates about its state. See the the description of wp\_locked\_pointer for further information.* *Note that while a pointer is locked, the wl\_pointer objects of the corresponding seat will not emit any wl\_pointer.motion events, but relative motion events will still be emitted via wp\_relative\_pointer objects of the same seat. wl\_pointer.axis and wl\_pointer.button events are unaffected.* *Definition at line* **5755** *of file* **wayland-client-protocol-unstable.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 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::zwp\_pointer\_constraints\_v1\_t::confine\_pointer\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **confine\_pointer** *function.* *Definition at line* **2551** *of file* **wayland-client-protocol-unstable.hpp***.* ### constexpr std::uint32\_t wayland::zwp\_pointer\_constraints\_v1\_t::lock\_pointer\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **lock\_pointer** *function.* *Definition at line* **2520** *of file* **wayland-client-protocol-unstable.hpp***.* ## Author *Generated automatically by Doxygen for Wayland++ from the source code.*