Struct wayland_client::protocol::wl_shm_pool::WlShmPool

pub struct WlShmPool(_);

Methods

impl WlShmPool

pub fn create_buffer(
    &self,
    offset: i32,
    width: i32,
    height: i32,
    stride: i32,
    format: Format
) -> Main<WlBuffer>

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.

pub fn destroy(&self)

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, you cannot send requests to this object any longer once this method is called.

pub fn resize(&self, size: i32)

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.

Trait Implementations

impl AsRef<Proxy<WlShmPool>> for WlShmPool

fn as_ref(&self) -> &Proxy<Self>

Performs the conversion.

impl Clone for WlShmPool

fn clone(&self) -> WlShmPool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Eq for WlShmPool

impl From<Proxy<WlShmPool>> for WlShmPool

fn from(value: Proxy<Self>) -> Self

Performs the conversion.

impl From<WlShmPool> for Proxy<WlShmPool>

fn from(value: WlShmPool) -> Self

Performs the conversion.

impl Interface for WlShmPool

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str

Name of this interface

const VERSION: u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<WlShmPool> for WlShmPool

fn eq(&self, other: &WlShmPool) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WlShmPool) -> bool

This method tests for !=.

impl StructuralEq for WlShmPool

impl StructuralPartialEq for WlShmPool