Enum wayland_client::protocol::wl_shm_pool::Request

#[non_exhaustive]
pub enum Request {
    CreateBuffer {
        offset: i32,
        width: i32,
        height: i32,
        stride: i32,
        format: WEnum<Format>,
    },
    Destroy,
    Resize {
        size: i32,
    },
}

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.

CreateBuffer

Fields

offset: i32

buffer byte offset within the pool

width: i32

buffer width, in pixels

height: i32

buffer height, in pixels

stride: i32

number of bytes from the beginning of one row to the beginning of the next row

format: WEnum<Format>

buffer pixel format

create a buffer from the pool

Create a wl_buffer object from the pool.

The buffer is created offset bytes into the pool and has width and height as specified. The stride argument specifies the number of bytes from the beginning of one row to the beginning of the next. The format is the pixel format of the buffer and must be one of those advertised through the wl_shm.format event.

A buffer will keep a reference to the pool it was created from so it is valid to destroy the pool immediately after creating a buffer from it.

Destroy

destroy the pool

Destroy the shared memory pool.

The mmapped memory will be released when all buffers that have been created from this pool are gone.

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

Resize

Fields

size: i32

new size of the pool, in bytes

change the size of the pool mapping

This request will cause the server to remap the backing memory for the pool from the file descriptor passed when the pool was created, but using the new size. This request can only be used to make the pool bigger.

This request only changes the amount of bytes that are mmapped by the server and does not touch the file corresponding to the file descriptor passed at creation time. It is the client’s responsibility to ensure that the file is at least as big as the new pool size.

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.