Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

color Class Reference

simple class for handling a color. More...

#include <color.h>

List of all members.

Public Types

typedef unsigned char value_type
 The type of the color components.


Public Methods

 color () throw ()
 color (value_type, value_type, value_type) throw ()
 color (const color &) throw ()
color & operator= (const color &)
virtual ~color () throw ()
value_type red () const throw ()
value_type green () const throw ()
value_type blue () const throw ()
void delta (short *ptr) throw ()
 handle delta palette modification


Private Attributes

value_type _r
 The red component.

value_type _g
 The green component.

value_type _b
 The blue component.


Detailed Description

simple class for handling a color.

This small class is an helper for colors.

Definition at line 33 of file color.h.


Member Typedef Documentation

typedef unsigned char color::value_type
 

The type of the color components.

Definition at line 35 of file color.h.

Referenced by blue(), green(), and red().


Constructor & Destructor Documentation

color::color   throw ()
 

Definition at line 25 of file color.cpp.

Referenced by operator=().

color::color value_type   ,
value_type   ,
value_type   
throw ()
 

Definition at line 28 of file color.cpp.

color::color const color &    throw ()
 

Definition at line 31 of file color.cpp.

color::~color   throw () [virtual]
 

Definition at line 41 of file color.cpp.


Member Function Documentation

color::value_type color::blue   const throw ()
 

Definition at line 52 of file color.cpp.

References value_type.

Referenced by operator<<().

void color::delta short *    ptr throw ()
 

handle delta palette modification

This method is used specifically by player::handleDeltaPalette(). It updates the color component using delta values given as short.

Parameters:
ptr  pointer to a table of 3 shorts that contain delta values to use.

Definition at line 56 of file color.cpp.

color::value_type color::green   const throw ()
 

Definition at line 48 of file color.cpp.

References value_type.

Referenced by operator<<().

color::color & color::operator= const color &   
 

Definition at line 34 of file color.cpp.

References _b, _g, _r, and color().

color::value_type color::red   const throw ()
 

Definition at line 44 of file color.cpp.

References value_type.

Referenced by operator<<().


Member Data Documentation

value_type color::_b [private]
 

The blue component.

Definition at line 39 of file color.h.

Referenced by operator=().

value_type color::_g [private]
 

The green component.

Definition at line 38 of file color.h.

Referenced by operator=().

value_type color::_r [private]
 

The red component.

Definition at line 37 of file color.h.

Referenced by operator=().


The documentation for this class was generated from the following files:
Generated on Fri Aug 9 22:54:31 2002 for san_player by doxygen1.2.16