Struct ExtImageCopyCaptureFrameV1

pub struct ExtImageCopyCaptureFrameV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

image capture frame

This object represents an image capture frame.

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

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

If the capture fails, the compositor must send the failed event.

See also the Event enum for this interface.

Implementations

impl ExtImageCopyCaptureFrameV1

pub fn destroy(&self)

destroy this object

Destroys the frame. This request can be sent at any time by the client.

pub fn attach_buffer(&self, buffer: &WlBuffer)

attach buffer to session

Attach a buffer to the session.

The wl_buffer.release request is unused.

The new buffer replaces any previously attached buffer.

This request must not be sent after capture, or else the already_captured protocol error is raised.

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

damage buffer

Apply damage to the buffer which is to be captured next. This request may be sent multiple times to describe a region.

The client indicates the accumulated damage since this wl_buffer was last captured. During capture, the compositor will update the buffer with at least the union of the region passed by the client and the region advertised by ext_image_copy_capture_frame_v1.damage.

When a wl_buffer is captured for the first time, or when the client doesn’t track damage, the client must damage the whole buffer.

This is for optimisation purposes. The compositor may use this information to reduce copying.

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

If x or y are strictly negative, or if width or height are negative or zero, the invalid_buffer_damage protocol error is raised.

This request must not be sent after capture, or else the already_captured protocol error is raised.

pub fn capture(&self)

capture a frame

Capture a frame.

Unless this is the first successful captured frame performed in this session, the compositor may wait an indefinite amount of time for the source content to change before performing the copy.

This request may only be sent once, or else the already_captured protocol error is raised. A buffer must be attached before this request is sent, or else the no_buffer protocol error is raised.

Trait Implementations

impl Borrow<ObjectId> for ExtImageCopyCaptureFrameV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ExtImageCopyCaptureFrameV1

fn clone(&self) -> ExtImageCopyCaptureFrameV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtImageCopyCaptureFrameV1

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

Formats the value using the given formatter.

impl<D, U> Dispatch<ExtImageCopyCaptureFrameV1, U, D> for ScreencopyState

where D: Dispatch<ExtImageCopyCaptureFrameV1, U> + ScreencopyHandler, U: ScreencopyFrameDataExt,

fn event( app_data: &mut D, screencopy_frame: &ExtImageCopyCaptureFrameV1, event: Event, udata: &U, conn: &Connection, qh: &QueueHandle<D>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, _qhandle: &QueueHandle<State>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Hash for ExtImageCopyCaptureFrameV1

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

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

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

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: <ExtImageCopyCaptureFrameV1 as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I>( &self, req: <ExtImageCopyCaptureFrameV1 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<ExtImageCopyCaptureFrameV1, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> ExtImageCopyCaptureFrameV1

Create an inert object proxy

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

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <ExtImageCopyCaptureFrameV1 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 ExtImageCopyCaptureFrameV1