Color.hpp

Go to the documentation of this file.

#ifndef GOSU_COLOR_HPP
#define GOSU_COLOR_HPP

#include <boost/cstdint.hpp>

namespace Gosu
{
    class Color
    {
        boost::uint32_t rep;

    public:
        typedef boost::uint8_t Channel;

        Color()
        {
        }

        Color(boost::uint32_t argb)
        : rep(argb)
        {
        }

        Color(Channel red, Channel green, Channel blue)
        {
            rep = (0xff << 24) | (red << 16) | (green << 8) | blue;
        }

        Color(Channel alpha, Channel red, Channel green, Channel blue)
        {
            rep = (alpha << 24) | (red << 16) | (green << 8) | blue;
        }
        
        static Color fromHSV(double h, double s, double v);
        static Color fromAHSV(Channel alpha, double h, double s, double v);

        Channel alpha() const
        {
            return static_cast<Channel>((rep >> 24) & 0xff);
        }

        Channel red() const
        {
            return static_cast<Channel>((rep >> 16) & 0xff);
        }

        Channel green() const
        {
            return static_cast<Channel>((rep >> 8) & 0xff);
        }

        Channel blue() const
        {
            return static_cast<Channel>(rep & 0xff);
        }

        void setAlpha(Channel value)
        {
            rep &= 0x00ffffff;
            rep |= value << 24;
        }

        void setRed(Channel value)
        {
            rep &= 0xff00ffff;
            rep |= value << 16;
        }

        void setGreen(Channel value)
        {
            rep &= 0xffff00ff;
            rep |= value << 8;
        }

        void setBlue(Channel value)
        {
            rep &= 0xffffff00;
            rep |= value;
        }

        double hue() const;
        
        void setHue(double h);
        
        double saturation() const;
        
        void setSaturation(double s);
        
        double value() const;
        
        void setValue(double v);

        boost::uint32_t argb() const
        {
            return rep;
        }

        boost::uint32_t bgr() const
        {
            return red() | (rep & 0x0000ff00) | blue() << 16;
        }

        boost::uint32_t abgr() const
        {
            return alpha() << 24 | bgr();
        }
    };
    
    // Causes weird errors when included in the SWIG wrapping process.
    // If, with a future version of SWIG, this can be included and
    // require 'gosu'; include Gosu
    // works from within Ruby, the #ifndef guard can be removed.
    #ifndef SWIG
    inline bool operator==(Color a, Color b)
    {
        return a.argb() == b.argb();
    }

    inline bool operator!=(Color a, Color b)
    {
        return a.argb() != b.argb();
    }
    #endif

    Color interpolate(Color a, Color b, double weight = 0.5);
    
    Color multiply(Color a, Color b);

    namespace Colors
    {
        const Color none    = 0x00000000;
        const Color black   = 0xff000000;
        const Color gray    = 0xff808080;
        const Color white   = 0xffffffff;
        const Color red     = 0xffff0000;
        const Color green   = 0xff00ff00;
        const Color blue    = 0xff0000ff;
        const Color yellow  = 0xffffff00;
        const Color fuchsia = 0xffff00ff;
        const Color cyan    = 0xff00ffff;
    }
}

#endif

Documentation not clear enough? Please go to one of the places listed on http://www.libgosu.org/ and leave feedback. Thanks!