Struct ZcosmicScreencopyFrameV2

pub struct ZcosmicScreencopyFrameV2 { /* private fields */ }

screen capture frame

This object represents a screen capture frame.

The client should attach a buffer, damage the buffer, and then send a capture request.

If the screen capture is successful, the compositor will send the frame metadata (transform, damage, presentation_time in any order) followed by the ready event.

If the screen capture fails, the compositor will send the failed event.

See also the Request enum for this interface.

Implementations

impl ZcosmicScreencopyFrameV2

pub fn transform(&self, transform: Transform)

buffer transform

This event is sent before the ready event and holds the transform of the source buffer.

pub fn damage(&self, x: i32, y: i32, width: i32, height: i32)

buffer damaged region

This event is sent before the ready event. It may be generated multiple times to describe a region.

The first captured frame in a session will always carry full damage. Subsequent frames’ damaged regions describe which parts of the buffer have changed since the last ready event.

These coordinates originate in the upper left corner of the buffer.

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

presentation time of the frame

This event indicates the time at which the frame is presented to the output in system monotonic time. This event is sent before the ready event.

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].

pub fn ready(&self)

frame is available for reading

Called as soon as the frame is copied, indicating it is available for reading.

The buffer may be re-used by the client after this event.

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

pub fn failed(&self, reason: FailureReason)

capture failed

This event indicates that the attempted frame copy has failed.

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

Trait Implementations

impl Borrow<ObjectId> for ZcosmicScreencopyFrameV2

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZcosmicScreencopyFrameV2

fn clone(&self) -> ZcosmicScreencopyFrameV2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZcosmicScreencopyFrameV2

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

Formats the value using the given formatter.

impl Hash for ZcosmicScreencopyFrameV2

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

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<ZcosmicScreencopyFrameV2>> for ZcosmicScreencopyFrameV2

fn eq(&self, other: &Weak<ZcosmicScreencopyFrameV2>) -> 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 ZcosmicScreencopyFrameV2

fn eq(&self, other: &ZcosmicScreencopyFrameV2) -> 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 ZcosmicScreencopyFrameV2

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: 'static>(&self) -> Option<&U>

Access the user-data associated with this object

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

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<Self, InvalidId>

Create an object resource from its ID

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

Send an event to this object

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

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: Self::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 ZcosmicScreencopyFrameV2