#include <argb.h>
List of all members.
Public Member Functions |
| Argb (T a, T r, T g, T b) |
| Argb () |
| Default constructor. Does nothing.
|
bool | operator!= (const Argb< T > &c) const |
template<typename T2 > |
Argb< T > & | operator= (const Argb< T2 > &c) |
Argb< T > & | operator= (const Argb< T > &c) |
bool | operator== (const Argb< T > &c) const |
Public Attributes |
T | alpha |
| The alpha component.
|
T | blue |
| The blue component.
|
T | green |
| The green component.
|
T | red |
| The red component.
|
Related Functions |
(Note that these are not member functions.)
|
std::ostream & | operator<< (std::ostream &os, const Argb< unsigned char > &x) |
template<typename T > |
std::ostream & | operator<< (std::ostream &os, const Argb< T > &x) |
Detailed Description
template<typename T>
class CVD::Argb< T >
A colour consisting of red, green, blue and alpha components
- Parameters:
-
| T | The datatype of each component |
Definition at line 37 of file argb.h.
Constructor & Destructor Documentation
Default constructor. Does nothing.
Definition at line 29 of file argb.h.
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 35 of file argb.h.
Member Function Documentation
template<typename T>
bool CVD::Argb< T >::operator!= |
( |
const Argb< T > & |
c |
) |
const [inline] |
Logical not-equals operator. Returns true unless each component is the same.
- Parameters:
-
Definition at line 65 of file argb.h.
template<typename T>
template<typename T2 >
Assignment operator between two different storage types, using the standard casts as necessary
- Parameters:
-
| c | The colour to copy from |
Definition at line 50 of file argb.h.
Assignment operator
- Parameters:
-
| c | The colour to copy from |
Definition at line 44 of file argb.h.
template<typename T>
bool CVD::Argb< T >::operator== |
( |
const Argb< T > & |
c |
) |
const [inline] |
Logical equals operator. Returns true if each component is the same.
- Parameters:
-
Definition at line 60 of file argb.h.
Friends And Related Function Documentation
template<typename T>
std::ostream & operator<< |
( |
std::ostream & |
os, |
|
|
const Argb< 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 98 of file argb.h.
template<typename T >
std::ostream & operator<< |
( |
std::ostream & |
os, |
|
|
const Argb< 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 88 of file argb.h.
Member Data Documentation
The alpha component.
Definition at line 40 of file argb.h.
The blue component.
Definition at line 37 of file argb.h.
The green component.
Definition at line 38 of file argb.h.
The red component.
Definition at line 39 of file argb.h.
The documentation for this class was generated from the following file:
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