color.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Harry Storbacka
**    Mark Page
*/


#pragma once

#include "../api_display.h"
#include "../../Core/Text/string_types.h"
#include <vector>

class CL_PixelFormat;
class CL_Colord;
class CL_Colorf;

class CL_API_DISPLAY CL_Color
{

public:
        CL_Color() : color(0) { return; }

        explicit CL_Color(const CL_Colord&);
        explicit CL_Color(const CL_Colorf&);

        CL_Color(unsigned int red, unsigned int green, unsigned int blue, unsigned int alpha = 255)
                : color((alpha<<24) | (red<<16) | (green<<8) | blue) { return; }

        CL_Color(const CL_StringRef &hexstr);


public:
        unsigned int get_alpha() const { return (color >> 24) & 0xff; }

        unsigned int get_red() const { return (color >> 16) & 0xff; }

        unsigned int get_green() const { return (color >> 8) & 0xff; }

        unsigned int get_blue() const { return color & 0xff; }

        double get_alpha_d() const { return float(get_alpha()) / 255.0; }

        double get_red_d() const { return float(get_red()) / 255.0; }

        double get_green_d() const { return float(get_green()) / 255.0; }

        double get_blue_d() const { return float(get_blue()) / 255.0; }

        float get_alpha_f() const { return float(get_alpha()) / 255.0f; }

        float get_red_f() const { return float(get_red()) / 255.0f; }

        float get_green_f() const { return float(get_green()) / 255.0f; }

        float get_blue_f() const { return float(get_blue()) / 255.0f; }

        unsigned int color;

// Operations:
public:
        bool operator==(const CL_Color &c) const
        { return (color == c.color); }

        bool operator!=(const CL_Color &c) const
        { return (color != c.color); }


public:
        static CL_Color aliceblue;

        static CL_Color antiquewhite;

        static CL_Color aqua;

        static CL_Color aquamarine;

        static CL_Color azure;

        static CL_Color beige;

        static CL_Color bisque;

        static CL_Color black;

        static CL_Color blanchedalmond;

        static CL_Color blue;

        static CL_Color blueviolet;

        static CL_Color brown;

        static CL_Color burlywood;

        static CL_Color cadetblue;

        static CL_Color chartreuse;

        static CL_Color chocolate;

        static CL_Color coral;

        static CL_Color cornflowerblue;

        static CL_Color cornsilk;

        static CL_Color crimson;

        static CL_Color cyan;

        static CL_Color darkblue;

        static CL_Color darkcyan;

        static CL_Color darkgoldenrod;

        static CL_Color darkgray;

        static CL_Color darkgreen;

        static CL_Color darkgrey;

        static CL_Color darkkhaki;

        static CL_Color darkmagenta;

        static CL_Color darkolivegreen;

        static CL_Color darkorange;

        static CL_Color darkorchid;

        static CL_Color darkred;

        static CL_Color darksalmon;

        static CL_Color darkseagreen;

        static CL_Color darkslateblue;

        static CL_Color darkslategray;

        static CL_Color darkslategrey;

        static CL_Color darkturquoise;

        static CL_Color darkviolet;

        static CL_Color deeppink;

        static CL_Color deepskyblue;

        static CL_Color dimgray;

        static CL_Color dimgrey;

        static CL_Color dodgerblue;

        static CL_Color firebrick;

        static CL_Color floralwhite;

        static CL_Color forestgreen;

        static CL_Color fuchsia;

        static CL_Color gainsboro;

        static CL_Color ghostwhite;

        static CL_Color gold;

        static CL_Color goldenrod;

        static CL_Color gray;

        static CL_Color grey;

        static CL_Color green;

        static CL_Color greenyellow;

        static CL_Color honeydew;

        static CL_Color hotpink;

        static CL_Color indianred;

        static CL_Color indigo;

        static CL_Color ivory;

        static CL_Color khaki;

        static CL_Color lavender;

        static CL_Color lavenderblush;

        static CL_Color lawngreen;

        static CL_Color lemonchiffon;

        static CL_Color lightblue;

