ph::RegularPicture Class Reference

Raw representation of common picture types. More...

#include <RegularPicture.h>

Public Member Functions
	RegularPicture ()
	Creates an empty picture.
	RegularPicture (math::Vector2S sizePx, std::size_t numComponents, EPicturePixelComponent componentType)
	Creates a picture with allocated picture data. Pixel data can to be set later by calling pictureData.setPixels().
	RegularPicture (RegularPicture &&other)
const RegularPictureFormat &	getFormat () const
void	setFormat (const RegularPictureFormat &format)
std::size_t	numComponents () const
EPicturePixelComponent	getComponentType () const
bool	isLDR () const
bool	isHDR () const
math::Vector2S	getSizePx () const
std::size_t	getWidthPx () const
std::size_t	getHeightPx () const
PictureData &	getPixels ()
const PictureData &	getPixels () const
RegularPicture &	operator= (RegularPicture &&rhs)

Detailed Description

Raw representation of common picture types.

Constructor & Destructor Documentation

RegularPicture() [1/3]

ph::RegularPicture::RegularPicture

(

)

Creates an empty picture.

RegularPicture() [2/3]

ph::RegularPicture::RegularPicture	(	math::Vector2S	sizePx,
		std::size_t	numComponents,
		EPicturePixelComponent	componentType )

Creates a picture with allocated picture data. Pixel data can to be set later by calling pictureData.setPixels().

RegularPicture() [3/3]

ph::RegularPicture::RegularPicture ( RegularPicture && other )

default

Member Function Documentation

getComponentType()

EPicturePixelComponent ph::RegularPicture::getComponentType ( ) const

inline

getFormat()

const RegularPictureFormat & ph::RegularPicture::getFormat ( ) const

inline

getHeightPx()

std::size_t ph::RegularPicture::getHeightPx ( ) const

inline

getPixels() [1/2]

PictureData & ph::RegularPicture::getPixels ( )

inline

getPixels() [2/2]

const PictureData & ph::RegularPicture::getPixels ( ) const

inline

getSizePx()

math::Vector2S ph::RegularPicture::getSizePx ( ) const

inline

getWidthPx()

std::size_t ph::RegularPicture::getWidthPx ( ) const

inline

isHDR()

bool ph::RegularPicture::isHDR

(

)

const

isLDR()

bool ph::RegularPicture::isLDR

(

)

const

numComponents()

std::size_t ph::RegularPicture::numComponents ( ) const

inline

operator=()

RegularPicture & ph::RegularPicture::operator= ( RegularPicture && rhs )

default

setFormat()

void ph::RegularPicture::setFormat

(

const RegularPictureFormat &

format

)

---

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

• Source/Frame/RegularPicture.h
• Source/Frame/RegularPicture.cpp