color.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2025-2026 Arnis Lektauers
#pragma once
 
#include <string>
#include <vector>
#include <array>
 
namespace visutwin::canvas
{
    struct Color {
        float r;
 
        float g;
 
        float b;
 
        float a;
 
        explicit Color(const float r = 0.0f, const float g = 0.0f, const float b = 0.0f, const float a = 1.0f) : r(r), g(g), b(b), a(a) {}

        explicit Color(const std::vector<float>& arr);

        Color(const float* arr, size_t size);

        Color(const Color& other) = default;
 
        Color& operator=(const Color& other) = default;

        [[nodiscard]] Color clone() const;

        Color& copy(const Color& rhs);

        [[nodiscard]] bool equals(const Color& rhs) const;

        Color& set(float r, float g, float b, float a = 1.0f);

        Color& lerp(const Color& lhs, const Color& rhs, float alpha);

        Color& linear(const Color* src = nullptr);

        Color& gamma(const Color* src = nullptr);

        Color& mulScalar(float scalar);

        Color& fromString(const std::string& hex);

        Color& fromArray(const std::vector<float>& arr, size_t offset = 0);

        Color& fromArray(const float* arr, size_t size, size_t offset = 0);

        [[nodiscard]] std::string toString(bool alpha = false, bool asArray = false) const;

        [[nodiscard]] std::vector<float> toArray(std::vector<float> arr = {}, size_t offset = 0, bool alpha = true) const;

        void toArray(float* arr, size_t size, size_t offset = 0, bool alpha = true) const;
 
        bool operator==(const Color& other) const;
        bool operator!=(const Color& other) const;
 
        static const Color BLACK;
        static const Color BLUE;
        static const Color CYAN;
        static const Color GRAY;
        static const Color GREEN;
        static const Color MAGENTA;
        static const Color RED;
        static const Color WHITE;
        static const Color YELLOW;
 
    private:
        static std::array<uint8_t, 3> intToBytes24(uint32_t i);

        static std::array<uint8_t, 4> intToBytes32(uint32_t i);

        static float clamp(float value, float min, float max);
    };
}