color.hpp

Go to the documentation of this file.

#pragma once

#include <format>
#include <sstream>

#include <Maths/easing.hpp>
#include <Maths/vector3.hpp>
#include <Maths/vector4.hpp>

#include "Mountain/core.hpp"

// Undef windows min and max macros in case they were defined
#undef min
#undef max


namespace Mountain
{
    struct ColorHsva;

    struct MOUNTAIN_API Color
    {
        // Constants taken from https://github.com/MonoGame/MonoGame/blob/develop/MonoGame.Framework/Color.cs

        static constexpr Color Transparent();

        static constexpr Color AliceBlue();

        static constexpr Color AntiqueWhite();

        static constexpr Color Aqua();

        static constexpr Color Aquamarine();

        static constexpr Color Azure();

        static constexpr Color Beige();

        static constexpr Color Bisque();

        static constexpr Color Black();

        static constexpr Color BlanchedAlmond();

        static constexpr Color Blue();

        static constexpr Color BlueViolet();

        static constexpr Color Brown();

        static constexpr Color BurlyWood();

        static constexpr Color CadetBlue();

        static constexpr Color Chartreuse();

        static constexpr Color Chocolate();

        static constexpr Color Coral();

        static constexpr Color CornflowerBlue();

        static constexpr Color Cornsilk();

        static constexpr Color Crimson();

        static constexpr Color Cyan();

        static constexpr Color DarkBlue();

        static constexpr Color DarkCyan();

        static constexpr Color DarkGoldenrod();

        static constexpr Color DarkGray();

        static constexpr Color DarkGreen();

        static constexpr Color DarkKhaki();

        static constexpr Color DarkMagenta();

        static constexpr Color DarkOliveGreen();

        static constexpr Color DarkOrange();

        static constexpr Color DarkOrchid();

        static constexpr Color DarkRed();

        static constexpr Color DarkSalmon();

        static constexpr Color DarkSeaGreen();

        static constexpr Color DarkSlateBlue();

        static constexpr Color DarkSlateGray();

        static constexpr Color DarkTurquoise();

        static constexpr Color DarkViolet();

        static constexpr Color DeepPink();

        static constexpr Color DeepSkyBlue();

        static constexpr Color DimGray();

        static constexpr Color DodgerBlue();

        static constexpr Color Firebrick();

        static constexpr Color FloralWhite();

        static constexpr Color ForestGreen();

        static constexpr Color Fuchsia();

        static constexpr Color Gainsboro();

        static constexpr Color GhostWhite();

        static constexpr Color Gold();

        static constexpr Color Goldenrod();

        static constexpr Color Gray();

        static constexpr Color Green();

        static constexpr Color GreenYellow();

        static constexpr Color Honeydew();

        static constexpr Color HotPink();

        static constexpr Color IndianRed();

        static constexpr Color Indigo();

        static constexpr Color Ivory();

        static constexpr Color Khaki();

        static constexpr Color Lavender();

        static constexpr Color LavenderBlush();

        static constexpr Color LawnGreen();

        static constexpr Color LemonChiffon();

        static constexpr Color LightBlue();

        static constexpr Color LightCoral();

        static constexpr Color LightCyan();

        static constexpr Color LightGoldenrodYellow();

        static constexpr Color LightGray();

        static constexpr Color LightGreen();

        static constexpr Color LightPink();

        static constexpr Color LightSalmon();

        static constexpr Color LightSeaGreen();

        static constexpr Color LightSkyBlue();

        static constexpr Color LightSlateGray();

        static constexpr Color LightSteelBlue();

        static constexpr Color LightYellow();

        static constexpr Color Lime();

        static constexpr Color LimeGreen();

        static constexpr Color Linen();

        static constexpr Color Magenta();

        static constexpr Color Maroon();

        static constexpr Color MediumAquamarine();

        static constexpr Color MediumBlue();

        static constexpr Color MediumOrchid();

        static constexpr Color MediumPurple();

        static constexpr Color MediumSeaGreen();

        static constexpr Color MediumSlateBlue();

        static constexpr Color MediumSpringGreen();

        static constexpr Color MediumTurquoise();

        static constexpr Color MediumVioletRed();

        static constexpr Color MidnightBlue();

        static constexpr Color MintCream();

        static constexpr Color MistyRose();

        static constexpr Color Moccasin();

        static constexpr Color MonoGameOrange();

        static constexpr Color NavajoWhite();

        static constexpr Color Navy();

        static constexpr Color OldLace();

        static constexpr Color Olive();

        static constexpr Color OliveDrab();

        static constexpr Color Orange();

        static constexpr Color OrangeRed();

        static constexpr Color Orchid();

        static constexpr Color PaleGoldenrod();

        static constexpr Color PaleGreen();

        static constexpr Color PaleTurquoise();

        static constexpr Color PaleVioletRed();

        static constexpr Color PapayaWhip();

        static constexpr Color PeachPuff();

        static constexpr Color Peru();

        static constexpr Color Pink();

        static constexpr Color Plum();

        static constexpr Color PowderBlue();

        static constexpr Color Purple();

        static constexpr Color Red();

        static constexpr Color RosyBrown();

        static constexpr Color RoyalBlue();

        static constexpr Color SaddleBrown();

        static constexpr Color Salmon();

        static constexpr Color SandyBrown();

        static constexpr Color SeaGreen();

        static constexpr Color SeaShell();

        static constexpr Color Sienna();

        static constexpr Color Silver();

        static constexpr Color SkyBlue();

        static constexpr Color SlateBlue();

        static constexpr Color SlateGray();

        static constexpr Color Snow();

