Struct wayland_protocols::wp::pointer_constraints::zv1::server::zwp_pointer_constraints_v1::ZwpPointerConstraintsV1

pub struct ZwpPointerConstraintsV1 { /* private fields */ }

Available on crate features unstable and server only.

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.

See also the Request enum for this interface.

Trait Implementations

impl Clone for ZwpPointerConstraintsV1

fn clone(&self) -> ZwpPointerConstraintsV1

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ZwpPointerConstraintsV1

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

Formats the value using the given formatter.

impl PartialEq<ZwpPointerConstraintsV1> for ZwpPointerConstraintsV1

fn eq(&self, other: &ZwpPointerConstraintsV1) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Resource for ZwpPointerConstraintsV1

type Request = Request

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U: 'static>(&self) -> Option<&U>

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn Any + Send + Sync>>

Access the raw data associated with this object.

fn handle(&self) -> &WeakHandle

Access the backend handle associated with this object

fn from_id(conn: &DisplayHandle, id: ObjectId) -> Result<Self, InvalidId>

Create an object resource from its ID

fn send_event(&self, evt: Self::Event) -> Result<(), InvalidId>

Send an event to this object

fn parse_request(
    conn: &DisplayHandle,
    msg: Message<ObjectId>
) -> Result<(Self, Self::Request), DispatchError>

Parse a event for this object

fn write_event(
    &self,
    conn: &DisplayHandle,
    msg: Self::Event
) -> Result<Message<ObjectId>, InvalidId>

Serialize an event for this object

fn client_id(&self) -> Option<ClientId>

The ID of the client owning this object

fn post_error(&self, code: impl Into<u32>, error: impl Into<String>)

Trigger a protocol error on this object

impl Eq for ZwpPointerConstraintsV1