farm-ng-core
sophus::ImageLayout Class Reference

Layout of the image: width, height and pitch in bytes. More...

#include <layout.h>

Public Member Functions

 ImageLayout ()=default
 
 ImageLayout (ImageSize image_size, size_t pitch_bytes)
 
 ImageLayout (int width, int height, size_t pitch_bytes)
 
auto imageSize () const -> sophus::ImageSize const &
 
auto width () const -> int
 
auto height () const -> int
 
auto pitchBytes () const -> size_t
 
auto area () const -> size_t
 
auto sizeBytes () const -> size_t
 
auto isEmpty () const -> bool
 

Static Public Member Functions

template<class TPixelFormat >
static auto makeFromSizeAndPitch (ImageSize image_size, size_t pitch_bytes) -> ImageLayout
 
template<class TPixelFormat >
static auto makeFromSize (sophus::ImageSize image_size) -> ImageLayout
 

Detailed Description

Layout of the image: width, height and pitch in bytes.

Constructor & Destructor Documentation

◆ ImageLayout() [1/3]

sophus::ImageLayout::ImageLayout ( )
default

◆ ImageLayout() [2/3]

sophus::ImageLayout::ImageLayout ( ImageSize  image_size,
size_t  pitch_bytes 
)
inlineexplicit

◆ ImageLayout() [3/3]

sophus::ImageLayout::ImageLayout ( int  width,
int  height,
size_t  pitch_bytes 
)
inlineexplicit

Member Function Documentation

◆ area()

auto sophus::ImageLayout::area ( ) const -> size_t
inline

◆ height()

auto sophus::ImageLayout::height ( ) const -> int
inline

◆ imageSize()

auto sophus::ImageLayout::imageSize ( ) const -> sophus::ImageSize const&
inline

◆ isEmpty()

auto sophus::ImageLayout::isEmpty ( ) const -> bool
inline

◆ makeFromSize()

template<class TPixelFormat >
static auto sophus::ImageLayout::makeFromSize ( sophus::ImageSize  image_size) -> ImageLayout
inlinestatic

◆ makeFromSizeAndPitch()

template<class TPixelFormat >
static auto sophus::ImageLayout::makeFromSizeAndPitch ( ImageSize  image_size,
size_t  pitch_bytes 
) -> ImageLayout
inlinestatic

◆ pitchBytes()

auto sophus::ImageLayout::pitchBytes ( ) const -> size_t
inline

◆ sizeBytes()

auto sophus::ImageLayout::sizeBytes ( ) const -> size_t
inline

◆ width()

auto sophus::ImageLayout::width ( ) const -> int
inline

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