CVD::Rgb< T > Class Template Reference

A colour consisting of red, green and blue components. More...

#include <rgb.h>

List of all members.

Public Member Functions
	Rgb ()
	Rgb (T r, T g, T b)
template<class S >
	Rgb (const Rgb< S > &rgb)
Rgb< T > &	operator= (const Rgb< T > &c)
bool	operator== (const Rgb< T > &c) const
bool	operator!= (const Rgb< T > &c) const
template<class T2 >
Rgb< T > &	operator= (const Rgb< T2 > &c)
Public Attributes
T	red
T	green
T	blue
Related Functions
(Note that these are not member functions.)
template<class T >
std::ostream &	operator<< (std::ostream &os, const Rgb< T > &x)
std::ostream &	operator<< (std::ostream &os, const Rgb< char > &x)
std::ostream &	operator<< (std::ostream &os, const Rgb< byte > &x)

---

Detailed Description

template<class T>
class CVD::Rgb< T >

A colour consisting of red, green and blue components.

Often used to store 24-bit colour information, i.e. CVD::Rgb<CVD::byte>

Parameters:

T	The datatype of each component

Definition at line 46 of file rgb.h.

---

Constructor & Destructor Documentation

template<class T>

CVD::Rgb< T >::Rgb	(	T	r,
		T	g,
		T	b
	)		[inline, explicit]

Constructs a colour as specified.

Parameters:

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

Definition at line 56 of file rgb.h.

---

Member Function Documentation

template<class T>

Rgb<T>& CVD::Rgb< T >::operator=

(

const Rgb< T > &

c

)

[inline]

Assignment operator.

Parameters:

c	The colour to copy from

Definition at line 66 of file rgb.h.

References CVD::Rgb< T >::blue, CVD::Rgb< T >::green, and CVD::Rgb< T >::red.

template<class T>

bool CVD::Rgb< T >::operator==

(

const Rgb< T > &

c

)

const [inline]

Logical equals operator.

Returns true if each component is the same.

Parameters:

c	Rgb to compare with

Definition at line 71 of file rgb.h.

References CVD::Rgb< T >::blue, CVD::Rgb< T >::green, and CVD::Rgb< T >::red.

template<class T>

bool CVD::Rgb< T >::operator!=

(

const Rgb< T > &

c

)

const [inline]

Logical not-equals operator.

Returns true unless each component is the same.

Parameters:

c	Rgb to compare with

Definition at line 76 of file rgb.h.

References CVD::Rgb< T >::blue, CVD::Rgb< T >::green, and CVD::Rgb< T >::red.

template<class T>

template<class T2 >

Rgb<T>& CVD::Rgb< T >::operator=

(

const Rgb< T2 > &

c

)

[inline]

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

Parameters:

c	The colour to copy from

Definition at line 82 of file rgb.h.

References CVD::Rgb< T >::blue, CVD::Rgb< T >::green, and CVD::Rgb< T >::red.

---

Friends And Related Function Documentation

template<class T >

std::ostream & operator<<	(	std::ostream &	os,
		const Rgb< T > &	x
	)		[related]

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

Parameters:

os	The stream
x	The colour object

Definition at line 97 of file rgb.h.

template<class T>

std::ostream & operator<<	(	std::ostream &	os,
		const Rgb< char > &	x
	)		[related]

Read a colour from a stream, interpreting three numbers as chars.

Parameters:

os	The stream
x	The colour object

Definition at line 107 of file rgb.h.

template<class T>

std::ostream & operator<<	(	std::ostream &	os,
		const Rgb< byte > &	x
	)		[related]

Read a colour from a stream, interpreting three numbers as bytes.

Parameters:

os	The stream
x	The colour object

Definition at line 118 of file rgb.h.

---

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

• cvd/rgb.h