Enum wayland_protocols_wlr::screencopy::v1::server::zwlr_screencopy_frame_v1::Request

#[non_exhaustive]
pub enum Request {
    Copy {
        buffer: WlBuffer,
    },
    Destroy,
    CopyWithDamage {
        buffer: WlBuffer,
    },
}

Available on crate feature server only.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Copy

Fields

buffer: WlBuffer

copy the frame

Copy the frame to the supplied buffer. The buffer must have a the correct size, see zwlr_screencopy_frame_v1.buffer and zwlr_screencopy_frame_v1.linux_dmabuf. The buffer needs to have a supported format.

If the frame is successfully copied, a “flags” and a “ready” events are sent. Otherwise, a “failed” event is sent.

Destroy

delete this object, used or not

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

This is a destructor, once received this object cannot be used any longer.

CopyWithDamage

Fields

buffer: WlBuffer

copy the frame when it’s damaged

Same as copy, except it waits until there is damage to copy.

Only available since version 2 of the interface

Implementations

impl Request

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.