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

#include <rgba.h>

List of all members.

Public Member Functions

bool operator!= (const Rgba< T > &c) const
template<typename T2 >
Rgba< T > & operator= (const Rgba< T2 > &c)
Rgba< T > & operator= (const Rgba< T > &c)
bool operator== (const Rgba< T > &c) const
 Rgba (T r, T g, T b, T a)
 Rgba ()
 Default constructor. Does nothing.

Public Attributes

alpha
 The alpha component.
blue
 The blue component.
green
 The green component.
red
 The red component.

Related Functions

(Note that these are not member functions.)



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

Detailed Description

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

A colour consisting of red, green, blue and alpha components

Parameters:
T The datatype of each component

Definition at line 38 of file rgba.h.


Constructor & Destructor Documentation

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

Default constructor. Does nothing.

Definition at line 42 of file rgba.h.

template<typename T>
CVD::Rgba< T >::Rgba ( r,
g,
b,
a 
) [inline]

Constructs a colour as specified

Parameters:
r The red component
g The green component
b The blue component
a The alpha component

Definition at line 48 of file rgba.h.


Member Function Documentation

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

Logical not-equals operator. Returns true unless each component is the same.

Parameters:
c Rgba to compare with

Definition at line 78 of file rgba.h.

template<typename T>
template<typename T2 >
Rgba<T>& CVD::Rgba< T >::operator= ( const Rgba< 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 63 of file rgba.h.

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

Assignment operator

Parameters:
c The colour to copy from

Definition at line 57 of file rgba.h.

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

Logical equals operator. Returns true if each component is the same.

Parameters:
c Rgba to compare with

Definition at line 73 of file rgba.h.


Friends And Related Function Documentation

template<typename T>
std::ostream & operator<< ( std::ostream &  os,
const Rgba< unsigned char > &  x 
) [related]

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

Parameters:
os The stream
x The colour object

Definition at line 99 of file rgba.h.

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

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

Parameters:
os The stream
x The colour object

Definition at line 89 of file rgba.h.


Member Data Documentation

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

The alpha component.

Definition at line 53 of file rgba.h.

template<typename T>
T CVD::Rgba< T >::blue

The blue component.

Definition at line 52 of file rgba.h.

template<typename T>
T CVD::Rgba< T >::green

The green component.

Definition at line 51 of file rgba.h.

template<typename T>
T CVD::Rgba< T >::red

The red component.

Definition at line 50 of file rgba.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:52 2013