Enum wayland_protocols::wp::pointer_constraints::zv1::client::zwp_locked_pointer_v1::Request

#[non_exhaustive]
pub enum Request<'a> {
    Destroy,
    SetCursorPositionHint {
        surface_x: f64,
        surface_y: f64,
    },
    SetRegion {
        region: Option<WlRegion>,
    },
}

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 locked pointer object

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

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

SetCursorPositionHint

Fields

surface_x: f64

surface-local x coordinate

surface_y: f64

surface-local y coordinate

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.

SetRegion

Fields

region: Option<WlRegion>

region of surface

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.

Implementations

impl<'a> Request<'a>

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.