CVD::La< T > Class Template Reference

A colour consisting of luminance and alpha components. More...

#include <la.h>

Public Member Functions
	La ()
	Default constructor. Does nothing.
	La (T l, T a)
	Constructs a colour as specified. More...
La< T > &	operator= (const La< T > &c)
	Assignment operator. More...
template<typename T2 >
La< T > &	operator= (const La< T2 > &c)
	Assignment operator between two different storage types, using the standard casts as necessary. More...
bool	operator== (const La< T > &c) const
	Logical equals operator. More...
bool	operator!= (const La< T > &c) const
	Logical not-equals operator. More...

Public Attributes
T	luminance
	The luminance component.
T	alpha
	The alpha component.

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

Detailed Description

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

A colour consisting of luminance and alpha components.

Parameters

T	The datatype of each component

Constructor & Destructor Documentation

La()

template<typename T>

CVD::La< T >::La ( T  l, T  a  )

inline

Constructs a colour as specified.

Parameters

l	The luminance component
a	The alpha component

Member Function Documentation

operator!=()

template<typename T>

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

inline

Logical not-equals operator.

Returns true unless each component is the same.

Parameters

c	La to compare with

operator=() [1/2]

template<typename T>

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

inline

Assignment operator.

Parameters

c	The colour to copy from

operator=() [2/2]

template<typename T>

template<typename T2 >

La<T>& CVD::La< T >::operator= ( const La< 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::La< T >::operator== ( const La< T > &  c ) const

inline

Logical equals operator.

Returns true if each component is the same.

Parameters

c	La to compare with

Friends And Related Function Documentation

operator<<() [1/2]

template<typename T >

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

related

Write the colour to a stream in the format "(luminance,alpha)".

Parameters

os	The stream
x	The colour object

operator<<() [2/2]

template<typename T>

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

related

Write the colour to a stream in the format "(luminance,alpha)".

Parameters

os	The stream
x	The colour object

---

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

• cvd/la.h