Enum wayland_server::protocol::wl_shm_pool::Request

pub enum Request {
    CreateBuffer {
        id: NewResource<WlBuffer>,
        offset: i32,
        width: i32,
        height: i32,
        stride: i32,
        format: Format,
    },
    Destroy,
    Resize {
        size: i32,
    },
}

Variants

CreateBuffer

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.

Fields of CreateBuffer

id: NewResource<WlBuffer>
offset: i32
width: i32
height: i32
stride: i32
format: Format

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 received this object cannot be used any longer.

Resize

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.

Fields of Resize

size: i32

Trait Implementations

impl MessageGroup for Request

const MESSAGES: &'static [MessageDesc]

MESSAGES: &'static [MessageDesc] = &[super::MessageDesc{name: "create_buffer",
                     since: 1,
                     signature:
                         &[super::ArgumentType::NewId,
                           super::ArgumentType::Int, super::ArgumentType::Int,
                           super::ArgumentType::Int, super::ArgumentType::Int,
                           super::ArgumentType::Uint],},
  super::MessageDesc{name: "destroy", since: 1, signature: &[],},
  super::MessageDesc{name: "resize",
                     since: 1,
                     signature: &[super::ArgumentType::Int],}]

Wire representation of this MessageGroup

type Map = ResourceMap

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