Struct ZwpLockedPointerV1

pub struct ZwpLockedPointerV1;

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.

Trait Implementations

impl Debug for ZwpLockedPointerV1

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Interface for ZwpLockedPointerV1

const NAME: &'static str = "zwp_locked_pointer_v1"

The name of this interface. This will correspond to the ‘name’ attribute on the ‘interface’ element in the wayland protocol XML.

const VERSION: u32 = 1u32

The version of this interface. This will correspond to the ‘version’ attribute on the ‘interface’ element in the wayland protocol XML.

const REQUESTS: MessageGroupSpec = _

A description of the structure of request messages.

const EVENTS: MessageGroupSpec = _

A description of the structure of event messages.

type Incoming = Event

The rust type that can hold the decoded incoming messages.

type Outgoing = Request

The rust type that can be decoded into outgoing messages.