        static CL_Color lightcoral;

        static CL_Color lightcyan;

        static CL_Color lightgoldenrodyellow;

        static CL_Color lightgray;

        static CL_Color lightgreen;

        static CL_Color lightgrey;

        static CL_Color lightpink;

        static CL_Color lightsalmon;

        static CL_Color lightseagreen;

        static CL_Color lightskyblue;

        static CL_Color lightslategray;

        static CL_Color lightslategrey;

        static CL_Color lightsteelblue;

        static CL_Color lightyellow;

        static CL_Color lime;

        static CL_Color limegreen;

        static CL_Color linen;

        static CL_Color magenta;

        static CL_Color maroon;

        static CL_Color mediumaquamarine;

        static CL_Color mediumblue;

        static CL_Color mediumorchid;

        static CL_Color mediumpurple;

        static CL_Color mediumseagreen;

        static CL_Color mediumslateblue;

        static CL_Color mediumspringgreen;

        static CL_Color mediumturquoise;

        static CL_Color mediumvioletred;

        static CL_Color midnightblue;

        static CL_Color mintcream;

        static CL_Color mistyrose;

        static CL_Color moccasin;

        static CL_Color navajowhite;

        static CL_Color navy;

        static CL_Color oldlace;

        static CL_Color olive;

        static CL_Color olivedrab;

        static CL_Color orange;

        static CL_Color orangered;

        static CL_Color orchid;

        static CL_Color palegoldenrod;

        static CL_Color palegreen;

        static CL_Color paleturquoise;

        static CL_Color palevioletred;

        static CL_Color papayawhip;

        static CL_Color peachpuff;

        static CL_Color peru;

        static CL_Color pink;

        static CL_Color plum;

        static CL_Color powderblue;

        static CL_Color purple;

        static CL_Color red;

        static CL_Color rosybrown;

        static CL_Color royalblue;

        static CL_Color saddlebrown;

        static CL_Color salmon;

        static CL_Color sandybrown;

        static CL_Color seagreen;

        static CL_Color seashell;

        static CL_Color sienna;

        static CL_Color silver;

        static CL_Color skyblue;

        static CL_Color slateblue;

        static CL_Color slategray;

        static CL_Color slategrey;

        static CL_Color snow;

        static CL_Color springgreen;

        static CL_Color steelblue;

        static CL_Color tan;

        static CL_Color teal;

        static CL_Color thistle;

        static CL_Color tomato;

        static CL_Color turquoise;

        static CL_Color violet;

        static CL_Color wheat;

        static CL_Color white;

        static CL_Color whitesmoke;

        static CL_Color yellow;

        static CL_Color yellowgreen;

        static CL_Color transparent;

        static CL_Color gray10;
        static CL_Color gray20;
        static CL_Color gray30;
        static CL_Color gray40;
        static CL_Color gray50;
        static CL_Color gray60;
        static CL_Color gray70;
        static CL_Color gray80;
        static CL_Color gray90;

        static CL_Color find_color(const CL_StringRef &name);

        static std::vector<CL_String8> &get_names();


public:
        void set_alpha(unsigned int value) { color = (color & 0x00ffffff) | (value << 24); }

        void set_red(unsigned int value) { color = (color & 0xff00ffff) | (value << 16); }

        void set_green(unsigned int value) { color = (color & 0xffff00ff) | (value << 8); }

        void set_blue(unsigned int value) { color = (color & 0xffffff00) | value; }

        void set_alpha_d(float value) { set_alpha((unsigned int) (value*255)); }

        void set_red_d(float value) { set_red((unsigned int) (value*255)); }

        void set_green_d(float value) { set_green((unsigned int) (value*255)); }

        void set_blue_d(float value) { set_blue((unsigned int) (value*255)); }

        void set_color(unsigned int red, unsigned int green, unsigned int blue, unsigned int alpha = 255)
        { color = (alpha<<24) | (red<<16) | (green<<8) | blue; }

