Struct wayland_protocols::unstable::pointer_constraints::v1::client::zwp_pointer_constraints_v1::ZwpPointerConstraintsV1

pub struct ZwpPointerConstraintsV1(_);

Implementations

impl ZwpPointerConstraintsV1

pub fn destroy(&self)

destroy the pointer constraints manager object

Used by the client to notify the server that it will no longer use this pointer constraints object.

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

pub fn lock_pointer(
    &self,
    surface: &WlSurface,
    pointer: &WlPointer,
    region: Option<&WlRegion>,
    lifetime: Lifetime
) -> Main<ZwpLockedPointerV1>

lock pointer to a position

The lock_pointer request lets the client request to disable movements of the virtual pointer (i.e. the cursor), effectively locking the pointer to a position. This request may not take effect immediately; in the future, when the compositor deems implementation-specific constraints are satisfied, the pointer lock will be activated and the compositor sends a locked event.

The protocol provides no guarantee that the constraints are ever satisfied, and does not require the compositor to send an error if the constraints cannot ever be satisfied. It is thus possible to request a lock that will never activate.

There may not be another pointer constraint of any kind requested or active on the surface for any of the wl_pointer objects of the seat of the passed pointer when requesting a lock. If there is, an error will be raised. See general pointer lock documentation for more details.

The intersection of the region passed with this request and the input region of the surface is used to determine where the pointer must be in order for the lock to activate. It is up to the compositor whether to warp the pointer or require some kind of user interaction for the lock to activate. If the region is null the surface input region is used.

A surface may receive pointer focus without the lock being activated.

The request creates a new object wp_locked_pointer which is used to interact with the lock as well as receive updates about its state. See the the description of wp_locked_pointer for further information.

Note that while a pointer is locked, the wl_pointer objects of the corresponding seat will not emit any wl_pointer.motion events, but relative motion events will still be emitted via wp_relative_pointer objects of the same seat. wl_pointer.axis and wl_pointer.button events are unaffected.

pub fn confine_pointer(
    &self,
    surface: &WlSurface,
    pointer: &WlPointer,
    region: Option<&WlRegion>,
    lifetime: Lifetime
) -> Main<ZwpConfinedPointerV1>

confine pointer to a region

The confine_pointer request lets the client request to confine the pointer cursor to a given region. This request may not take effect immediately; in the future, when the compositor deems implementation- specific constraints are satisfied, the pointer confinement will be activated and the compositor sends a confined event.

The intersection of the region passed with this request and the input region of the surface is used to determine where the pointer must be in order for the confinement to activate. It is up to the compositor whether to warp the pointer or require some kind of user interaction for the confinement to activate. If the region is null the surface input region is used.

The request will create a new object wp_confined_pointer which is used to interact with the confinement as well as receive updates about its state. See the the description of wp_confined_pointer for further information.

Trait Implementations

impl AsRef<Proxy<ZwpPointerConstraintsV1>> for ZwpPointerConstraintsV1

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

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

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 From<Proxy<ZwpPointerConstraintsV1>> for ZwpPointerConstraintsV1

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

Converts to this type from the input type.

impl From<ZwpPointerConstraintsV1> for Proxy<ZwpPointerConstraintsV1>

fn from(value: ZwpPointerConstraintsV1) -> Self

Converts to this type from the input type.

impl Interface for ZwpPointerConstraintsV1

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_pointer_constraints_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<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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ZwpPointerConstraintsV1

impl StructuralEq for ZwpPointerConstraintsV1

impl StructuralPartialEq for ZwpPointerConstraintsV1