CrystalSpace

Public API Reference
Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csColor Class Reference

A class used to represent a color in RGB space. More...

#include <cscolor.h>

List of all members.

Public Methods

 csColor ()
 Initialize a color object (contents undefined).

 csColor (float r, float g, float b)
 Initialize a color object with given R,G,B components.

 csColor (const csColor &c)
 Initialize a color object with an existing color.

void Set (float r, float g, float b)
 Set color to given R,G,B components.

void Clamp (float r, float g, float b)
 Clamp color to given R,G,B values.

void ClampDown ()
 Make sure color components are not negative.

csColor & operator= (const csColor &c)
 Assign one color object to another.

csColor & operator *= (float f)
 Multiply this color by a scalar value.

csColor & operator+= (const csColor &c)
 Add another color to this one.

csColor & operator-= (const csColor &c)
 Subtract another color to this one.

void Add (float r, float g, float b)
 Add given R,G,B components to color.

void Subtract (float r, float g, float b)
 Subtract given R,G,B components from color.


Public Attributes

float red
 Red (0..1).

float green
 Green (0..1).

float blue
 Blue (0..1).

Detailed Description

A class used to represent a color in RGB space.

This class is similar to csRGBpixel and csRGBcolor except that it uses floating-point values to store R,G,B values.

Definition at line 29 of file cscolor.h.

Constructor & Destructor Documentation

csColor::csColor (    )  [inline]
 

Initialize a color object (contents undefined).

Definition at line 41 of file cscolor.h.

csColor::csColor (  float    r,
float    g,
float    b
)  [inline]
 

Initialize a color object with given R,G,B components.

Definition at line 43 of file cscolor.h.

References blue, green, and red.

csColor::csColor (  const csColor &    c )  [inline]
 

Initialize a color object with an existing color.

Definition at line 46 of file cscolor.h.

References blue, green, and red.

Member Function Documentation

void csColor::Add (  float    r,
float    g,
float    b
)  [inline]
 

Add given R,G,B components to color.

Definition at line 78 of file cscolor.h.

References blue, green, and red.

void csColor::Clamp (  float    r,
float    g,
float    b
)  [inline]
 

Clamp color to given R,G,B values.

Definition at line 52 of file cscolor.h.

References blue, green, and red.

void csColor::ClampDown (    )  [inline]
 

Make sure color components are not negative.

Definition at line 59 of file cscolor.h.

References blue, green, and red.

csColor& csColor::operator *= (  float    f )  [inline]
 

Multiply this color by a scalar value.

Definition at line 69 of file cscolor.h.

References blue, green, and red.

csColor& csColor::operator+= (  const csColor &    c )  [inline]
 

Add another color to this one.

Definition at line 72 of file cscolor.h.

References blue, green, and red.

csColor& csColor::operator-= (  const csColor &    c )  [inline]
 

Subtract another color to this one.

Definition at line 75 of file cscolor.h.

References blue, green, and red.

csColor& csColor::operator= (  const csColor &    c )  [inline]
 

Assign one color object to another.

Definition at line 66 of file cscolor.h.

References blue, green, and red.

void csColor::Set (  float    r,
float    g,
float    b
)  [inline]
 

Set color to given R,G,B components.

Definition at line 49 of file cscolor.h.

References blue, green, and red.

void csColor::Subtract (  float    r,
float    g,
float    b
)  [inline]
 

Subtract given R,G,B components from color.

Definition at line 81 of file cscolor.h.

References blue, green, and red.

Member Data Documentation

float csColor::blue
 

Blue (0..1).

Definition at line 37 of file cscolor.h.

Referenced by Add(), Clamp(), ClampDown(), csColor(), operator *=(), operator+=(), operator-=(), operator=(), Set(), and Subtract().

float csColor::green
 

Green (0..1).

Definition at line 35 of file cscolor.h.

Referenced by Add(), Clamp(), ClampDown(), csColor(), operator *=(), operator+=(), operator-=(), operator=(), Set(), and Subtract().

float csColor::red
 

Red (0..1).

Definition at line 33 of file cscolor.h.

Referenced by Add(), Clamp(), ClampDown(), csColor(), operator *=(), operator+=(), operator-=(), operator=(), Set(), and Subtract().

The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18