facade::png::TrueColorPixel< _Sample > Class Template Reference

An RGB pixel object. More...

#include <png.hpp>

Inheritance diagram for facade::png::TrueColorPixel< _Sample >:

Public Types
using	Sample = _Sample
	The sample class that was used in creating this class.
using	Base = typename Sample::Base
	The base type of the sample class used in creating this class.

Public Member Functions
	TrueColorPixel ()
	TrueColorPixel (Sample red, Sample green, Sample blue)
	TrueColorPixel (const TrueColorPixel &other)
Sample &	red ()
	Retrieve a reference to the red channel.
const Sample &	red () const
	Retrieve a const reference to the red channel.
Sample &	green ()
	Retrieve a reference to the green channel.
const Sample &	green () const
	Retrieve a const reference to the green channel.
Sample &	blue ()
	Retrieve a reference to the blue channel.
const Sample &	blue () const
	Retrieve a const reference to the blue channel.

Static Public Attributes
static const std::size_t	Max = Sample::Max
	The maximum value of the sample size.
static const std::size_t	Bits = Sample::Bits*3
	The size, in bits, of this pixel object.

Detailed Description

template<typename _Sample = Sample8Bit>
class facade::png::TrueColorPixel< _Sample >

An RGB pixel object.

Template Parameters

_Sample

The given sample size of the RGB pixel object. Can be facade::png::Sample8Bit or facade::png::Sample16Bit

See also

facade::png::TrueColorPixel8Bit

facade::png::TrueColorPixel16Bit

Member Typedef Documentation

Base

template<typename _Sample = Sample8Bit>

using facade::png::TrueColorPixel< _Sample >::Base = typename Sample::Base

The base type of the sample class used in creating this class.

Sample

template<typename _Sample = Sample8Bit>

using facade::png::TrueColorPixel< _Sample >::Sample = _Sample

The sample class that was used in creating this class.

Constructor & Destructor Documentation

TrueColorPixel() [1/3]

template<typename _Sample = Sample8Bit>

facade::png::TrueColorPixel< _Sample >::TrueColorPixel ( )

inline

TrueColorPixel() [2/3]

template<typename _Sample = Sample8Bit>

facade::png::TrueColorPixel< _Sample >::TrueColorPixel ( Sample  red, Sample  green, Sample  blue  )

inline

TrueColorPixel() [3/3]

template<typename _Sample = Sample8Bit>

facade::png::TrueColorPixel< _Sample >::TrueColorPixel ( const TrueColorPixel< _Sample > &  other )

inline

Member Function Documentation

blue() [1/2]

template<typename _Sample = Sample8Bit>

Sample & facade::png::TrueColorPixel< _Sample >::blue ( )

inline

Retrieve a reference to the blue channel.

blue() [2/2]

template<typename _Sample = Sample8Bit>

const Sample & facade::png::TrueColorPixel< _Sample >::blue ( ) const

inline

Retrieve a const reference to the blue channel.

green() [1/2]

template<typename _Sample = Sample8Bit>

Sample & facade::png::TrueColorPixel< _Sample >::green ( )

inline

Retrieve a reference to the green channel.

green() [2/2]

template<typename _Sample = Sample8Bit>

const Sample & facade::png::TrueColorPixel< _Sample >::green ( ) const

inline

Retrieve a const reference to the green channel.

red() [1/2]

template<typename _Sample = Sample8Bit>

Sample & facade::png::TrueColorPixel< _Sample >::red ( )

inline

Retrieve a reference to the red channel.

red() [2/2]

template<typename _Sample = Sample8Bit>

const Sample & facade::png::TrueColorPixel< _Sample >::red ( ) const

inline

Retrieve a const reference to the red channel.

Member Data Documentation

Bits

template<typename _Sample = Sample8Bit>

const std::size_t facade::png::TrueColorPixel< _Sample >::Bits = Sample::Bits*3

static

The size, in bits, of this pixel object.

Max

template<typename _Sample = Sample8Bit>

const std::size_t facade::png::TrueColorPixel< _Sample >::Max = Sample::Max

static

The maximum value of the sample size.

---

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

• include/facade/png.hpp