Represents a pixel format and its specific properties. More...

#include <peak_ipl/types/peak_ipl_pixel_format.hpp>

Public Member Functions
	PixelFormat ()
	Constructor for a new PixelFormat instance.

	PixelFormat (peak::ipl::PixelFormatName name)
	Constructor for a new PixelFormat instance.

	~PixelFormat ()=default
	Destructor for the PixelFormat instance.

	PixelFormat (PixelFormat &&other)=default
	Copy Constructor for a new PixelFormat instance.

	PixelFormat (const PixelFormat &other)=default
	Move constructor for PixelFormat instance.

PixelFormat &	operator= (const PixelFormat &other)=default
	Copy assigment for PixelFormat instance.

PixelFormat &	operator= (PixelFormat &&other)=default
	Move assignment for PixelFormat instance.

std::string	Name () const
	Returns the name of the pixel format as String.

peak::ipl::PixelFormatName	PixelFormatName () const
	Returns the name of the pixel format as enum value.

bool	operator== (const PixelFormat &other) const
	Compare PixelFormat.

size_t	NumSignificantBitsPerChannel () const
	Returns the number of significant bits per pixel per channel of the given pixel format.

size_t	NumStorageBitsPerChannel () const
	Returns the number of storage bits per pixel per channel of the given pixel format.

size_t	NumChannels () const
	Returns the number of channels the given pixel format has.

uint32_t	MaximumValuePerChannel () const
	Returns the maximum value of one pixel channel the given pixel format has.

size_t	NumSignificantBitsPerPixel () const
	Returns the number of significant bits per pixel the given pixel format has.

size_t	NumStorageBitsPerPixel () const
	Returns the number of storage bits per pixel the given pixel format has.

peak::ipl::Endianness	Endianness () const
	Returns the endianness of the given pixel format.

uint64_t	CalculateStorageSizeOfPixels (uint64_t numPixels) const
	Returns the storage size the given number pixels of the given pixel format in bytes.

bool	IsPacked () const
	Returns whether the pixel format is packed.

bool	IsBayered () const
	Returns whether the pixel format is a bayer format.

bool	IsYUV () const
	Returns whether the pixel format is a yuv format.

bool	IsCoord3D () const
	Returns whether the pixel format is a 3D coordinate format.

peak::ipl::BayerPattern	BayerPattern () const
	Queries the bayer pattern of the given pixel format.

Detailed Description

Represents a pixel format and its specific properties.

Constructor & Destructor Documentation

◆ PixelFormat() [1/4]

peak::ipl::PixelFormat::PixelFormat ( )

inline

Constructor for a new PixelFormat instance.

Creates a new PixelFormat instance. The PixelFormatName is initialized to PixelFormatName::Invalid.

Since: 1.0

◆ PixelFormat() [2/4]

peak::ipl::PixelFormat::PixelFormat ( peak::ipl::PixelFormatName name )

inline

Constructor for a new PixelFormat instance.

Creates a new PixelFormat instance. The PixelFormatName is initialized to name.

Parameters

[in] name Used Pixel Format Name.

Since: 1.0

◆ ~PixelFormat()

peak::ipl::PixelFormat::~PixelFormat ( )

default

Destructor for the PixelFormat instance.

Destroys a PixelFormat instance.

Since: 1.0

◆ PixelFormat() [3/4]

peak::ipl::PixelFormat::PixelFormat ( PixelFormat && other )

default

Copy Constructor for a new PixelFormat instance.

Creates a new PixelFormat instance. The PixelFormatName is copied from other

Parameters

[in] other The other instance to copy the PixelFormatName from.

Since: 1.0

◆ PixelFormat() [4/4]

peak::ipl::PixelFormat::PixelFormat ( const PixelFormat & other )

default

Move constructor for PixelFormat instance.

Moves the PixelFormatName from other to this. Afterwards other is invalid.

Parameters

[in] other The other instance to move the PixelFormatName from.

Since: 1.0

Member Function Documentation

◆ BayerPattern()

peak::ipl::BayerPattern peak::ipl::PixelFormat::BayerPattern ( ) const

inline

Queries the bayer pattern of the given pixel format.

Returns: The bayer pattern if the format is a bayer format. Or BayerPattern::None if the format has no Bayer pattern.

Since: 1.8

Exceptions

Exception An internal error has occurred.

◆ CalculateStorageSizeOfPixels()

uint64_t peak::ipl::PixelFormat::CalculateStorageSizeOfPixels ( uint64_t numPixels ) const

inline

Returns the storage size the given number pixels of the given pixel format in bytes.

For example, the calculation of the required buffer size, supply width multiplied by height here.

Parameters

[in] numPixels The number of pixels.

Returns: The calculated storage size for the number of pixels.

Since: 1.0

Exceptions

Exception An internal error has occurred.

◆ Endianness()

peak::ipl::Endianness peak::ipl::PixelFormat::Endianness ( ) const

inline

Returns the endianness of the given pixel format.

Returns: The endianness of the pixel format.

Since: 1.0

Exceptions

Exception An internal error has occurred.

◆ IsBayered()

bool peak::ipl::PixelFormat::IsBayered ( ) const

