color_index.hpp

Go to the documentation of this file.

#pragma once
 
// ReSharper disable once CppUnusedIncludeDirective
#include <compare>
#include <cstddef>
#include <string>
 
#include "porytiles2/xcut/panic/panic.hpp"
 
namespace porytiles2 {
 
inline constexpr std::size_t colors_per_pal = 16;
inline constexpr std::size_t num_pals = 16;
inline constexpr std::size_t num_colors = colors_per_pal * num_pals;
 
class ColorIndex {
  public:
    // NOLINTNEXTLINE(google-explicit-constructor)
    ColorIndex(unsigned int index) : index_{index}
    {
        // TODO: do we want validation here?
        // I think not, since ideally we should allow ColorIndexMap to grow to arbitrary size.
        // The domain compiler service can then check the size and throw based on exogenous config params.
        // if (index_ >= num_colors) {
        //     panic("invalid ColorIndex value: " + std::to_string(index_));
        // }
    }
 
    auto operator<=>(const ColorIndex &) const = default;
 
    [[nodiscard]] unsigned int index() const
    {
        return index_;
    }
 
  private:
    unsigned int index_{};
};
 
} // namespace porytiles2