Struct smithay_client_toolkit::shm::raw::RawPool

pub struct RawPool { /* private fields */ }

A raw handler for file backed shared memory pools.

This type of pool will create the SHM memory pool and provide a way to resize the pool.

This pool does not release buffers. If you need this, use one of the higher level pools.

Implementations

impl RawPool

pub fn new( len: usize, shm: &impl ProvidesBoundGlobal<WlShm, 1>, ) -> Result<RawPool, CreatePoolError>

pub fn resize(&mut self, size: usize) -> Result<()>

Resizes the memory pool, notifying the server the pool has changed in size.

The wl_shm protocol only allows the pool to be made bigger. If the new size is smaller than the current size of the pool, this function will do nothing.

pub fn mmap(&mut self) -> &mut MmapMut

Returns a reference to the underlying shared memory file using the memmap2 crate.

pub fn len(&self) -> usize

Returns the size of the mempool

pub fn create_buffer<D, U>( &mut self, offset: i32, width: i32, height: i32, stride: i32, format: Format, udata: U, qh: &QueueHandle<D>, ) -> WlBuffer

where D: Dispatch<WlBuffer, U> + 'static, U: Send + Sync + 'static,

Create a new buffer to this pool.

Parameters

• offset: the offset (in bytes) from the beginning of the pool at which this buffer starts.
• width and height: the width and height of the buffer in pixels.
• stride: distance (in bytes) between the beginning of a row and the next one.
• format: the encoding format of the pixels.

The encoding format of the pixels must be supported by the compositor or else a protocol error is risen. You can ensure the format is supported by listening to Shm::formats.

Note this function only creates the wl_buffer object, you will need to write to the pixels using the io::Write implementation or RawPool::mmap.

pub fn create_buffer_raw( &mut self, offset: i32, width: i32, height: i32, stride: i32, format: Format, data: Arc<dyn ObjectData + 'static>, ) -> WlBuffer

Create a new buffer to this pool.

This is identical to Self::create_buffer, but allows using a custom [ObjectData] implementation instead of relying on the [Dispatch] interface.

pub fn pool(&self) -> &WlShmPool

Returns the pool object used to communicate with the server.

Trait Implementations

impl Debug for RawPool

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

Formats the value using the given formatter.

impl Drop for RawPool

fn drop(&mut self)

Executes the destructor for this type.

impl Seek for RawPool

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.

impl Write for RawPool

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.