Enum Event

#[non_exhaustive]
pub enum Event {
    Enter,
    Leave,
    Position {
        x: i32,
        y: i32,
    },
    Hotspot {
        x: i32,
        y: i32,
    },
}

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.

Enter

cursor entered captured area

Sent when a cursor enters the captured area. It shall be generated before the “position” and “hotspot” events when and only when a cursor enters the area.

The cursor enters the captured area when the cursor image intersects with the captured area. Note, this is different from e.g. wl_pointer.enter.

Leave

cursor left captured area

Sent when a cursor leaves the captured area. No “position” or “hotspot” event is generated for the cursor until the cursor enters the captured area again.

Position

position changed

Cursors outside the image source do not get captured and no event will be generated for them.

The given position is the position of the cursor’s hotspot and it is relative to the main buffer’s top left corner in transformed buffer pixel coordinates.

The position coordinates are relative to the main buffer’s upper left corner. The coordinates may be negative or greater than the main buffer size.

Fields

x: i32

position x coordinates

y: i32

position y coordinates

Hotspot

hotspot changed

The hotspot describes the offset between the cursor image and the position of the input device.

The given coordinates are the hotspot’s offset from the origin in buffer coordinates.

Clients should not apply the hotspot immediately: the hotspot becomes effective when the next zcosmic_screencopy_frame_v2.ready event is received.

Fields

x: i32

hotspot x coordinates

y: i32

hotspot y coordinates

Implementations

impl Event

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.