Module wayland_protocols::unstable::pointer_constraints::v1::server::zwp_locked_pointer_v1

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.

Structs

ZwpLockedPointerV1

Enums

Event
Request

Constants

EVT_LOCKED_SINCE	The minimal object version supporting this event
EVT_UNLOCKED_SINCE	The minimal object version supporting this event
REQ_DESTROY_SINCE	The minimal object version supporting this request
REQ_SET_CURSOR_POSITION_HINT_SINCE	The minimal object version supporting this request
REQ_SET_REGION_SINCE	The minimal object version supporting this request