Struct smithay_client_toolkit::shm::slot::Buffer

pub struct Buffer {
    buffer: WlBuffer,
    height: i32,
    stride: i32,
    slot: Slot,
}

A wrapper around a wl_buffer::WlBuffer which has been allocated via a SlotPool.

When this object is dropped, the buffer will be destroyed immediately if it is not active, or upon the server’s release if it is.

Fields

buffer: WlBuffer

height: i32

stride: i32

slot: Slot

Implementations

impl Buffer

pub fn attach_to(&self, surface: &WlSurface) -> Result<(), ActivateSlotError>

Attach a buffer to a surface.

This marks the slot as active until the server releases the buffer, which will happen automatically assuming the surface is committed without attaching a different buffer.

Note: if you need to ensure that canvas() calls never return data that could be attached to a surface in a multi-threaded client, make this call while you have exclusive access to the corresponding SlotPool.

pub fn wl_buffer(&self) -> &WlBuffer

Get the inner buffer.

pub fn height(&self) -> i32

pub fn stride(&self) -> i32

fn data(&self) -> Option<&BufferData>

pub fn canvas<'pool>( &self, pool: &'pool mut SlotPool, ) -> Option<&'pool mut [u8]>

Get the bytes corresponding to this buffer if drawing is permitted.

This may be smaller than the canvas associated with the slot.

pub fn slot(&self) -> Slot

Get the slot corresponding to this buffer.

pub fn activate(&self) -> Result<(), ActivateSlotError>

Manually mark a buffer as active.

An active buffer prevents drawing on its slot until a Release event is received or until manually deactivated.

pub fn deactivate(&self) -> Result<(), ActivateSlotError>

Manually mark a buffer as inactive.

This should be used when the buffer was manually marked as active or when a buffer was attached to a surface but not committed. Calling this function on a buffer that was committed to a surface risks making the surface contents undefined.

Trait Implementations

impl CanvasKey for Buffer

fn canvas<'pool>(&self, pool: &'pool mut SlotPool) -> Option<&'pool mut [u8]>

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Drop for Buffer

fn drop(&mut self)

Executes the destructor for this type.