[−][src]Trait wayland_client::protocol::wl_shm_pool::RequestsTrait

pub trait RequestsTrait {
    fn create_buffer<F>(
        &self, 
        offset: i32, 
        width: i32, 
        height: i32, 
        stride: i32, 
        format: Format, 
        implementor: F
    ) -> Result<Proxy<WlBuffer>, ()>
    where
        F: FnOnce(NewProxy<WlBuffer>) -> Proxy<WlBuffer>;

    fn destroy(&self);

    fn resize(&self, size: i32);
}

Required methods

fn create_buffer<F>(
    &self,
    offset: i32,
    width: i32,
    height: i32,
    stride: i32,
    format: Format,
    implementor: F
) -> Result<Proxy<WlBuffer>, ()> where
    F: FnOnce(NewProxy<WlBuffer>) -> Proxy<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.

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.

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.

Loading content...

Implementors

impl RequestsTrait for Proxy<WlShmPool>[src]

Loading content...