Struct MemoryMappedFrameBuffer 

pub struct MemoryMappedFrameBuffer<T: AsFrameBuffer> { /* private fields */ }

FrameBuffer wrapper, which exposes internal file descriptors as memory mapped [&u8] plane slices.

Implementations

impl<T: AsFrameBuffer> MemoryMappedFrameBuffer<T>

pub fn new(fb: T) -> Result<Self, MemoryMappedFrameBufferError>

Memory map framebuffer, which implements AsFrameBuffer.

This might fail if framebuffer has invalid plane sizes/offsets or if [libc::mmap] fails itself.

pub fn new_writable(fb: T) -> Result<Self, MemoryMappedFrameBufferError>

Memory map framebuffer for read/write access. Mapping will be PROT_READ | PROT_WRITE.

pub fn data(&self) -> Vec<&[u8]>

Returns data slice for each plane within the framebuffer.

pub fn data_mut( &mut self, ) -> Result<Vec<&mut [u8]>, MemoryMappedFrameBufferError>

Returns mutable data slices for each plane within the framebuffer. Mapping must be writable.

pub fn is_writable(&self) -> bool

Returns true if this mapping was created with write access.

pub fn mapped_len(&self, fd: i32) -> Option<usize>

Returns the mapped length for a given file descriptor, if present.

Trait Implementations

impl<T: AsFrameBuffer> AsFrameBuffer for MemoryMappedFrameBuffer<T>

unsafe fn ptr(&self) -> NonNull<libcamera_framebuffer_t>

Returns raw framebuffer used by libcamera.

fn metadata(&self) -> Option<Immutable<FrameMetadataRef<'_>>>

Returns framebuffer metadata information.

fn planes(&self) -> Immutable<FrameBufferPlanesRef<'_>>

Provides access to framebuffer data by exposing file descriptors, offsets and lengths of the planes.

fn cookie(&self) -> u64

User cookie associated with the buffer.

fn set_cookie(&self, cookie: u64)

Set user cookie associated with the buffer.

fn release_fence(&self) -> Option<Fence>

Releases the acquire fence associated with this framebuffer, if any.

fn request(&self) -> Option<RequestRef<'_>>

Returns a non-owning view of the Request owning this framebuffer, if any.

impl<T: AsFrameBuffer> Drop for MemoryMappedFrameBuffer<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: AsFrameBuffer> Send for MemoryMappedFrameBuffer<T>