Struct wayland_protocols::wlr::unstable::export_dmabuf::v1::server::zwlr_export_dmabuf_frame_v1::ZwlrExportDmabufFrameV1

pub struct ZwlrExportDmabufFrameV1(_);

Implementations

impl ZwlrExportDmabufFrameV1

pub fn frame(
    &self,
    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
)

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.

pub fn object(
    &self,
    index: u32,
    fd: RawFd,
    size: u32,
    offset: u32,
    stride: u32,
    plane_index: u32
)

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.

pub fn ready(&self, tv_sec_hi: u32, tv_sec_lo: u32, tv_nsec: u32)

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.

pub fn cancel(&self, reason: CancelReason)

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.

Trait Implementations

impl AsRef<Resource<ZwlrExportDmabufFrameV1>> for ZwlrExportDmabufFrameV1

fn as_ref(&self) -> &Resource<Self>

Performs the conversion.

impl Clone for ZwlrExportDmabufFrameV1

fn clone(&self) -> ZwlrExportDmabufFrameV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZwlrExportDmabufFrameV1

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

Formats the value using the given formatter.

impl Eq for ZwlrExportDmabufFrameV1

impl From<Resource<ZwlrExportDmabufFrameV1>> for ZwlrExportDmabufFrameV1

fn from(value: Resource<Self>) -> Self

Performs the conversion.

impl From<ZwlrExportDmabufFrameV1> for Resource<ZwlrExportDmabufFrameV1>

fn from(value: ZwlrExportDmabufFrameV1) -> Self

Performs the conversion.

impl Interface for ZwlrExportDmabufFrameV1

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str

Name of this interface

const VERSION: u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<ZwlrExportDmabufFrameV1> for ZwlrExportDmabufFrameV1

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for ZwlrExportDmabufFrameV1

impl StructuralPartialEq for ZwlrExportDmabufFrameV1