Enum Request

pub enum Request {
    Destroy,
    SetRegion {
        region: ObjectId,
    },
}

Variants

Destroy

destroy the confined pointer object

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

SetRegion

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.

Fields

region: ObjectId

region of surface

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl IntoMessage for Request

type Error = EncodeError

fn into_message(self, id: u32) -> Result<Message, <Self as IntoMessage>::Error>

Consumes |self| and serializes into a |Message|.

impl MessageType for Request

fn log(&self, this: ObjectId) -> String

Generates a string suitable for protocol logging this message.

fn message_name(&self) -> &'static CStr

Returns a static CStr reference that describes the interface/method of this message.