libcamera v0.0.0+3240-f2a18172-dirty (2022-05-14T03:06:40+00:00)
Supporting cameras in Linux since 2019
Public Member Functions | List of all members
libcamera::FrameBuffer::Private Class Reference

Base class for FrameBuffer private data. More...

Inheritance diagram for libcamera::FrameBuffer::Private:
Inheritance graph
[legend]
Collaboration diagram for libcamera::FrameBuffer::Private:
Collaboration graph
[legend]

Public Member Functions

void setRequest (Request *request)
 Set the request this buffer belongs to. More...
 
bool isContiguous () const
 Check if the frame buffer stores planes contiguously in memory. More...
 
- Public Member Functions inherited from libcamera::Extensible::Private
 Private ()
 Construct an instance of an Extensible class private data.
 

Detailed Description

Base class for FrameBuffer private data.

The FrameBuffer::Private class stores all private data associated with a framebuffer. It implements the d-pointer design pattern to hide core FrameBuffer data from the public API, and exposes utility functions to pipeline handlers.

Member Function Documentation

◆ isContiguous()

libcamera::FrameBuffer::Private::isContiguous ( ) const
inline

Check if the frame buffer stores planes contiguously in memory.

Multi-planar frame buffers can store their planes contiguously in memory, or split them into discontiguous memory areas. This function checks in which of these two categories the frame buffer belongs.

Returns
True if the planes are stored contiguously in memory, false otherwise

◆ setRequest()

libcamera::FrameBuffer::Private::setRequest ( Request request)
inline

Set the request this buffer belongs to.

Parameters
[in]requestRequest to set

For buffers added to requests by applications, this function is called by Request::addBuffer() or Request::reuse(). For buffers internal to pipeline handlers, it is called by the pipeline handlers themselves.


The documentation for this class was generated from the following files: