Struct SetInputRegion

pub struct SetInputRegion {
    pub region: Object,
}

set input region

This request sets the region of the surface that can receive pointer and touch events.

Input events happening outside of this region will try the next surface in the server surface stack. The compositor ignores the parts of the input region that fall outside of the surface.

The input region is specified in surface-local coordinates.

Input region is double-buffered state, see wl_surface.commit.

wl_surface.set_input_region changes the pending input region. wl_surface.commit copies the pending region to the current region. Otherwise the pending and current regions are never changed, except cursor and icon surfaces are special cases, see wl_pointer.set_cursor and wl_data_device.start_drag.

The initial value for an input region is infinite. That means the whole surface will accept input. Setting the pending input region has copy semantics, and the wl_region object can be destroyed immediately. A NULL wl_region causes the input region to be set to infinite.

Fields

region: Object

Implementations

impl SetInputRegion

pub const OPCODE: u16 = 5u16

Trait Implementations

impl Clone for SetInputRegion

fn clone(&self) -> SetInputRegion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetInputRegion

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

Formats the value using the given formatter.

impl<'a> Deserialize<'a> for SetInputRegion

fn deserialize(data: &'a [u8], fds: &'a [RawFd]) -> Result<Self, Error>

Deserialize from the given buffer. Returns deserialized message, and number of bytes and file descriptors consumed, respectively.

impl PartialEq for SetInputRegion

fn eq(&self, other: &SetInputRegion) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SetInputRegion

fn serialize<Fds: Extend<OwnedFd>>(self, buf: &mut BytesMut, fds: &mut Fds)

Serialize into the buffered writer. This function returns no errors, failures in seializing are generally program errors, and triggers panicking.

fn len(&self) -> u16

How many bytes will this message serialize to. Including the 8 byte header.

fn nfds(&self) -> u8

How many file descriptors will this message serialize to.

impl Copy for SetInputRegion

impl Eq for SetInputRegion

impl StructuralPartialEq for SetInputRegion