Struct runa_orbiter::shell::buffers::Buffer

pub struct Buffer<Base> { /* private fields */ }

Buffer base

Various buffer implementations can choose to provide this struct as the implementation of the wl_buffer interface.

All buffer implementations in this crate uses this.

Implementations

impl<Base> Buffer<Base>

pub fn new(dimension: Extent<u32, Buffer>, object_id: u32, inner: Base) -> Self

Create a new buffer

pub fn base(&self) -> &Base

Get a reference to the base type

pub fn base_mut(&mut self) -> &mut Base

Get a mutable reference to the base type

pub fn map_base<U, F: FnOnce(Base) -> U>(self, f: F) -> Buffer<U>

Map the base type of the buffer. Note that already created event sources attached to the origin buffer, are still be attached to the resultant buffer.

Trait Implementations

impl<Base: Debug + 'static> BufferLike for Buffer<Base>

fn damage(&self)

Damage the buffer

fn clear_damage(&self)

Clear buffer damage

fn get_damage(&self) -> bool

Returns whether the buffer is damaged

fn dimension(&self) -> Extent<u32, Buffer>

The buffer dimensions

fn object_id(&self) -> u32

Return the object id for the buffer object. Used for sending release event to the client.

fn release(&self)

Send the Released event for this buffer. After this is called, the buffer should prevent any further access of the client resources. Repeated calls to this function without intervening calls to BufferLike::acquire are allowed, but should have no effect.

fn acquire(&self)

Acquire the buffer so it can be read.

impl<Base: Debug> Debug for Buffer<Base>

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

Formats the value using the given formatter.

impl<Base> EventSource<BufferEvent> for Buffer<Base>

type Source = Receiver<BufferEvent>

Type of event stream you get from this event source.

fn subscribe(&self) -> Self::Source

Get a stream of events from the event source.

impl<U, T, Data: Default> From<Buffer<T>> for UserBuffer<Buffer<U>, Data>where U: From<T>,

fn from(value: Buffer<T>) -> Self

Converts to this type from the input type.