CrystalSpace

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

csRGBcolor Struct Reference
[Graphics]

An RGB color. More...

#include <rgbpixel.h>

List of all members.

Public Methods

 csRGBcolor ()
 Constructor (initialize to zero). More...

 csRGBcolor (unsigned char r, unsigned char g, unsigned char b)
 Initialize the color with some R/G/B value. More...

void Set (unsigned char r, unsigned char g, unsigned char b)
 Assign given red/green/blue values to this pixel. More...

bool operator== (const csRGBcolor &c) const
 Compare with an csRGBcolor. More...

bool operator!= (const csRGBcolor &c) const
 Compare with an csRGBcolor. More...

csRGBcolor operator+ (const csRGBcolor &c) const
 add two csRGBcolors. More...


Public Attributes

unsigned char red
 The red, green, blue components. More...

unsigned char green
 The red, green, blue components. More...

unsigned char blue
 The red, green, blue components. More...

Detailed Description

An RGB color.

This class is used whenever we need just R, G and B information, such as when defining a color palette.

Definition at line 65 of file rgbpixel.h.

Constructor & Destructor Documentation

csRGBcolor::csRGBcolor (    )  [inline]
 

Constructor (initialize to zero).

Definition at line 70 of file rgbpixel.h.

References blue, green, and red.

Referenced by operator+.

csRGBcolor::csRGBcolor (  unsigned char    r,
unsigned char    g,
unsigned char    b
)  [inline]
 

Initialize the color with some R/G/B value.

Definition at line 72 of file rgbpixel.h.

References blue, green, and red.

Member Function Documentation

bool csRGBcolor::operator!= (  const csRGBcolor &    c )  const [inline]
 

Compare with an csRGBcolor.

Definition at line 81 of file rgbpixel.h.

References operator==.

csRGBcolor csRGBcolor::operator+ (  const csRGBcolor &    c )  const [inline]
 

add two csRGBcolors.

Definition at line 84 of file rgbpixel.h.

References blue, csRGBcolor, green, and red.

bool csRGBcolor::operator== (  const csRGBcolor &    c )  const [inline]
 

Compare with an csRGBcolor.

Definition at line 78 of file rgbpixel.h.

References blue, green, and red.

Referenced by operator!=.

void csRGBcolor::Set (  unsigned char    r,
unsigned char    g,
unsigned char    b
)  [inline]
 

Assign given red/green/blue values to this pixel.

Definition at line 75 of file rgbpixel.h.

References blue, green, and red.

Member Data Documentation

unsigned char csRGBcolor::blue
 

The red, green, blue components.

Definition at line 68 of file rgbpixel.h.

Referenced by csRGBVector::Compare, csRGBVector::CompareKey, csPackRGBcolorToRGB, csRGBcolor, csUnpackRGBAtoRGBcolor, csUnpackRGBtoRGBcolor, operator+, csRGBpixel::operator+=, csRGBpixel::operator==, operator==, and Set.

unsigned char csRGBcolor::green
 

The red, green, blue components.

Definition at line 68 of file rgbpixel.h.

Referenced by csRGBVector::Compare, csRGBVector::CompareKey, csPackRGBcolorToRGB, csRGBcolor, csUnpackRGBAtoRGBcolor, csUnpackRGBtoRGBcolor, operator+, csRGBpixel::operator+=, csRGBpixel::operator==, operator==, and Set.

unsigned char csRGBcolor::red
 

The red, green, blue components.

Definition at line 68 of file rgbpixel.h.

Referenced by csRGBVector::Compare, csRGBVector::CompareKey, csPackRGBcolorToRGB, csRGBcolor, csUnpackRGBAtoRGBcolor, csUnpackRGBtoRGBcolor, operator+, csRGBpixel::operator+=, csRGBpixel::operator==, operator==, and Set.

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