        void set_color_d(float red, float green, float blue, float alpha = 1.0)
        {
                color =
                        (((unsigned int) (alpha*255))<<24) |
                        (((unsigned int) (red*255))<<16) |
                        (((unsigned int) (green*255))<<8) |
                        ((unsigned int) (blue*255));
        }

        unsigned int to_pixelformat(const CL_PixelFormat &pf) const;

        static CL_Color from_pixelformat(unsigned int raw_color, const CL_PixelFormat &pf);
};

class CL_Colord
{

public:

        CL_Colord() : r(0.0), g(0.0), b(0.0), a(0.0)
        {
        }

        CL_Colord(double r, double g, double b, double a = 1.0)
                : r(r), g(g), b(b), a(a)
        {
        }

        CL_Colord(unsigned char r, unsigned char g, unsigned char b, unsigned char a=255)
                : r(r/255.0),
                  g(g/255.0),
                  b(b/255.0),
                  a(a/255.0)
        {
        }

        explicit CL_Colord(const CL_Color& color)
                : r(color.get_red()/255.0),
                  g(color.get_green()/255.0),
                  b(color.get_blue()/255.0),
                  a(color.get_alpha()/255.0)
        {
        }

        CL_Colord(const CL_StringRef &hexstr)
        {
                *this = (CL_Colord)CL_Color::find_color(hexstr);
        }


public:
        double r, g, b, a;

        double get_red() const { return r; }

        double get_green() const { return g; }

        double get_blue() const { return b; }

        double get_alpha() const { return a; }


public:
        void normalize()
        {
                r = (r < 0.0) ? 0.0 : ((r > 1.0) ? 1.0 : r);
                g = (g < 0.0) ? 0.0 : ((g > 1.0) ? 1.0 : g);
                b = (b < 0.0) ? 0.0 : ((b > 1.0) ? 1.0 : b);
                a = (a < 0.0) ? 0.0 : ((a > 1.0) ? 1.0 : a);
        }

        void set_alpha(double value) { a = value; }

        void set_red(double value) {  r = value; }

        void set_green(double value) { g= value; }

        void set_blue(double value) { b = value; }

        bool operator==(const CL_Colord &c) const
        {
                return (r == c.r) && (g == c.g) && (b == c.b) && (a == c.a);
        }

        bool operator!=(const CL_Colord &c) const
        {
                return (r != c.r) || (g != c.g) || (b != c.b) || (a != c.a);
        }

        operator CL_Color() const
        {
                return CL_Color(*this);
        }


public:
        static CL_Colord aliceblue;

        static CL_Colord antiquewhite;

        static CL_Colord aqua;

        static CL_Colord aquamarine;

        static CL_Colord azure;

        static CL_Colord beige;

        static CL_Colord bisque;

        static CL_Colord black;

        static CL_Colord blanchedalmond;

        static CL_Colord blue;

        static CL_Colord blueviolet;

        static CL_Colord brown;

        static CL_Colord burlywood;

        static CL_Colord cadetblue;

        static CL_Colord chartreuse;

        static CL_Colord chocolate;

        static CL_Colord coral;

        static CL_Colord cornflowerblue;

        static CL_Colord cornsilk;

        static CL_Colord crimson;

        static CL_Colord cyan;

        static CL_Colord darkblue;

        static CL_Colord darkcyan;

        static CL_Colord darkgoldenrod;

        static CL_Colord darkgray;

        static CL_Colord darkgreen;

        static CL_Colord darkgrey;

        static CL_Colord darkkhaki;

        static CL_Colord darkmagenta;

        static CL_Colord darkolivegreen;

        static CL_Colord darkorange;

        static CL_Colord darkorchid;

        static CL_Colord darkred;

        static CL_Colord darksalmon;

        static CL_Colord darkseagreen;

        static CL_Colord darkslateblue;

        static CL_Colord darkslategray;

        static CL_Colord darkslategrey;

        static CL_Colord darkturquoise;

        static CL_Colord darkviolet;

        static CL_Colord deeppink;

        static CL_Colord deepskyblue;

        static CL_Colord dimgray;

        static CL_Colord dimgrey;

        static CL_Colord dodgerblue;

