ph::PictureMeta Class Reference

#include <PictureMeta.h>

Public Member Functions
std::size_t	numLayers () const
std::size_t	numChannels (std::size_t layerIdx=0) const
std::size_t	addDefaultLayer ()
std::size_t	addEmptyLayer ()
math::Vector2S &	sizePx (std::size_t layerIdx=0)
math::EColorSpace &	colorSpace (std::size_t layerIdx=0)
void	setNumChannels (std::size_t numChannels, std::size_t layerIdx=0)
	Set the number of channels.
const math::Vector2S &	getSizePx (std::size_t layerIdx=0) const
const math::EColorSpace &	getColorSpace (std::size_t layerIdx=0) const
std::string &	pictureName ()
	Access to the name of the picture.
const std::string &	getPictureName () const
std::string &	name (std::size_t layerIdx=0)
	Access to the name of a layer.
const std::string &	getName (std::size_t layerIdx=0) const
TSpan< std::string >	channelNames (std::size_t layerIdx=0)
	Access to the name of a channel. Some formats have the ability to give names to their color/data channels. If so, channel names will be utilized and a channel can be ignored by giving it an empty name. Set the number of channels by setNumChannels().
TSpanView< std::string >	getChannelNames (std::size_t layerIdx=0) const

Member Function Documentation

addDefaultLayer()

std::size_t ph::PictureMeta::addDefaultLayer ( )

inline

addEmptyLayer()

std::size_t ph::PictureMeta::addEmptyLayer ( )

inline

channelNames()

TSpan< std::string > ph::PictureMeta::channelNames ( std::size_t layerIdx = 0 )

inline

Access to the name of a channel. Some formats have the ability to give names to their color/data channels. If so, channel names will be utilized and a channel can be ignored by giving it an empty name. Set the number of channels by setNumChannels().

colorSpace()

math::EColorSpace & ph::PictureMeta::colorSpace ( std::size_t layerIdx = 0 )

inline

getChannelNames()

TSpanView< std::string > ph::PictureMeta::getChannelNames ( std::size_t layerIdx = 0 ) const

inline

getColorSpace()

const math::EColorSpace & ph::PictureMeta::getColorSpace ( std::size_t layerIdx = 0 ) const

inline

getName()

const std::string & ph::PictureMeta::getName ( std::size_t layerIdx = 0 ) const

inline

getPictureName()

const std::string & ph::PictureMeta::getPictureName ( ) const

inline

getSizePx()

const math::Vector2S & ph::PictureMeta::getSizePx ( std::size_t layerIdx = 0 ) const

inline

name()

std::string & ph::PictureMeta::name ( std::size_t layerIdx = 0 )

inline

Access to the name of a layer.

numChannels()

std::size_t ph::PictureMeta::numChannels ( std::size_t layerIdx = 0 ) const

inline

numLayers()

std::size_t ph::PictureMeta::numLayers ( ) const

inline

pictureName()

std::string & ph::PictureMeta::pictureName ( )

inline

Access to the name of the picture.

setNumChannels()

void ph::PictureMeta::setNumChannels ( std::size_t numChannels, std::size_t layerIdx = 0 )

inline

Set the number of channels.

sizePx()

math::Vector2S & ph::PictureMeta::sizePx ( std::size_t layerIdx = 0 )

inline

---

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

• Source/Frame/PictureMeta.h