CVD::Bgrx< T > Class Template Reference

A colour consisting of red, green, blue and dummy components, in the order bgr dummy in memory. More...

#include <bgrx.h>

Public Member Functions
	Bgrx ()
	Default constructor. Sets everything to 0.
	Bgrx (T b, T g, T r)
	Constructs a colour as specified. More...
template<typename T2 >
Bgrx< T > &	operator= (const Bgrx< T2 > &c)
	Assignment operator between two different storage types, using the standard casts as necessary. More...
bool	operator== (const Bgrx< T > &c) const
	Logical equals operator. More...
bool	operator!= (const Bgrx< T > &c) const
	Logical not-equals operator. More...

Public Attributes
T	blue
	The blue component.
T	green
	The green component.
T	red
	The red component.
T	dummy
	The dummy.

Related Functions
(Note that these are not member functions.)
template<typename T >
std::ostream &	operator<< (std::ostream &os, const Bgrx< T > &x)
	Write the colour to a stream in the format "(blue,green,red)". More...
std::ostream &	operator<< (std::ostream &os, const Bgrx< unsigned char > &x)
	Write the colour to a stream in the format "(blue,green,red)". More...

Detailed Description

template<typename T>
class CVD::Bgrx< T >

A colour consisting of red, green, blue and dummy components, in the order bgr dummy in memory.

Parameters

T	The datatype of each component

Constructor & Destructor Documentation

Bgrx()

template<typename T>

CVD::Bgrx< T >::Bgrx ( T  b, T  g, T  r  )

inlineexplicit

Constructs a colour as specified.

Parameters

r	The red component
g	The green component
b	The blue component

Member Function Documentation

operator!=()

template<typename T>

bool CVD::Bgrx< T >::operator!= ( const Bgrx< T > &  c ) const

inline

Logical not-equals operator.

Returns true unless each component is the same.

Parameters

c	Bgrx to compare with

operator=()

template<typename T>

template<typename T2 >

Bgrx<T>& CVD::Bgrx< T >::operator= ( const Bgrx< T2 > &  c )

inline

Assignment operator between two different storage types, using the standard casts as necessary.

Parameters

c	The colour to copy from

operator==()

template<typename T>

bool CVD::Bgrx< T >::operator== ( const Bgrx< T > &  c ) const

inline

Logical equals operator.

Returns true if each component is the same.

Parameters

c	Bgrx to compare with

Friends And Related Function Documentation

operator<<() [1/2]

template<typename T >

std::ostream & operator<< ( std::ostream &  os, const Bgrx< T > &  x  )

related

Write the colour to a stream in the format "(blue,green,red)".

Parameters

os	The stream
x	The colour object

operator<<() [2/2]

template<typename T>

std::ostream & operator<< ( std::ostream &  os, const Bgrx< unsigned char > &  x  )

related

Write the colour to a stream in the format "(blue,green,red)".

Parameters

os	The stream
x	The colour object

---

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

• cvd/bgrx.h