CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

csColor4 Class Reference

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

#include <csutil/cscolor.h>

Inheritance diagram for csColor4:

csColor List of all members.

Public Member Functions

 csColor4 ()
 Initialize a color object (contents undefined).
 csColor4 (float r, float g, float b, float a=1.0f)
 Initialize a color object with given R,G,B,A components.
void Set (const csColor &c)
 Set color to given color.
void Set (float r, float g, float b)
 Set color to given R,G,B components.
csColor4operator= (const csColor4 &c)
 Assign one color object to another.
csColor4operator= (const csColor &c)
 Assign one color object to another/.
csColor4operator *= (float f)
 Multiply this color by a scalar value.
csColor4operator+= (const csColor4 &c)
 Add another color to this one.
csColor4operator+= (const csColor &c)
 Add another color to this one.
csColor4operator-= (const csColor4 &c)
 Subtract another color to this one.
csColoroperator-= (const csColor &c)
 Subtract another color to this one.
bool operator== (const csColor4 &c) const
 Compare equality of two colors.
bool operator!= (const csColor4 &c) const
 Compare inequality of two colors.

Public Attributes

float alpha
 Alpha value.

Detailed Description

A class used to represent a color in RGBA space.

Definition at line 107 of file cscolor.h.


Constructor & Destructor Documentation

csColor4::csColor4  )  [inline]
 

Initialize a color object (contents undefined).

Definition at line 114 of file cscolor.h.

csColor4::csColor4 float  r,
float  g,
float  b,
float  a = 1.0f
[inline]
 

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

Definition at line 116 of file cscolor.h.

References alpha.


Member Function Documentation

csColor4& csColor4::operator *= float  f  )  [inline]
 

Multiply this color by a scalar value.

Reimplemented from csColor.

Definition at line 154 of file cscolor.h.

References alpha.

bool csColor4::operator!= const csColor4 c  )  const [inline]
 

Compare inequality of two colors.

Definition at line 172 of file cscolor.h.

References alpha, csColor::blue, csColor::green, and csColor::red.

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

Add another color to this one.

Reimplemented from csColor.

Definition at line 160 of file cscolor.h.

References csColor::blue, csColor::green, and csColor::red.

csColor4& csColor4::operator+= const csColor4 c  )  [inline]
 

Add another color to this one.

Definition at line 157 of file cscolor.h.

References alpha, csColor::blue, csColor::green, and csColor::red.

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

Subtract another color to this one.

Reimplemented from csColor.

Definition at line 166 of file cscolor.h.

References csColor::blue, csColor::green, and csColor::red.

csColor4& csColor4::operator-= const csColor4 c  )  [inline]
 

Subtract another color to this one.

Definition at line 163 of file cscolor.h.

References alpha, csColor::blue, csColor::green, and csColor::red.

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

Assign one color object to another/.

Reimplemented from csColor.

Definition at line 151 of file cscolor.h.

References alpha, csColor::blue, csColor::green, and csColor::red.

csColor4& csColor4::operator= const csColor4 c  )  [inline]
 

Assign one color object to another.

Definition at line 148 of file cscolor.h.

References alpha, csColor::blue, csColor::green, and csColor::red.

bool csColor4::operator== const csColor4 c  )  const [inline]
 

Compare equality of two colors.

Definition at line 169 of file cscolor.h.

References alpha, csColor::blue, csColor::green, and csColor::red.

void csColor4::Set float  r,
float  g,
float  b
[inline]
 

Set color to given R,G,B components.

Reimplemented from csColor.

Definition at line 133 of file cscolor.h.

References alpha.

void csColor4::Set const csColor c  )  [inline]
 

Set color to given color.

Reimplemented from csColor.

Definition at line 119 of file cscolor.h.

References alpha, csColor::blue, csColor::green, and csColor::red.


Member Data Documentation

float csColor4::alpha
 

Alpha value.

Definition at line 111 of file cscolor.h.

Referenced by csColor4(), operator *=(), operator!=(), operator+=(), operator-=(), operator=(), operator==(), and Set().


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