Struct wayland_protocols::unstable::pointer_constraints::v1::client::zwp_confined_pointer_v1::ZwpConfinedPointerV1

pub struct ZwpConfinedPointerV1(/* private fields */);

Implementations

impl ZwpConfinedPointerV1

pub fn destroy(&self)

destroy the confined pointer object

Destroy the confined pointer object. If applicable, the compositor will unconfine the pointer.

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

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

set a new confine region

Set a new region used to confine the pointer.

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

If the confinement is active when the new confinement region is applied and the pointer ends up outside of newly applied region, the pointer may warped to a position within the new confinement region. If warped, a wl_pointer.motion event will be emitted, but no wp_relative_pointer.relative_motion event.

The compositor may also, instead of using the new region, unconfine the pointer.

For details about the confine region, see wp_confined_pointer.

Trait Implementations

impl AsRef<Proxy<ZwpConfinedPointerV1>> for ZwpConfinedPointerV1

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

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

impl Clone for ZwpConfinedPointerV1

fn clone(&self) -> ZwpConfinedPointerV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZwpConfinedPointerV1

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

Formats the value using the given formatter.

impl From<Proxy<ZwpConfinedPointerV1>> for ZwpConfinedPointerV1

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

Converts to this type from the input type.

impl From<ZwpConfinedPointerV1> for Proxy<ZwpConfinedPointerV1>

fn from(value: ZwpConfinedPointerV1) -> Self

Converts to this type from the input type.

impl Interface for ZwpConfinedPointerV1

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_confined_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 for ZwpConfinedPointerV1

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

impl StructuralEq for ZwpConfinedPointerV1

impl StructuralPartialEq for ZwpConfinedPointerV1