josiest / colorful

A header-only library for loading simple color objects from a file of color definitions

Colorful

A simple header-only library for loading simple color objects

Example Usage

With colorful, you can build simple color structs from hex-encoded integer values, and as a map of name-color pairs from a yaml file.

// basic.cpp
#include <colorful/colorful.hpp>

// data types
#include <cstdint>

// i/o
#include <iostream>
#include <iomanip>
#include <filesystem>

// aliases
namespace cf = colorful;
namespace fs = std::filesystem;

// a simple color struct, and how to print it
struct color { int r, g, b, a; };
namespace std {
ostream & operator<<(ostream & os, color const & c)
{
    os << hex << "{" << c.r << ", " << c.g << ", "
                     << c.b << ", " << c.a << "}";
    return os;
}
}

int main()
{
    // demonstrate parsing a color from an integer
    auto white = cf::color_from_hex<color>(0xffffff);
    std::cout << "white: " << white << std::endl;

    // demonstrate loading from a path
    fs::path const color_path = fs::absolute("../colors.yaml");
    auto colors = cf::load_table<color>(color_path);

    // load_table returns a tl::expected - so we'll need to check
    // that the color table loaded correctly before dereferencing
    if (not colors) {
        std::cout << "unable to load colors: "
                  << colors.error() << std::endl;
        return EXIT_FAILURE;
    }

    for (auto const &[name, color] : *colors) {
        std::cout << name << ": " << color << std::endl;
    }
    return EXIT_SUCCESS;
}

# colors.yaml
light-blue: 0x66ccff
rose: 0xff6666
lavender: 0x9999ff

Installing

Colorful is just a single header file, so insstalling it is as simple as copying colorful.hpp into your project. Alternatively you can also install it via cmake.