        static constexpr Color SpringGreen();

        static constexpr Color SteelBlue();

        static constexpr Color Tan();

        static constexpr Color Teal();

        static constexpr Color Thistle();

        static constexpr Color Tomato();

        static constexpr Color Turquoise();

        static constexpr Color Violet();

        static constexpr Color Wheat();

        static constexpr Color White();

        static constexpr Color WhiteSmoke();

        static constexpr Color Yellow();

        static constexpr Color YellowGreen();

        float_t r = 0.f;
        float_t g = 0.f;
        float_t b = 0.f;
        float_t a = 1.f;

        [[nodiscard]]
        Color() = default;

        [[nodiscard]]
        explicit constexpr Color(const float_t rgb, const float_t a = 1.f);

        [[nodiscard]]
        constexpr Color(const float_t r, const float_t g, const float_t b, const float_t a = 1.f);

        [[nodiscard]]
        explicit constexpr Color(const Vector3& rgb, const float_t a = 1.f);

        [[nodiscard]]
        explicit constexpr Color(const Vector4& rgba);

        [[nodiscard]]
        explicit constexpr Color(const float* data);

        [[nodiscard]]
        uint32_t GetPackedValue() const;

        [[nodiscard]]
        constexpr float_t* Data();

        [[nodiscard]]
        constexpr const float_t* Data() const;

        [[nodiscard]]
        constexpr explicit operator ColorHsva() const;

        [[nodiscard]]
        constexpr explicit operator Vector3() const;

        [[nodiscard]]
        constexpr explicit operator Vector4() const;
    };

    struct MOUNTAIN_API ColorHsva
    {
        [[nodiscard]]
        static constexpr ColorHsva White();

        [[nodiscard]]
        static constexpr ColorHsva Gray();

        [[nodiscard]]
        static constexpr ColorHsva Black();

        [[nodiscard]]
        static constexpr ColorHsva Red();

        [[nodiscard]]
        static constexpr ColorHsva Green();

        [[nodiscard]]
        static constexpr ColorHsva Blue();

        [[nodiscard]]
        static constexpr ColorHsva Yellow();

        [[nodiscard]]
        static constexpr ColorHsva LightBlue();

        [[nodiscard]]
        static constexpr ColorHsva Magenta();

        float_t h = 0;
        float_t s = 0;
        float_t v = 0;
        float_t a = 1.f;

        ColorHsva() = default;

        [[nodiscard]]
        constexpr ColorHsva(const float_t h, const float_t s, const float_t v, const float_t a = 1.f);

        [[nodiscard]]
        constexpr explicit operator Color() const;

        [[nodiscard]]
        constexpr explicit operator Vector3() const;

        [[nodiscard]]
        constexpr explicit operator Vector4() const;
    };

    [[nodiscard]]
    constexpr Color operator+(const Color& c1, const Color& c2);

    [[nodiscard]]
    constexpr Color operator*(const Color& c1, const Color& c2);

    [[nodiscard]]
    constexpr Color operator*(Color color, float_t alphaFactor);

    [[nodiscard]]
    constexpr bool_t operator==(const Color& c1, const Color& c2);

    [[nodiscard]]
    constexpr bool_t operator!=(const Color& c1, const Color& c2);

    [[nodiscard]]
    constexpr ColorHsva operator*(const ColorHsva& color, float_t alphaFactor);

    [[nodiscard]]
    constexpr bool_t operator==(const ColorHsva& c1, const ColorHsva& c2);

    [[nodiscard]]
    constexpr bool_t operator!=(const ColorHsva& c1, const ColorHsva& c2);
}

template <>
struct std::formatter<Mountain::Color>
{
    template <class ParseContext>
    constexpr typename ParseContext::iterator parse(ParseContext& ctx)
    {
        auto it = ctx.begin();
        if (it == ctx.end())
            return it;
 
        if (*it != '}')
            throw std::format_error("Invalid format args for Color");
 
        return it;
    }

    template <class FmtContext>
    typename FmtContext::iterator format(Mountain::Color c, FmtContext& ctx) const
    {
        std::ostringstream out;

        out << std::vformat("{:" + m_Format + "} ; {:" + m_Format + "} ; {:" + m_Format + "} ; {:" + m_Format + '}', std::make_format_args(c.r, c.g, c.b, c.a));

        return std::ranges::copy(std::move(out).str(), ctx.out()).out;
    }

private:
    std::string m_Format;
};

template <>
struct std::formatter<Mountain::ColorHsva>
{
    template <class ParseContext>
    constexpr typename ParseContext::iterator parse(ParseContext& ctx)
    {
        auto it = ctx.begin();
        if (it == ctx.end())
            return it;
 
        if (*it != '}')
            throw std::format_error("Invalid format args for ColorHsva");
 
        return it;
    }

    template <class FmtContext>
    typename FmtContext::iterator format(Mountain::ColorHsva c, FmtContext& ctx) const
    {
        std::ostringstream out;

        out << std::vformat("{:" + m_Format + "} ; {:" + m_Format + "} ; {:" + m_Format + "} ; {:" + m_Format + '}', std::make_format_args(c.h, c.s, c.v, c.a));

        return std::ranges::copy(std::move(out).str(), ctx.out()).out;
    }

private:
    std::string m_Format;
};

namespace Calc
{
    [[nodiscard]]
    Mountain::Color Lerp(const Mountain::Color& value, const Mountain::Color& target, float_t time);

    [[nodiscard]]
    Mountain::Color Lerp(const Mountain::Color& value, const Mountain::Color& target, float_t time, Easing::Easer easer);
}

#include "Mountain/utils/color.inl"