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

#include <bgrx.h>

List of all members.

Public Member Functions

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

Public Attributes

blue
 The blue component.
dummy
 The dummy.
green
 The green component.
red
 The red component.

Related Functions

(Note that these are not member functions.)



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

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

Definition at line 37 of file bgrx.h.


Constructor & Destructor Documentation

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

Default constructor. Does nothing.

Definition at line 41 of file bgrx.h.

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

Constructs a colour as specified

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

Definition at line 46 of file bgrx.h.


Member Function Documentation

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

Definition at line 70 of file bgrx.h.

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

Definition at line 56 of file bgrx.h.

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

Definition at line 65 of file bgrx.h.


Friends And Related Function Documentation

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

Definition at line 91 of file bgrx.h.

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

Definition at line 81 of file bgrx.h.


Member Data Documentation

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

The blue component.

Definition at line 48 of file bgrx.h.

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

The dummy.

Definition at line 51 of file bgrx.h.

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

The green component.

Definition at line 49 of file bgrx.h.

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

The red component.

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