index_pixel.hpp

Go to the documentation of this file.

#pragma once
 
// ReSharper disable once CppUnusedIncludeDirective
#include <compare>
 
namespace porytiles {
 
class IndexPixel {
  public:
    IndexPixel() : index_{0} {}
 
    // NOLINTNEXTLINE(google-explicit-constructor)
    IndexPixel(std::size_t index) : index_{index}
    {
        /*
         * No invariant check on `index_ < pal::max_size` here, because in true-color output mode we accept up to 8-bit
         * index pixels. Even though pokeemerald only cares about the lower four bits, the upper four bits encode the
         * pal index, which is what lets us save a non-greyscale png.
         */
    }
 
    bool operator==(const IndexPixel &other) const = default;
 
    auto operator<=>(const IndexPixel &) const = default;
 
    [[nodiscard]] bool is_transparent() const
    {
        return color_index() == 0;
    }
 
    [[nodiscard]] std::size_t index() const
    {
        return index_;
    }
 
    [[nodiscard]] std::size_t color_index() const
    {
        return index_ & 0x0F;
    }
 
    [[nodiscard]] std::size_t palette_index() const
    {
        return index_ >> 4;
    }
 
  private:
    std::size_t index_;
};
 
} // namespace porytiles