inline

Returns whether the pixel format is a bayer format.

Returns: Whether the pixel format is a bayer format. True for Bayer, false for all else.

Since: 1.7

Exceptions

Exception An internal error has occurred.

◆ IsCoord3D()

bool peak::ipl::PixelFormat::IsCoord3D ( ) const

inline

Returns whether the pixel format is a 3D coordinate format.

Returns: Whether the pixel format is a 3D coordinate format.

Since: 1.10

Exceptions

Exception An internal error has occurred.

◆ IsPacked()

bool peak::ipl::PixelFormat::IsPacked ( ) const

inline

Returns whether the pixel format is packed.

Returns: Whether the pixel format is packed. True for packed, false for unpacked.

Since: 1.7

Exceptions

Exception An internal error has occurred.

◆ IsYUV()

bool peak::ipl::PixelFormat::IsYUV ( ) const

inline

Returns whether the pixel format is a yuv format.

Returns: Whether the pixel format is a yuv format. True for yuv, false for all else.

Since: 1.9

Exceptions

Exception An internal error has occurred.

◆ MaximumValuePerChannel()

uint32_t peak::ipl::PixelFormat::MaximumValuePerChannel ( ) const

inline

Returns the maximum value of one pixel channel the given pixel format has.

Note: Returns 0 if the underlying pixel format has floating point values.

Returns: Maximum value of one pixel channel.

Since: 1.0

Exceptions

Exception An internal error has occurred.

◆ Name()

std::string peak::ipl::PixelFormat::Name ( ) const

inline

Returns the name of the pixel format as String.

Returns: Name

Since: 1.0

◆ NumChannels()

size_t peak::ipl::PixelFormat::NumChannels ( ) const

inline

Returns the number of channels the given pixel format has.

Returns: Number of channels for pixel format.

Since: 1.0

Exceptions

Exception An internal error has occurred.

◆ NumSignificantBitsPerChannel()

size_t peak::ipl::PixelFormat::NumSignificantBitsPerChannel ( ) const

inline

Returns the number of significant bits per pixel per channel of the given pixel format.

Returns: Number of significant bits per pixel per channel.

Since: 1.0

Exceptions

Exception An internal error has occurred.

◆ NumSignificantBitsPerPixel()

size_t peak::ipl::PixelFormat::NumSignificantBitsPerPixel ( ) const

inline

Returns the number of significant bits per pixel the given pixel format has.

Returns: Number of significant bits used.

Since: 1.0

Exceptions

Exception An internal error has occurred.

◆ NumStorageBitsPerChannel()

size_t peak::ipl::PixelFormat::NumStorageBitsPerChannel ( ) const

inline

Returns the number of storage bits per pixel per channel of the given pixel format.

Returns: Number of storage bits per pixel per channel.

Since: 1.0

Exceptions

Exception An internal error has occurred.

◆ NumStorageBitsPerPixel()

size_t peak::ipl::PixelFormat::NumStorageBitsPerPixel ( ) const

inline

Returns the number of storage bits per pixel the given pixel format has.

For unpacked formats, this is normally a multiple of 8. For packed formats, this is normally the same as NumSignificantBitsPerPixel.

Returns: Number of storage bits used.

Since: 1.0

Exceptions

Exception An internal error has occurred.

◆ operator=() [1/2]

PixelFormat & peak::ipl::PixelFormat::operator= ( const PixelFormat & other )

default

Copy assigment for PixelFormat instance.

Copies the PixelFormatName from other to this instance.

Parameters

[in] other The other instance to copy the PixelFormatName from.

Since: 1.0

◆ operator=() [2/2]

PixelFormat & peak::ipl::PixelFormat::operator= ( PixelFormat && other )

default

Move assignment for PixelFormat instance.

Moves the PixelFormatName from other to this.

Parameters

[in] other The other instance to move the PixelFormatName from.

Since: 1.0

◆ operator==()

bool peak::ipl::PixelFormat::operator== ( const PixelFormat & other ) const

inline

Compare PixelFormat.

Compares the PixelFormatName from other to this instance

Parameters

[in] other The other instance to compare.

Returns: True if equal, false otherwise.

Since: 1.0

◆ PixelFormatName()

peak::ipl::PixelFormatName peak::ipl::PixelFormat::PixelFormatName ( ) const

inline

Returns the name of the pixel format as enum value.

Returns: PixelFormatName

Since: 1.0

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

peak_ipl/types/peak_ipl_pixel_format.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PixelFormat() [1/4]

◆ PixelFormat() [2/4]

◆ ~PixelFormat()

◆ PixelFormat() [3/4]

◆ PixelFormat() [4/4]

Member Function Documentation

◆ BayerPattern()

◆ CalculateStorageSizeOfPixels()

◆ Endianness()

◆ IsBayered()

◆ IsCoord3D()

◆ IsPacked()

◆ IsYUV()

◆ MaximumValuePerChannel()

◆ Name()

◆ NumChannels()

◆ NumSignificantBitsPerChannel()

◆ NumSignificantBitsPerPixel()

◆ NumStorageBitsPerChannel()

◆ NumStorageBitsPerPixel()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ PixelFormatName()