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 ()
	Constructor for a new PixelFormat instance. More...
	PixelFormat (peak::ipl::PixelFormatName name)
	Constructor for a new PixelFormat instance. More...
	~PixelFormat ()=default
	Destructor for the PixelFormat instance. More...
	PixelFormat (PixelFormat &&other)=default
	Copy Constructor for a new PixelFormat instance. More...
	PixelFormat (const PixelFormat &other)=default
	Move constructor for PixelFormat instance. More...
PixelFormat &	operator= (const PixelFormat &other)=default
	Copy assigment for PixelFormat instance. More...
PixelFormat &	operator= (PixelFormat &&other)=default
	Move assignment for PixelFormat instance. More...

Public Attributes
	PEAK_IPL_MAYBE_UNUSED

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

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

Member Data Documentation

PEAK_IPL_MAYBE_UNUSED

peak::ipl::PixelFormat::PEAK_IPL_MAYBE_UNUSED

Initial value:

= std::string Name() const
    {
        return peak::ipl::ToString(m_name);
    }

---

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

• peak_ipl/types/peak_ipl_pixel_format.hpp