Colour.hpp

Go to the documentation of this file.

 
 
#ifndef GALAXY_GRAPHICS_COLOUR_HPP_
#define GALAXY_GRAPHICS_COLOUR_HPP_
 
#include <array>
 
#include <glm/vec4.hpp>
 
#undef OPAQUE
#undef TRANSPARENT
 
namespace galaxy
{
    class Colour final
    {
    public:
        inline static const constexpr std::uint8_t OPAQUE = 255;
 
        inline static const constexpr std::uint8_t TRANSPARENT = 0;
 
        inline static const constexpr std::uint8_t OFFSET = 0xFF;
 
        inline static const constexpr std::uint8_t LOWER = 0;
 
        inline static const constexpr std::uint8_t UPPER = 255;
 
    public:
        Colour() noexcept;
 
        Colour(const std::uint8_t r, const std::uint8_t g, const std::uint8_t b, const std::uint8_t a = OPAQUE) noexcept;
 
        Colour(Colour&&) noexcept;
 
        Colour(const Colour&) noexcept;
 
        Colour& operator=(Colour&&) noexcept;
 
        Colour& operator=(const Colour& w) noexcept;
 
        ~Colour() noexcept;
 
        void r(const std::uint8_t r) noexcept;
 
        void g(const std::uint8_t g) noexcept;
 
        void b(const std::uint8_t b) noexcept;
 
        void a(const std::uint8_t a) noexcept;
 
        std::uint8_t r() const noexcept;
 
        std::uint8_t g() const noexcept;
 
        std::uint8_t b() const noexcept;
 
        std::uint8_t a() const noexcept;
 
        void set_from_norm(const glm::vec4& rgba) noexcept;
 
        [[nodiscard]]
        glm::vec4 normalize() noexcept;
 
        [[nodiscard]]
        std::array<std::uint8_t, 4> array() noexcept;
 
        auto operator<=>(const Colour&) const = default;
 
        bool operator==(const Colour&) const = default;
 
        bool operator!=(const Colour&) const = default;
 
        bool operator<(const Colour&) const = default;
 
        bool operator>(const Colour&) const = default;
 
        bool operator<=(const Colour&) const = default;
 
        bool operator>=(const Colour&) const = default;
 
    private:
        std::uint8_t m_red;
 
        std::uint8_t m_green;
 
        std::uint8_t m_blue;
 
        std::uint8_t m_alpha;
    };
} // namespace galaxy
 
#endif