peak::ipl::PixelFormat Class Reference

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

#include <peak_ipl/types/peak_ipl_pixel_format.hpp>

Public Member Functions
	PixelFormat ()
	PixelFormat (peak::ipl::PixelFormatName name)
	~PixelFormat ()=default
	PixelFormat (const PixelFormat &other)=default
PixelFormat &	operator= (const PixelFormat &other)=default
	PixelFormat (PixelFormat &&other)=default
PixelFormat &	operator= (PixelFormat &&other)=default
std::string	Name () const
	Returns the name of the pixel format as String. More...
peak::ipl::PixelFormatName	PixelFormatName () const
	Returns the name of the pixel format as enum value. More...
bool	operator== (const PixelFormat &other) const
size_t	NumSignificantBitsPerChannel () const
	Returns the number of significant bits per pixel per channel of the given pixel format. More...
size_t	NumStorageBitsPerChannel () const
	Returns the number of storage bits per pixel per channel of the given pixel format. More...
size_t	NumChannels () const
	Returns the number of channels of the given pixel format. More...
uint32_t	MaximumValuePerChannel () const
	Returns the maximum value of one pixel channel of the given pixel format. More...
size_t	NumSignificantBitsPerPixel () const
	Returns the number of significant bits per pixel of the given pixel format. More...
size_t	NumStorageBitsPerPixel () const
	Returns the number of storage bits per pixel of the given pixel format. More...
peak::ipl::Endianness	Endianness () const
	Returns the endianness of the given pixel format. More...
uint64_t	CalculateStorageSizeOfPixels (uint64_t numPixels) const
	Returns the storage size of the given number of pixels of the given pixel format in bytes. More...

Detailed Description

Represents a pixel format and its specific properties.

Constructor & Destructor Documentation

PixelFormat() [1/4]

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

inline

PixelFormat() [2/4]

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

inline

~PixelFormat()

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

default

PixelFormat() [3/4]

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

default

PixelFormat() [4/4]

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

default

Member Function Documentation

CalculateStorageSizeOfPixels()

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

inline

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

Parameters

[in]

numPixels

The number of pixels.

Returns

CalculateStorageSizeOfPixels

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

Endianness.

Since

1.0

Exceptions

Exception

An internal error has occurred.

MaximumValuePerChannel()

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

inline

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

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

Exceptions

Exception

An internal error has occurred.

NumChannels()

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

inline

Returns the number of channels of the given pixel format.

Returns

Number of channels.

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 of the given pixel format.

Returns

NumSignificantBits

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 of the given pixel format.

returns NumStorageBits

Since

1.0

Exceptions

Exception

An internal error has occurred.

operator=() [1/2]

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

default

operator=() [2/2]

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

default

operator==()

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

inline

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

Exceptions

Exception

An internal error has occurred.

---

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

• peak_ipl/types/peak_ipl_pixel_format.hpp