Struct wayland_protocols::unstable::pointer_constraints::v1::generated::client::zwp_locked_pointer_v1::ZwpLockedPointerV1

pub struct ZwpLockedPointerV1(Proxy<ZwpLockedPointerV1>);

Tuple Fields

0: Proxy<ZwpLockedPointerV1>

Implementations

impl ZwpLockedPointerV1

pub fn destroy(&self)

destroy the locked pointer object

Destroy the locked pointer object. If applicable, the compositor will unlock the pointer.

This is a destructor, you cannot send requests to this object any longer once this method is called.

pub fn set_cursor_position_hint(&self, surface_x: f64, surface_y: f64)

set the pointer cursor position hint

Set the cursor position hint relative to the top left corner of the surface.

If the client is drawing its own cursor, it should update the position hint to the position of its own cursor. A compositor may use this information to warp the pointer upon unlock in order to avoid pointer jumps.

The cursor position hint is double buffered. The new hint will only take effect when the associated surface gets it pending state applied. See wl_surface.commit for details.

pub fn set_region(&self, region: Option<&WlRegion>)

set a new lock region

Set a new region used to lock the pointer.

The new lock region is double-buffered. The new lock region will only take effect when the associated surface gets its pending state applied. See wl_surface.commit for details.

For details about the lock region, see wp_locked_pointer.

Trait Implementations

impl AsRef<Proxy<ZwpLockedPointerV1>> for ZwpLockedPointerV1

fn as_ref(&self) -> &Proxy<Self>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ZwpLockedPointerV1

fn clone(&self) -> ZwpLockedPointerV1

Returns a copy 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

Formats the value using the given formatter.

impl From<Proxy<ZwpLockedPointerV1>> for ZwpLockedPointerV1

fn from(value: Proxy<Self>) -> Self

Converts to this type from the input type.

impl From<ZwpLockedPointerV1> for Proxy<ZwpLockedPointerV1>

fn from(value: ZwpLockedPointerV1) -> Self

Converts to this type from the input type.

impl Interface for ZwpLockedPointerV1

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str = "zwp_locked_pointer_v1"

Name of this interface

const VERSION: u32 = 1u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<ZwpLockedPointerV1> for ZwpLockedPointerV1

fn eq(&self, other: &ZwpLockedPointerV1) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ZwpLockedPointerV1

impl StructuralEq for ZwpLockedPointerV1

impl StructuralPartialEq for ZwpLockedPointerV1