[AE Engine logo] Public API Reference
Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

aeColor4 Class Reference

A class representing RGBA color. More...

#include <color4.h>

List of all members.

Public Member Functions

 aeColor4 ()
 Create a new color and initialize it to 1.0, 1.0, 1.0, 1.0 (white, solid).

 aeColor4 (float r, float g, float b, float a)
 Create a new color and initialize it to r, g, b, a.

void set (float r, float g, float b, float a)
 Set this color to a given RGBA value.

void clamp (float r, float g, float b, float a)
 Clamp the color to given RGBA values.

void clampDown ()
 Check that color components are not negative.

void add (float r, float g, float b, float a)
 Add given RGBA values to this color.

void subtract (float r, float g, float b, float a)
 Subtract given RGBA values from this color.

aeColor4 operator= (aeColor4 c)
aeColor4 operator+ (aeColor4 c)
aeColor4 operator- (aeColor4 c)
aeColor4 operator * (float num)

Public Attributes

float red
 The red component of this color.

float green
 The green component of this color.

float blue
 The blue component of this color.

float alpha
 The alpha component of this color.


Detailed Description

A class representing RGBA color.

Definition at line 33 of file color4.h.


Constructor & Destructor Documentation

aeColor4::aeColor4  
 

Create a new color and initialize it to 1.0, 1.0, 1.0, 1.0 (white, solid).

aeColor4::aeColor4 float    r,
float    g,
float    b,
float    a
 

Create a new color and initialize it to r, g, b, a.

Parameters:
r Red.
g Green.
b Blue.
a Alpha.


Member Function Documentation

void aeColor4::add float    r,
float    g,
float    b,
float    a
 

Add given RGBA values to this color.

Parameters:
r Red
g Green
b Blue
a Alpha.

void aeColor4::clamp float    r,
float    g,
float    b,
float    a
 

Clamp the color to given RGBA values.

Parameters:
r Red.
g Green.
b Blue.
a Alpha.

void aeColor4::clampDown  
 

Check that color components are not negative.

void aeColor4::set float    r,
float    g,
float    b,
float    a
 

Set this color to a given RGBA value.

Parameters:
r Red.
g Green.
b Blue.
a Alpha.

void aeColor4::subtract float    r,
float    g,
float    b,
float    a
 

Subtract given RGBA values from this color.

Parameters:
r Red.
g Green.
b Blue.
a Alpha.


The documentation for this class was generated from the following file:
AE Engine Public API Reference
Generated on Wed Apr 9 09:43:40 2003 by Doxygen.