Enum wayland_protocols::wlr::unstable::screencopy::v1::client::zwlr_screencopy_frame_v1::Request

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

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 sent 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

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl MessageGroup for Request

const MESSAGES: &'static [MessageDesc]

Wire representation of this MessageGroup

type Map = ProxyMap

The wrapper type for ObjectMap allowing the mapping of Object and NewId arguments to the object map during parsing.

fn is_destructor(&self) -> bool

Whether this message is a destructor

fn opcode(&self) -> u16

The opcode of this message

fn since(&self) -> u32

The minimal object version for which this message exists

fn child<Meta: ObjectMetadata>(
    opcode: u16,
    version: u32,
    meta: &Meta
) -> Option<Object<Meta>>

Retrieve the child Object associated with this message if any

fn from_raw(msg: Message, map: &mut Self::Map) -> Result<Self, ()>

Construct a message from its raw representation

fn into_raw(self, sender_id: u32) -> Message

Turn this message into its raw representation

unsafe fn from_raw_c(
    obj: *mut c_void,
    opcode: u32,
    args: *const wl_argument
) -> Result<Request, ()>

Construct a message of this group from its C representation

fn as_raw_c_in<F, T>(self, f: F) -> T where
    F: FnOnce(u32, &mut [wl_argument]) -> T, 

Build a C representation of this message