Struct BufferObject

pub struct BufferObject { /* private fields */ }

An object holding a double-buffered compositor surface for a window.

Implementations

impl BufferObject

pub fn id(&self) -> ObjID

pub fn create_new(w: u32, h: u32) -> Result<Self, TwzError>

pub fn has_data_for_read(&self) -> bool

Returns true if the buffers currently need to be read out.

pub fn read_buffer<R>(&self, f: impl FnMut(Buffer<'_>, u32, u32) -> R) -> R

Read out the compositor buffer.

pub fn read_done(&self, new_w: u32, new_h: u32)

Mark that the compositor has finished reading the buffer. Provides the new width and height to use next time this buffer should be filled out. These values may be unchanged.

pub fn update_buffer<R>(&self, f: impl FnMut(BufferMut<'_>, u32, u32) -> R) -> R

Fill the current application-owned buffer with data within the callback.

pub fn flip(&self)

Flip the buffer, indicating that the compositor can now read the buffer.

Trait Implementations

impl Clone for BufferObject

fn clone(&self) -> BufferObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Object<DisplayBufferBase>> for BufferObject

fn from(obj: Object<DisplayBufferBase>) -> Self

Converts to this type from the input type.