Struct ZwlrExportDmabufFrameV1

pub struct ZwlrExportDmabufFrameV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

a DMA-BUF frame

This object represents a single DMA-BUF frame.

If the capture is successful, the compositor will first send a “frame” event, followed by one or several “object”. When the frame is available for readout, the “ready” event is sent.

If the capture failed, the “cancel” event is sent. This can happen anytime before the “ready” event.

Once either a “ready” or a “cancel” event is received, the client should destroy the frame. Once an “object” event is received, the client is responsible for closing the associated file descriptor.

All frames are read-only and may not be written into or altered.

See also the Request enum for this interface.

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: BorrowedFd<'_>, 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 Borrow<ObjectId> for ZwlrExportDmabufFrameV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZwlrExportDmabufFrameV1

fn clone(&self) -> ZwlrExportDmabufFrameV1

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Hash for ZwlrExportDmabufFrameV1

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<ZwlrExportDmabufFrameV1>> for ZwlrExportDmabufFrameV1

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ZwlrExportDmabufFrameV1

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Resource for ZwlrExportDmabufFrameV1

type Request = Request

The request enum for this interface

type Event<'event> = Event<'event>

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U>(&self) -> Option<&U>

where U: 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn Any + Sync + Send>>

Access the raw data associated with this object.

fn handle(&self) -> &WeakHandle

Access the backend handle associated with this object

fn from_id( conn: &DisplayHandle, id: ObjectId, ) -> Result<ZwlrExportDmabufFrameV1, InvalidId>

Create an object resource from its ID

fn send_event( &self, evt: <ZwlrExportDmabufFrameV1 as Resource>::Event<'_>, ) -> Result<(), InvalidId>

Send an event to this object

fn parse_request( conn: &DisplayHandle, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ZwlrExportDmabufFrameV1, <ZwlrExportDmabufFrameV1 as Resource>::Request), DispatchError>

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <ZwlrExportDmabufFrameV1 as Resource>::Event<'a>, ) -> Result<Message<ObjectId, BorrowedFd<'a>>, InvalidId>

Serialize an event for this object

fn client(&self) -> Option<Client>

The client owning this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn post_error(&self, code: impl Into<u32>, error: impl Into<String>)

Trigger a protocol error on this object

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for ZwlrExportDmabufFrameV1