Color.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 Bruno Van de Velde (vdv_b@tgui.eu)
//
// 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.
//
 
#ifndef TGUI_COLOR_HPP
#define TGUI_COLOR_HPP
 
#include <TGUI/String.hpp>
#include <TGUI/Vertex.hpp>
 
#include <cstdint>
#include <string>
#include <map>
 
#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !TGUI_DISABLE_SFML_CONVERSIONS
    #include <SFML/Graphics/Color.hpp>
#endif

 
namespace tgui
{
    class Color;
}
 
namespace tgui
{
    namespace priv
    {
        TGUI_API Color constructColorFromString(const String& string);
    }
}
 
namespace tgui
{
#if defined(TGUI_SYSTEM_WINDOWS) && TGUI_COMPILED_WITH_CPP_VER >= 17
    // dllimport doesn't work for the static members when they are defined as inline constexpr outside the class,
    // so we aren't allowed to put TGUI_API here on Windows.
    class Color
#else
    class TGUI_API Color
#endif
    {
    public:

        TGUI_NODISCARD static constexpr Color applyOpacity(const Color& color, float alpha)
        {
            return {color.getRed(), color.getGreen(), color.getBlue(), static_cast<std::uint8_t>(color.getAlpha() * alpha)};
        }
 
    public:

        constexpr Color() :
            m_isSet{false},
            m_red  {0},
            m_green{0},
            m_blue {0},
            m_alpha{0}
        {
        }
 
#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !TGUI_DISABLE_SFML_CONVERSIONS
        constexpr Color(const sf::Color& color) :
            m_isSet{true},
            m_red  {color.r},
            m_green{color.g},
            m_blue {color.b},
            m_alpha{color.a}
        {
        }
#endif

        constexpr Color(std::uint8_t red, std::uint8_t green, std::uint8_t blue, std::uint8_t alpha = 255) :
            m_isSet{true},
            m_red  {red},
            m_green{green},
            m_blue {blue},
            m_alpha{alpha}
        {
        }
 
#if defined (_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable: 26495) // Ignore "Variable is uninitialized" warning to surpress incorrect code analysis
#endif
        Color(const String& string) :
            Color{priv::constructColorFromString(string)}
        {
        }
#if defined (_MSC_VER)
#   pragma warning(pop)
#endif

        Color(const char* string) :
            Color{String{string}}
        {
        }

        TGUI_NODISCARD constexpr bool isSet() const
        {
            return m_isSet;
        }
 
#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !TGUI_DISABLE_SFML_CONVERSIONS
        operator sf::Color() const
        {
            return {m_red, m_green, m_blue, m_alpha};
        }
#endif

        explicit operator Vertex::Color() const
        {
            return Vertex::Color{m_red, m_green, m_blue, m_alpha};
        }

        TGUI_NODISCARD constexpr std::uint8_t getRed() const
        {
            return m_red;
        }

        TGUI_NODISCARD constexpr std::uint8_t getGreen() const
        {
            return m_green;
        }

        TGUI_NODISCARD constexpr std::uint8_t getBlue() const
        {
            return m_blue;
        }

        TGUI_NODISCARD constexpr std::uint8_t getAlpha() const
        {
            return m_alpha;
        }

        TGUI_NODISCARD constexpr bool operator==(const Color& rhs) const
        {
            return (m_isSet == rhs.m_isSet)
                && (m_red == rhs.m_red)
                && (m_green == rhs.m_green)
                && (m_blue == rhs.m_blue)
                && (m_alpha == rhs.m_alpha);
        }

        TGUI_NODISCARD constexpr bool operator!=(const Color& right) const
        {
            return !(*this == right);
        }

    public:
 
        static const Color Black;       
        static const Color White;       
        static const Color Red;         
        static const Color Green;       
        static const Color Blue;        
        static const Color Yellow;      
        static const Color Magenta;     
        static const Color Cyan;        
        static const Color Transparent; 
 
        static const std::array<std::pair<StringView, Color>, 9> colorNamesMap;

    private:
 
        bool m_isSet = false;
        std::uint8_t m_red = 0;
        std::uint8_t m_green = 0;
        std::uint8_t m_blue = 0;
        std::uint8_t m_alpha = 0;
    };

 
#if TGUI_COMPILED_WITH_CPP_VER >= 17
    inline constexpr const Color Color::Black      {  0,   0,   0};
    inline constexpr const Color Color::White      {255, 255, 255};
    inline constexpr const Color Color::Red        {255,   0,   0};
    inline constexpr const Color Color::Green      {  0, 255,   0};
    inline constexpr const Color Color::Blue       {  0,   0, 255};
    inline constexpr const Color Color::Yellow     {255, 255,   0};
    inline constexpr const Color Color::Magenta    {255,   0, 255};
    inline constexpr const Color Color::Cyan       {  0, 255, 255};
    inline constexpr const Color Color::Transparent{  0,   0,   0,   0};
 
    inline constexpr const std::array<std::pair<StringView, Color>, 9> Color::colorNamesMap
    {
        {{U"black"sv, Color::Black},
         {U"white"sv, Color::White},
         {U"red"sv, Color::Red},
         {U"yellow"sv, Color::Yellow},
         {U"green"sv, Color::Green},
         {U"cyan"sv, Color::Cyan},
         {U"blue"sv, Color::Blue},
         {U"magenta"sv, Color::Magenta},
         {U"transparent"sv, Color::Transparent}}
    };
#endif
}

 
namespace tgui
{
    namespace priv
    {
        TGUI_NODISCARD TGUI_API Color constructColorFromString(const String& string);
    }
}

 
#endif // TGUI_COLOR_HPP