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 Event enum for this interface.

Implementations

impl ZwlrExportDmabufFrameV1

pub fn destroy(&self)

delete this object, used or not

Unreferences the frame. This request must be called as soon as its no longer used.

It can be called at any time by the client. The client will still have to close any FDs it has been given.

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 Proxy for ZwlrExportDmabufFrameV1

type Request<'request> = Request<'request>

The request enum for this interface

type 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: Send + Sync + 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request( &self, req: <ZwlrExportDmabufFrameV1 as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I>( &self, req: <ZwlrExportDmabufFrameV1 as Proxy>::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

where I: Proxy,

Send a request for this object that creates another object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> ZwlrExportDmabufFrameV1

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ZwlrExportDmabufFrameV1, <ZwlrExportDmabufFrameV1 as Proxy>::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <ZwlrExportDmabufFrameV1 as Proxy>::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

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

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

Creates a weak handle to this object

impl Eq for ZwlrExportDmabufFrameV1