        static CL_Colord firebrick;

        static CL_Colord floralwhite;

        static CL_Colord forestgreen;

        static CL_Colord fuchsia;

        static CL_Colord gainsboro;

        static CL_Colord ghostwhite;

        static CL_Colord gold;

        static CL_Colord goldenrod;

        static CL_Colord gray;

        static CL_Colord grey;

        static CL_Colord green;

        static CL_Colord greenyellow;

        static CL_Colord honeydew;

        static CL_Colord hotpink;

        static CL_Colord indianred;

        static CL_Colord indigo;

        static CL_Colord ivory;

        static CL_Colord khaki;

        static CL_Colord lavender;

        static CL_Colord lavenderblush;

        static CL_Colord lawngreen;

        static CL_Colord lemonchiffon;

        static CL_Colord lightblue;

        static CL_Colord lightcoral;

        static CL_Colord lightcyan;

        static CL_Colord lightgoldenrodyellow;

        static CL_Colord lightgray;

        static CL_Colord lightgreen;

        static CL_Colord lightgrey;

        static CL_Colord lightpink;

        static CL_Colord lightsalmon;

        static CL_Colord lightseagreen;

        static CL_Colord lightskyblue;

        static CL_Colord lightslategray;

        static CL_Colord lightslategrey;

        static CL_Colord lightsteelblue;

        static CL_Colord lightyellow;

        static CL_Colord lime;

        static CL_Colord limegreen;

        static CL_Colord linen;

        static CL_Colord magenta;

        static CL_Colord maroon;

        static CL_Colord mediumaquamarine;

        static CL_Colord mediumblue;

        static CL_Colord mediumorchid;

        static CL_Colord mediumpurple;

        static CL_Colord mediumseagreen;

        static CL_Colord mediumslateblue;

        static CL_Colord mediumspringgreen;

        static CL_Colord mediumturquoise;

        static CL_Colord mediumvioletred;

        static CL_Colord midnightblue;

        static CL_Colord mintcream;

        static CL_Colord mistyrose;

        static CL_Colord moccasin;

        static CL_Colord navajowhite;

        static CL_Colord navy;

        static CL_Colord oldlace;

        static CL_Colord olive;

        static CL_Colord olivedrab;

        static CL_Colord orange;

        static CL_Colord orangered;

        static CL_Colord orchid;

        static CL_Colord palegoldenrod;

        static CL_Colord palegreen;

        static CL_Colord paleturquoise;

        static CL_Colord palevioletred;

        static CL_Colord papayawhip;

        static CL_Colord peachpuff;

        static CL_Colord peru;

        static CL_Colord pink;

        static CL_Colord plum;

        static CL_Colord powderblue;

        static CL_Colord purple;

        static CL_Colord red;

        static CL_Colord rosybrown;

        static CL_Colord royalblue;

        static CL_Colord saddlebrown;

        static CL_Colord salmon;

        static CL_Colord sandybrown;

        static CL_Colord seagreen;

        static CL_Colord seashell;

        static CL_Colord sienna;

        static CL_Colord silver;

        static CL_Colord skyblue;

        static CL_Colord slateblue;

        static CL_Colord slategray;

        static CL_Colord slategrey;

        static CL_Colord snow;

        static CL_Colord springgreen;

        static CL_Colord steelblue;

        static CL_Colord tan;

        static CL_Colord teal;

        static CL_Colord thistle;

        static CL_Colord tomato;

        static CL_Colord turquoise;

        static CL_Colord violet;

        static CL_Colord wheat;

        static CL_Colord white;

        static CL_Colord whitesmoke;

        static CL_Colord yellow;

        static CL_Colord yellowgreen;

        static CL_Colord transparent;

        static CL_Colord gray10;
        static CL_Colord gray20;
        static CL_Colord gray30;
        static CL_Colord gray40;
        static CL_Colord gray50;
        static CL_Colord gray60;
        static CL_Colord gray70;
        static CL_Colord gray80;
        static CL_Colord gray90;
};

