CVD::La< T > Class Template Reference
[Image storage and manipulation]

#include <la.h>

List of all members.

Public Member Functions

 La (T l, T a)
 La ()
 Default constructor. Does nothing.
bool operator!= (const La< T > &c) const
template<typename T2 >
La< T > & operator= (const La< T2 > &c)
La< T > & operator= (const La< T > &c)
bool operator== (const La< T > &c) const

Public Attributes

alpha
 The alpha component.
luminance
 The luminance component.

Related Functions

(Note that these are not member functions.)



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

Detailed Description

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

A colour consisting of luminance and alpha components

Parameters:
T The datatype of each component

Definition at line 38 of file la.h.


Constructor & Destructor Documentation

template<typename T>
CVD::La< T >::La (  )  [inline]

Default constructor. Does nothing.

Definition at line 42 of file la.h.

template<typename T>
CVD::La< T >::La ( l,
a 
) [inline]

Constructs a colour as specified

Parameters:
l The luminance component
a The alpha component

Definition at line 46 of file la.h.


Member Function Documentation

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

Definition at line 72 of file la.h.

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

Definition at line 59 of file la.h.

template<typename T>
La<T>& CVD::La< T >::operator= ( const La< T > &  c  )  [inline]

Assignment operator

Parameters:
c The colour to copy from

Definition at line 53 of file la.h.

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

Definition at line 67 of file la.h.


Friends And Related Function Documentation

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

Definition at line 91 of file la.h.

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

Definition at line 82 of file la.h.


Member Data Documentation

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

The alpha component.

Definition at line 49 of file la.h.

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

The luminance component.

Definition at line 48 of file la.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


libcvd
Author(s): Edward Rosten, Paul Smith, Tom Drummond, Gerhard Reitmayr, Ethan Eade, Timothy Gan, Chris Kemp, Georg Klein
autogenerated on Fri Jan 11 09:13:51 2013