Enum wayland_protocols::wlr::unstable::export_dmabuf::v1::client::zwlr_export_dmabuf_frame_v1::Event

#[non_exhaustive]
pub enum Event {
    Frame {
        width: u32,
        height: u32,
        offset_x: u32,
        offset_y: u32,
        buffer_flags: u32,
        flags: Flags,
        format: u32,
        mod_high: u32,
        mod_low: u32,
        num_objects: u32,
    },
    Object {
        index: u32,
        fd: RawFd,
        size: u32,
        offset: u32,
        stride: u32,
        plane_index: u32,
    },
    Ready {
        tv_sec_hi: u32,
        tv_sec_lo: u32,
        tv_nsec: u32,
    },
    Cancel {
        reason: CancelReason,
    },
}

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.

Frame

a frame description

Main event supplying the client with information about the frame. If the capture didn’t fail, this event is always emitted first before any other events.

This event is followed by a number of “object” as specified by the “num_objects” argument.

Fields of Frame

width: u32height: u32offset_x: u32offset_y: u32buffer_flags: u32flags: Flagsformat: u32mod_high: u32mod_low: u32num_objects: u32

Object

an object description

Event which serves to supply the client with the file descriptors containing the data for each object.

After receiving this event, the client must always close the file descriptor as soon as they’re done with it and even if the frame fails.

Fields of Object

index: u32fd: RawFdsize: u32offset: u32stride: u32plane_index: u32

Ready

indicates frame is available for reading

This event is sent as soon as the frame is presented, 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 this object.

Fields of Ready

tv_sec_hi: u32tv_sec_lo: u32tv_nsec: u32

Cancel

indicates the frame is no longer valid

If the capture failed or if the frame is no longer valid after the “frame” event has been emitted, this event will be used to inform the client to scrap the frame.

If the failure is temporary, the client may capture again the same source. If the failure is permanent, any further attempts to capture the same source will fail again.

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

Fields of Cancel

reason: CancelReason

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.

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 since(&self) -> u32

The minimal object version for which this message exists

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