Color Class Reference

#include <color.h>

Public Member Functions
	Color ()
	Color (const unsigned int color)
	Color (const unsigned int ar, const unsigned int ag, const unsigned int ab, const unsigned int aa)
Color	operator+ (const Color &color) const
Color	operator- (const Color &color) const
Color	operator* (const float value) const
bool	operator== (const Color &color) const
bool	operator!= (const Color &color) const

Data Fields
unsigned int	r
unsigned int	g
unsigned int	b
unsigned int	a

Detailed Description

Represents a color with red, green, blue and alpha components.

Definition at line 75 of file color.h.

Constructor & Destructor Documentation

Color() [1/3]

Color::Color ( )

inline

Constructor. Initializes the color to black.

Definition at line 81 of file color.h.

                          :
            r(0U),
            g(0U),
            b(0U),
            a(255U)
        {
        }

Color() [2/3]

Color::Color ( const unsigned int  color )

inlineexplicit

Constructor. Constructs a color from the bytes in an integer. Call it with a hexadecimal constant for HTML-style color representation. The alpha component is 255 by default.

EXAMPLE: Color(0xff50a0) constructs a very nice pinkish color.

NOTE: Because of this constructor, integers will be automatically casted to a color by your compiler.

Parameters

color

The color to initialise the object with.

Definition at line 102 of file color.h.

                                                           :
            r((color >> 16) & 0xFFU),
            g((color >>  8) & 0xFFU),
            b(color         & 0xFFU),
            a(255U)
        {
        }

Color() [3/3]

Color::Color ( const unsigned int  ar, const unsigned int  ag, const unsigned int  ab, const unsigned int  aa  )

inline

Constructor. The default alpha value is 255.

Parameters

ar	Red color component (range 0-255).
ag	Green color component (range 0-255).
ab	Blue color component (range 0-255).
aa	Alpha, used for transparency. A value of 0 means totaly transparent, 255 is totaly opaque.

Definition at line 119 of file color.h.

                                               :
            r(ar),
            g(ag),
            b(ab),
            a(aa)
        {
        }

Member Function Documentation

operator!=()

bool Color::operator!= ( const Color &  color ) const

inline

Compares two colors.

Returns

True if the two colors have different RGBA components, false otherwise.

Definition at line 224 of file color.h.

        {
            return !(r == color.r &&
                g == color.g &&
                b == color.b &&
                a == color.a);
        }

References a, b, g, and r.

operator*()

Color Color::operator* ( const float  value ) const

inline

Multiplies the RGB values of a color with a float value. The values will be clamped if they go out of range.

Parameters

value

The value to multiply the color with.

Returns

The multiplied colors. The alpha value will, unlike the add and subtract operations, be multiplied as well.

Definition at line 190 of file color.h.

        {
            Color result(CAST_U32(static_cast<float>(r) * value),
                         CAST_U32(static_cast<float>(g) * value),
                         CAST_U32(static_cast<float>(b) * value),
                         a);
 
            result.r = (result.r > 255U ? 255U : result.r);
            result.g = (result.g > 255U ? 255U : result.g);
            result.b = (result.b > 255U ? 255U : result.b);
 
            return result;
        }

References a, b, CAST_U32, g, and r.

operator+()

Color Color::operator+ ( const Color &  color ) const

inline

Adds the RGB values of two colors together. The values will be clamped if they go out of range.

WARNING: This function will reset the alpha value of the returned color to 255.

Parameters

color

A color to add to this color.

Returns

The added colors with an alpha value set to 255.

Definition at line 143 of file color.h.

        {
            Color result(r + color.r,
                         g + color.g,
                         b + color.b,
                         255U);
 
            result.r = (result.r > 255U ? 255U : result.r);
            result.g = (result.g > 255U ? 255U : result.g);
            result.b = (result.b > 255U ? 255U : result.b);
 
            return result;
        }

References b, g, and r.

operator-()

Color Color::operator- ( const Color &  color ) const

inline

Subtracts the RGB values of one color from another. The values will be clamped if they go out of range.

WARNING: This function will reset the alpha value of the returned color to 255.

Parameters

color

A color to subtract from this color.

Returns

The subtracted colors with an alpha value set to 255.

Definition at line 167 of file color.h.

        {
            Color result(r - color.r,
                         g - color.g,
                         b - color.b,
                         255U);
 
            result.r = (result.r > 255U ? 255U : result.r);
            result.g = (result.g > 255U ? 255U : result.g);
            result.b = (result.b > 255U ? 255U : result.b);
 
            return result;
        }

References b, g, and r.

operator==()

bool Color::operator== ( const Color &  color ) const

inline

Compares two colors.

Returns

True if the two colors have the same RGBA components false otherwise.

Definition at line 210 of file color.h.

        {
            return r == color.r &&
                g == color.g &&
                b == color.b &&
                a == color.a;
        }

References a, b, g, and r.

Field Documentation

a

unsigned int Color::a

Holds the alpha color component. A value of 0 means totally transparent while a value of 255 is considered opaque.

Definition at line 251 of file color.h.

Referenced by ColorPage::draw(), DropDown::draw(), ExtendedListBox::draw(), GuiTable::draw(), ListBox::draw(), ProgressBar::draw(), ServersListBox::draw(), ShopListBox::draw(), SkillListBox::draw(), SkillRectangleListBox::draw(), TextParticle::draw(), AvatarListBox::draw(), Font::drawString(), Font::generate(), Theme::getColor(), UserPalette::getColor(), UserPalette::getColorWithAlpha(), operator!=(), operator*(), TextChunkSmall::operator<(), operator==(), restoreColor(), GuiTable::safeDraw(), ProgressBar::safeDraw(), AvatarListBox::safeDraw(), and SDLputPixelAlpha().

b

unsigned int Color::b

Holds the blue color component (range 0-255).

Definition at line 245 of file color.h.

Referenced by Palette::advanceGradient(), Setup_Colors::cancel(), ShopListBox::draw(), TextPreview::draw(), TextChunk::generate(), Palette::ColorElem::getRGB(), ProgressBar::logic(), operator!=(), operator*(), operator+(), operator-(), TextChunkSmall::operator<(), operator==(), restoreColor(), UserPalette::rollback(), SDLputPixel(), SDLputPixelAlpha(), UserPalette::setColor(), and Setup_Colors::valueChanged().

g

unsigned int Color::g

Holds the green color component (range 0-255).

Definition at line 240 of file color.h.

Referenced by Palette::advanceGradient(), Setup_Colors::cancel(), ShopListBox::draw(), TextPreview::draw(), TextChunk::generate(), Palette::ColorElem::getRGB(), ProgressBar::logic(), operator!=(), operator*(), operator+(), operator-(), TextChunkSmall::operator<(), operator==(), restoreColor(), UserPalette::rollback(), SDLputPixel(), SDLputPixelAlpha(), UserPalette::setColor(), and Setup_Colors::valueChanged().

r

unsigned int Color::r

Holds the red color component (range 0-255).

Definition at line 235 of file color.h.

Referenced by Palette::advanceGradient(), Setup_Colors::cancel(), ShopListBox::draw(), TextPreview::draw(), TextChunk::generate(), Palette::ColorElem::getRGB(), ProgressBar::logic(), operator!=(), operator*(), operator+(), operator-(), TextChunkSmall::operator<(), operator==(), restoreColor(), UserPalette::rollback(), SDLputPixel(), SDLputPixelAlpha(), UserPalette::setColor(), and Setup_Colors::valueChanged().

---

The documentation for this class was generated from the following file:

• src/gui/color.h (986a3bf)