---
name: "wayland_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_zwp_locked_pointer_v1_t"
---

# wayland\_zwp\_locked\_pointer\_v1\_t(3)

receive relative pointer motion events

## NAME

wayland::zwp\_locked\_pointer\_v1\_t - receive relative pointer motion events

## SYNOPSIS

`#include <wayland-client-protocol-unstable.hpp>`

Inherits **wayland::proxy\_t**.

### Public Types

enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\

### Public Member Functions

void **set\_cursor\_position\_hint** (double surface\_x, double surface\_y)\
 set the pointer cursor position hint  void **set\_region** (**region\_t** const &region)\
 set a new lock region  std::function\< void()\> & **on\_locked** ()\
 lock activation event  std::function\< void()\> & **on\_unlocked** ()\
 lock deactivation 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\_position\_hint\_since\_version** = 1\
 Minimum protocol version required for the **set\_cursor\_position\_hint** function.  static constexpr std::uint32\_t **set\_region\_since\_version** = 1\
 Minimum protocol version required for the **set\_region** 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 **2608** 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*

### 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()\> & zwp\_locked\_pointer\_v1\_t::on\_locked ()

*lock activation event Notification that the pointer lock of the seat's pointer is activated.*

*Definition at line* **5839** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void()\> & zwp\_locked\_pointer\_v1\_t::on\_unlocked ()

*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* **5844** *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 zwp\_locked\_pointer\_v1\_t::set\_cursor\_position\_hint (double surface\_x, double surface\_y)

*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* **5827** *of file* **wayland-client-protocol-unstable.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***.*

### void zwp\_locked\_pointer\_v1\_t::set\_region (region\_t const & 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* **5833** *of file* **wayland-client-protocol-unstable.cpp***.*

## Member Data Documentation

### constexpr std::uint32\_t wayland::zwp\_locked\_pointer\_v1\_t::set\_cursor\_position\_hint\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_cursor\_position\_hint** *function.*

*Definition at line* **2653** *of file* **wayland-client-protocol-unstable.hpp***.*

### constexpr std::uint32\_t wayland::zwp\_locked\_pointer\_v1\_t::set\_region\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_region** *function.*

*Definition at line* **2671** *of file* **wayland-client-protocol-unstable.hpp***.*

## Author

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