Struct wayland_protocols::wlr::unstable::screencopy::v1::server::zwlr_screencopy_frame_v1::ZwlrScreencopyFrameV1

pub struct ZwlrScreencopyFrameV1(_);

Implementations

impl ZwlrScreencopyFrameV1

pub fn buffer(&self, format: Format, width: u32, height: u32, stride: u32)

wl_shm buffer information

Provides information about wl_shm buffer parameters that need to be used for this frame. This event is sent once after the frame is created if wl_shm buffers are supported.

pub fn flags(&self, flags: Flags)

frame flags

Provides flags about the frame. This event is sent once before the "ready" event.

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

indicates frame is available for reading

Called as soon as the frame is copied, 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 the object.

pub fn failed(&self)

frame copy failed

This event indicates that the attempted frame copy has failed.

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

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

carries the coordinates of the damaged region

This event is sent right before the ready event when copy_with_damage is requested. It may be generated multiple times for each copy_with_damage request.

The arguments describe a box around an area that has changed since the last copy request that was derived from the current screencopy manager instance.

The union of all regions received between the call to copy_with_damage and a ready event is the total damage since the prior ready event.

Only available since version 2 of the interface.

pub fn linux_dmabuf(&self, format: u32, width: u32, height: u32)

linux-dmabuf buffer information

Provides information about linux-dmabuf buffer parameters that need to be used for this frame. This event is sent once after the frame is created if linux-dmabuf buffers are supported.

Only available since version 3 of the interface.

pub fn buffer_done(&self)

all buffer types reported

This event is sent once after all buffer events have been sent.

The client should proceed to create a buffer of one of the supported types, and send a "copy" request.

Only available since version 3 of the interface.

Trait Implementations

impl AsRef<Resource<ZwlrScreencopyFrameV1>> for ZwlrScreencopyFrameV1

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

Performs the conversion.

impl Clone for ZwlrScreencopyFrameV1

fn clone(&self) -> ZwlrScreencopyFrameV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZwlrScreencopyFrameV1

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

Formats the value using the given formatter.

impl Eq for ZwlrScreencopyFrameV1

impl From<Resource<ZwlrScreencopyFrameV1>> for ZwlrScreencopyFrameV1

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

Performs the conversion.

impl From<ZwlrScreencopyFrameV1> for Resource<ZwlrScreencopyFrameV1>

fn from(value: ZwlrScreencopyFrameV1) -> Self

Performs the conversion.

impl Interface for ZwlrScreencopyFrameV1

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

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

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

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

This method tests for !=.

impl StructuralEq for ZwlrScreencopyFrameV1

impl StructuralPartialEq for ZwlrScreencopyFrameV1