class CL_Colorf
{

public:
        CL_Colorf() : r(0.0f), g(0.0f), b(0.0f), a(0.0f)
        {
        }

        CL_Colorf(float r, float g, float b, float a = 1.0f)
                : r(r), g(g), b(b), a(a)
        {
        }

        CL_Colorf(unsigned char r, unsigned char g, unsigned char b, unsigned char a=255)
                : r(r/255.0f),
                  g(g/255.0f),
                  b(b/255.0f),
                  a(a/255.0f)
        {
        }

        explicit CL_Colorf(const CL_Color& color)
                : r(color.get_red()/255.0f),
                  g(color.get_green()/255.0f),
                  b(color.get_blue()/255.0f),
                  a(color.get_alpha()/255.0f)
        {
        }

        CL_Colorf(const CL_StringRef &hexstr)
        {
                *this = (CL_Colorf)CL_Color::find_color(hexstr);
        }


public:
        float r, g, b, a;

        float get_red() const { return r; }

        float get_green() const { return g; }

        float get_blue() const { return b; }

        float get_alpha() const { return a; }


public:
        void normalize()
        {
                r = (r < 0.0f) ? 0.0f : ((r > 1.0f) ? 1.0f : r);
                g = (g < 0.0f) ? 0.0f : ((g > 1.0f) ? 1.0f : g);
                b = (b < 0.0f) ? 0.0f : ((b > 1.0f) ? 1.0f : b);
                a = (a < 0.0f) ? 0.0f : ((a > 1.0f) ? 1.0f : a);
        }

        void set_alpha(float value) { a = value; }

        void set_red(float value) {  r = value; }

        void set_green(float value) { g= value; }

        void set_blue(float value) { b = value; }

        bool operator==(const CL_Colorf &c) const
        {
                return (r == c.r) && (g == c.g) && (b == c.b) && (a == c.a);
        }

        bool operator!=(const CL_Colorf &c) const
        {
                return (r != c.r) || (g != c.g) || (b != c.b) || (a != c.a);
        }

        operator CL_Color() const
        {
                return CL_Color(*this);
        }


public:
        static CL_Colorf aliceblue;

        static CL_Colorf antiquewhite;

        static CL_Colorf aqua;

        static CL_Colorf aquamarine;

        static CL_Colorf azure;

        static CL_Colorf beige;

        static CL_Colorf bisque;

        static CL_Colorf black;

        static CL_Colorf blanchedalmond;

        static CL_Colorf blue;

        static CL_Colorf blueviolet;

        static CL_Colorf brown;

        static CL_Colorf burlywood;

        static CL_Colorf cadetblue;

        static CL_Colorf chartreuse;

        static CL_Colorf chocolate;

        static CL_Colorf coral;

        static CL_Colorf cornflowerblue;

        static CL_Colorf cornsilk;

        static CL_Colorf crimson;

        static CL_Colorf cyan;

        static CL_Colorf darkblue;

        static CL_Colorf darkcyan;

        static CL_Colorf darkgoldenrod;

        static CL_Colorf darkgray;

        static CL_Colorf darkgreen;

        static CL_Colorf darkgrey;

        static CL_Colorf darkkhaki;

        static CL_Colorf darkmagenta;

        static CL_Colorf darkolivegreen;

        static CL_Colorf darkorange;

        static CL_Colorf darkorchid;

        static CL_Colorf darkred;

        static CL_Colorf darksalmon;

        static CL_Colorf darkseagreen;

        static CL_Colorf darkslateblue;

        static CL_Colorf darkslategray;

        static CL_Colorf darkslategrey;

        static CL_Colorf darkturquoise;

        static CL_Colorf darkviolet;

        static CL_Colorf deeppink;

        static CL_Colorf deepskyblue;

        static CL_Colorf dimgray;

        static CL_Colorf dimgrey;

        static CL_Colorf dodgerblue;

        static CL_Colorf firebrick;

        static CL_Colorf floralwhite;

        static CL_Colorf forestgreen;

        static CL_Colorf fuchsia;

        static CL_Colorf gainsboro;

        static CL_Colorf ghostwhite;

