Enum Event

#[non_exhaustive]
pub enum Event {
    Transform {
        transform: WEnum<Transform>,
    },
    Damage {
        x: i32,
        y: i32,
        width: i32,
        height: i32,
    },
    PresentationTime {
        tv_sec_hi: u32,
        tv_sec_lo: u32,
        tv_nsec: u32,
    },
    Ready,
    Failed {
        reason: WEnum<FailureReason>,
    },
}

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.

Transform

buffer transform

This event is sent before the ready event and holds the transform of the source buffer.

Fields

transform: WEnum<Transform>

Damage

buffer damaged region

This event is sent before the ready event. It may be generated multiple times to describe a region.

The first captured frame in a session will always carry full damage. Subsequent frames’ damaged regions describe which parts of the buffer have changed since the last ready event.

These coordinates originate in the upper left corner of the buffer.

Fields

x: i32

damage x coordinate

y: i32

damage y coordinate

width: i32

damage width

height: i32

damage height

PresentationTime

presentation time of the frame

This event indicates the time at which the frame is presented to the output in system monotonic time. This event is sent before the ready event.

The timestamp is expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples, each component being an unsigned 32-bit value. Whole seconds are in tv_sec which is a 64-bit value combined from tv_sec_hi and tv_sec_lo, and the additional fractional part in tv_nsec as nanoseconds. Hence, for valid timestamps tv_nsec must be in [0, 999999999].

Fields

tv_sec_hi: u32

high 32 bits of the seconds part of the timestamp

tv_sec_lo: u32

low 32 bits of the seconds part of the timestamp

tv_nsec: u32

nanoseconds part of the timestamp

Ready

frame is available for reading

Called as soon as the frame is copied, indicating it is available for reading.

The buffer may be re-used by the client after this event.

After receiving this event, the client must destroy the object.

Failed

capture failed

This event indicates that the attempted frame copy has failed.

After receiving this event, the client must destroy the object.

Fields

reason: WEnum<FailureReason>

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.