Enum Event

#[non_exhaustive]
pub enum Event {
    BufferSize {
        width: u32,
        height: u32,
    },
    ShmFormat {
        format: u32,
    },
    DmabufDevice {
        device: Vec<u8>,
    },
    DmabufFormat {
        format: u32,
        modifiers: Vec<u8>,
    },
    Done,
    Stopped,
}

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.

BufferSize

image source dimensions

Provides the dimensions of the source image in buffer pixel coordinates.

The client must attach buffers that match this size.

Fields

width: u32

buffer width

height: u32

buffer height

ShmFormat

shm buffer format

Provides the format that must be used for shared-memory buffers.

This event may be emitted multiple times, in which case the client may choose any given format.

Fields

format: u32

shm format

DmabufDevice

dma-buf device

This event advertises the device buffers must be allocated on for dma-buf buffers.

In general the device is a DRM node. The DRM node type (primary vs. render) is unspecified. Clients must not rely on the compositor sending a particular node type. Clients cannot check two devices for equality by comparing the dev_t value.

Fields

device: Vec<u8>

device dev_t value

DmabufFormat

dma-buf format

Provides the format that must be used for dma-buf buffers.

The client may choose any of the modifiers advertised in the array of 64-bit unsigned integers.

This event may be emitted multiple times, in which case the client may choose any given format.

Fields

format: u32

drm format code

modifiers: Vec<u8>

drm format modifiers

Done

all constraints have been sent

This event is sent once when all buffer constraint events have been sent.

The compositor must always end a batch of buffer constraint events with this event, regardless of whether it sends the initial constraints or an update.

Stopped

session is no longer available

This event indicates that the capture session has stopped and is no longer available. This can happen in a number of cases, e.g. when the underlying source is destroyed, if the user decides to end the screen capture, or if an unrecoverable runtime error has occurred.

The client should destroy the session after receiving this event.

Implementations

impl Event

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.