        static CL_Colorf gold;

        static CL_Colorf goldenrod;

        static CL_Colorf gray;

        static CL_Colorf grey;

        static CL_Colorf green;

        static CL_Colorf greenyellow;

        static CL_Colorf honeydew;

        static CL_Colorf hotpink;

        static CL_Colorf indianred;

        static CL_Colorf indigo;

        static CL_Colorf ivory;

        static CL_Colorf khaki;

        static CL_Colorf lavender;

        static CL_Colorf lavenderblush;

        static CL_Colorf lawngreen;

        static CL_Colorf lemonchiffon;

        static CL_Colorf lightblue;

        static CL_Colorf lightcoral;

        static CL_Colorf lightcyan;

        static CL_Colorf lightgoldenrodyellow;

        static CL_Colorf lightgray;

        static CL_Colorf lightgreen;

        static CL_Colorf lightgrey;

        static CL_Colorf lightpink;

        static CL_Colorf lightsalmon;

        static CL_Colorf lightseagreen;

        static CL_Colorf lightskyblue;

        static CL_Colorf lightslategray;

        static CL_Colorf lightslategrey;

        static CL_Colorf lightsteelblue;

        static CL_Colorf lightyellow;

        static CL_Colorf lime;

        static CL_Colorf limegreen;

        static CL_Colorf linen;

        static CL_Colorf magenta;

        static CL_Colorf maroon;

        static CL_Colorf mediumaquamarine;

        static CL_Colorf mediumblue;

        static CL_Colorf mediumorchid;

        static CL_Colorf mediumpurple;

        static CL_Colorf mediumseagreen;

        static CL_Colorf mediumslateblue;

        static CL_Colorf mediumspringgreen;

        static CL_Colorf mediumturquoise;

        static CL_Colorf mediumvioletred;

        static CL_Colorf midnightblue;

        static CL_Colorf mintcream;

        static CL_Colorf mistyrose;

        static CL_Colorf moccasin;

        static CL_Colorf navajowhite;

        static CL_Colorf navy;

        static CL_Colorf oldlace;

        static CL_Colorf olive;

        static CL_Colorf olivedrab;

        static CL_Colorf orange;

        static CL_Colorf orangered;

        static CL_Colorf orchid;

        static CL_Colorf palegoldenrod;

        static CL_Colorf palegreen;

        static CL_Colorf paleturquoise;

        static CL_Colorf palevioletred;

        static CL_Colorf papayawhip;

        static CL_Colorf peachpuff;

        static CL_Colorf peru;

        static CL_Colorf pink;

        static CL_Colorf plum;

        static CL_Colorf powderblue;

        static CL_Colorf purple;

        static CL_Colorf red;

        static CL_Colorf rosybrown;

        static CL_Colorf royalblue;

        static CL_Colorf saddlebrown;

        static CL_Colorf salmon;

        static CL_Colorf sandybrown;

        static CL_Colorf seagreen;

        static CL_Colorf seashell;

        static CL_Colorf sienna;

        static CL_Colorf silver;

        static CL_Colorf skyblue;

        static CL_Colorf slateblue;

        static CL_Colorf slategray;

        static CL_Colorf slategrey;

        static CL_Colorf snow;

        static CL_Colorf springgreen;

        static CL_Colorf steelblue;

        static CL_Colorf tan;

        static CL_Colorf teal;

        static CL_Colorf thistle;

        static CL_Colorf tomato;

        static CL_Colorf turquoise;

        static CL_Colorf violet;

        static CL_Colorf wheat;

        static CL_Colorf white;

        static CL_Colorf whitesmoke;

        static CL_Colorf yellow;

        static CL_Colorf yellowgreen;

        static CL_Colorf transparent;

        static CL_Colorf gray10;
        static CL_Colorf gray20;
        static CL_Colorf gray30;
        static CL_Colorf gray40;
        static CL_Colorf gray50;
        static CL_Colorf gray60;
        static CL_Colorf gray70;
        static CL_Colorf gray80;
        static CL_Colorf gray90;
};

---