Struct zwp_pointer_constraints_v1_client_protocol::zwp_confined_pointer_v1::ZwpConfinedPointerV1

pub struct ZwpConfinedPointerV1;

confined pointer object

The wp_confined_pointer interface represents a confined pointer state.

This object will send the event ‘confined’ when the confinement is activated. Whenever the confinement is activated, it is guaranteed that the surface the pointer is confined to will already have received pointer focus and that the pointer will be within the region passed to the request creating this object. It is up to the compositor to decide whether this requires some user interaction and if the pointer will warp to within the passed region if outside.

To unconfine the pointer, send the destroy request. This will also destroy the wp_confined_pointer object.

If the compositor decides to unconfine the pointer the unconfined event is sent. The wp_confined_pointer object is at this point defunct and should be destroyed.

Trait Implementations

impl Debug for ZwpConfinedPointerV1

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

Formats the value using the given formatter.

impl Interface for ZwpConfinedPointerV1

const NAME: &'static str = "zwp_confined_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.