Enum wayland_protocols::wlr::unstable::screencopy::v1::client::zwlr_screencopy_frame_v1::Event

pub enum Event {
    Buffer {
        format: u32,
        width: u32,
        height: u32,
        stride: u32,
    },
    Flags {
        flags: Flags,
    },
    Ready {
        tv_sec_hi: u32,
        tv_sec_lo: u32,
        tv_nsec: u32,
    },
    Failed,
}

Variants

Buffer

buffer information

Provides information about the frame's buffer. This event is sent once as soon as the frame is created.

The client should then create a buffer with the provided attributes, and send a "copy" request.

Fields of Buffer

format: u32width: u32height: u32stride: u32

Flags

frame flags

Provides flags about the frame. This event is sent once before the "ready" event.

Fields of Flags

flags: Flags

Ready

indicates frame is available for reading

Called as soon as the frame is copied, indicating it is available for reading. This event includes the time at which presentation happened at.

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]. The seconds part may have an arbitrary offset at start.

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

Fields of Ready

tv_sec_hi: u32tv_sec_lo: u32tv_nsec: u32

Failed

frame copy failed

This event indicates that the attempted frame copy has failed.

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

Trait Implementations

impl MessageGroup for Event

const MESSAGES: &'static [MessageDesc]

Wire representation of this MessageGroup

type Map = ProxyMap

The wrapper type for ObjectMap allowing the mapping of Object and NewId arguments to the object map during parsing.

fn is_destructor(&self) -> bool

Whether this message is a destructor

fn opcode(&self) -> u16

The opcode of this message

fn child<Meta: ObjectMetadata>(
    opcode: u16,
    version: u32,
    meta: &Meta
) -> Option<Object<Meta>>

Retrieve the child Object associated with this message if any

fn from_raw(msg: Message, map: &mut Self::Map) -> Result<Self, ()>

Construct a message from its raw representation

fn into_raw(self, sender_id: u32) -> Message

Turn this message into its raw representation

unsafe fn from_raw_c(
    obj: *mut c_void,
    opcode: u32,
    args: *const wl_argument
) -> Result<Event, ()>

Construct a message of this group from its C representation

fn as_raw_c_in<F, T>(self, f: F) -> T where
    F: FnOnce(u32, &mut [wl_argument]) -> T, 

Build a C representation of this message