Struct ZwpLockedPointerV1

pub struct ZwpLockedPointerV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

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.

See also the Request enum for this interface.

Implementations

impl ZwpLockedPointerV1

pub fn locked(&self)

lock activation event

Notification that the pointer lock of the seat’s pointer is activated.

pub fn unlocked(&self)

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.

Trait Implementations

impl Borrow<ObjectId> for ZwpLockedPointerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZwpLockedPointerV1

fn clone(&self) -> ZwpLockedPointerV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZwpLockedPointerV1

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

Formats the value using the given formatter.

impl Hash for ZwpLockedPointerV1

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<ZwpLockedPointerV1>> for ZwpLockedPointerV1

fn eq(&self, other: &Weak<ZwpLockedPointerV1>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ZwpLockedPointerV1

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Resource for ZwpLockedPointerV1

type Request = Request

The request enum for this interface

type Event<'event> = 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>(&self) -> Option<&U>

where U: 'static,

Access the user-data associated with this object

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

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<ZwpLockedPointerV1, InvalidId>

Create an object resource from its ID

fn send_event( &self, evt: <ZwpLockedPointerV1 as Resource>::Event<'_>, ) -> Result<(), InvalidId>

Send an event to this object

fn parse_request( conn: &DisplayHandle, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ZwpLockedPointerV1, <ZwpLockedPointerV1 as Resource>::Request), DispatchError>

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <ZwpLockedPointerV1 as Resource>::Event<'a>, ) -> Result<Message<ObjectId, BorrowedFd<'a>>, InvalidId>

Serialize an event for this object

fn client(&self) -> Option<Client>

The client owning this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

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

Trigger a protocol error on this object

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for ZwpLockedPointerV1