Struct WpPointerWarpV1

pub struct WpPointerWarpV1 { /* private fields */ }

reposition the pointer to a location on a surface

This global interface allows applications to request the pointer to be moved to a position relative to a wl_surface.

Note that if the desired behavior is to constrain the pointer to an area or lock it to a position, this protocol does not provide a reliable way to do that. The pointer constraint and pointer lock protocols should be used for those use cases instead.

Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.

This interface has no events.

Implementations

impl WpPointerWarpV1

pub fn destroy(&self)

destroy the warp manager

Destroy the pointer warp manager.

pub fn warp_pointer( &self, surface: &WlSurface, pointer: &WlPointer, x: f64, y: f64, serial: u32, )

reposition the pointer

Request the compositor to move the pointer to a surface-local position. Whether or not the compositor honors the request is implementation defined, but it should

• honor it if the surface has pointer focus, including when it has an implicit pointer grab
• reject it if the enter serial is incorrect
• reject it if the requested position is outside of the surface

Note that the enter serial is valid for any surface of the client, and does not have to be from the surface the pointer is warped to.

Trait Implementations

impl Borrow<ObjectId> for WpPointerWarpV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpPointerWarpV1

fn clone(&self) -> WpPointerWarpV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WpPointerWarpV1

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

Formats the value using the given formatter.

impl Hash for WpPointerWarpV1

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

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<WpPointerWarpV1>> for WpPointerWarpV1

fn eq(&self, other: &Weak<WpPointerWarpV1>) -> 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 WpPointerWarpV1

fn eq(&self, other: &WpPointerWarpV1) -> 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 Proxy for WpPointerWarpV1

type Request<'request> = 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: Send + Sync + 'static>(&self) -> Option<&U>

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

Send a request for this object that creates another object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> Self

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(Self, Self::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

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

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

Creates a weak handle to this object

impl Eq for WpPointerWarpV1