Struct BufferLock

pub struct BufferLock<'a, 'b> { /* private fields */ }

An RAII lock on the input buffer.

This type is created via Buffer::lock or Buffer::try_lock. The purpose of this type is similar to std::sync::MutexGuard - it automatically unlocks the buffer then the lock goes out of scope.

Implementations

impl BufferLock<'_, '_>

pub unsafe fn write(&mut self, data: &[u8])

Write data to the buffer.

Safety

The size of the data should be less or equal to the size of the buffer. The size of the buffer depends on the width, height, and buffer format.

The user should also account for pitch, the data is written contiguously.

Trait Implementations

impl<'a, 'b> Debug for BufferLock<'a, 'b>

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

Formats the value using the given formatter.

impl Drop for BufferLock<'_, '_>

fn drop(&mut self)

Executes the destructor for this type.