Banuba SDK
Loading...
Searching...
No Matches
bnb::bpc8_image_t Class Referencefinal

A class for representing bpc8 images as C++ object. More...

#include <full_image.hpp>

Inheritance diagram for bnb::bpc8_image_t:
bnb::base_image_t

Public Types

using pixel_format_t = bnb::interfaces::pixel_format
 

Public Member Functions

 bpc8_image_t ()=default
 enum value represents pixel format (
 
 bpc8_image_t (bpc8_image_t &&)=default
 Construct a new bpc8_image_t object using move semantics.
 
bpc8_image_toperator= (bpc8_image_t &&other)=default
 
 bpc8_image_t (const bpc8_image_t &)=default
 Construct a new bpc8_image_t object using copy operation.
 
bpc8_image_toperator= (const bpc8_image_t &)=default
 
 bpc8_image_t (color_plane data, pixel_format_t type, const image_format &format)
 Construct a new bpc8_image_t object with user's values.
 
pixel_format_t get_pixel_format () const noexcept
 
uint8_t * get_data () const noexcept
 
std::tuple< uint8_t, uint8_t, uint8_t > rgb_pixel_at (uint32_t x, uint32_t y) const noexcept
 
void normalize_orientation (bnb::transformation const &basis_transform, bnb::pixel_rect const &full_roi)
 Normalize image data if it is required to be mirrored or camera orientation isn't deg_0.
 
- Public Member Functions inherited from bnb::base_image_t
 base_image_t ()=default
 Construct a new base_image_t object with default values.
 
const image_formatget_format () const
 
void set_fov (float fov)
 Set the field of view.
 

Static Public Member Functions

static uint8_t bytes_per_pixel (pixel_format_t fmt)
 
static std::tuple< int, int, int > rgb_offsets (pixel_format_t fmt)
 

Additional Inherited Members

- Protected Member Functions inherited from bnb::base_image_t
 base_image_t (const image_format &format)
 
- Protected Attributes inherited from bnb::base_image_t
image_format m_format
 

Detailed Description

A class for representing bpc8 images as C++ object.

Definition at line 166 of file full_image.hpp.

Member Typedef Documentation

◆ pixel_format_t

using bnb::bpc8_image_t::pixel_format_t = bnb::interfaces::pixel_format

Definition at line 169 of file full_image.hpp.

Constructor & Destructor Documentation

◆ bpc8_image_t() [1/2]

bnb::bpc8_image_t::bpc8_image_t ( )
default

enum value represents pixel format (

See also
pixel_format) Construct a new bpc8_image_t object with default values.

◆ bpc8_image_t() [2/2]

bnb::bpc8_image_t::bpc8_image_t ( color_plane data,
pixel_format_t type,
const image_format & format )

Construct a new bpc8_image_t object with user's values.

Parameters
datais a color plane data (
See also
color_plane).
Parameters
typeis a pixel format as enum value (
See also
pixe_format_t).
Parameters
formatis a image format (
See also
image_format).

Member Function Documentation

◆ bytes_per_pixel()

static uint8_t bnb::bpc8_image_t::bytes_per_pixel ( pixel_format_t fmt)
static
Returns
Returns count of bytes per pixel for pixel format (fmt).

◆ get_data()

uint8_t * bnb::bpc8_image_t::get_data ( ) const
noexcept
Returns
Returns a raw pointer on data of image.

◆ get_pixel_format()

pixel_format_t bnb::bpc8_image_t::get_pixel_format ( ) const
noexcept
Returns
Returns the pixel format as enum value (
See also
pixe_format_t).

◆ rgb_offsets()

static std::tuple< int, int, int > bnb::bpc8_image_t::rgb_offsets ( pixel_format_t fmt)
static
Returns
Returns offsets for every component of rgb in bytes.

◆ rgb_pixel_at()

std::tuple< uint8_t, uint8_t, uint8_t > bnb::bpc8_image_t::rgb_pixel_at ( uint32_t x,
uint32_t y ) const
noexcept
Returns
Returns RGB pixel at position

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