Enum wayland_protocols::wp::pointer_constraints::zv1::server::zwp_confined_pointer_v1::Request

#[non_exhaustive]
pub enum Request {
    Destroy,
    SetRegion {
        region: Option<WlRegion>,
    },
}

Available on crate features unstable and server only.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Destroy

destroy the confined pointer object

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

This is a destructor, once received this object cannot be used any longer.

SetRegion

Fields

region: Option<WlRegion>

region of surface

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 Debug for Request

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

Formats the value using the given formatter.