image2d.hpp

// SPDX-License-Identifier: MIT
#ifndef LIBSBX_GRAPHICS_IMAGES_IMAGE2D_HPP_
#define LIBSBX_GRAPHICS_IMAGES_IMAGE2D_HPP_
 
#include <filesystem>
 
#include <libsbx/utility/crc32.hpp>
#include <libsbx/utility/enum.hpp>
 
#include <libsbx/memory/observer_ptr.hpp>
 
#include <libsbx/reflection/description.hpp>
 
#include <libsbx/math/vector2.hpp>
 
#include <libsbx/graphics/resource_storage.hpp>
 
#include <libsbx/graphics/images/image.hpp>
 
namespace sbx::graphics {
 
enum class format : std::int32_t {
  undefined = VK_FORMAT_UNDEFINED,
  r8_unorm = VK_FORMAT_R8_UNORM,
  r16_sfloat = VK_FORMAT_R16_SFLOAT,
  r32_sfloat = VK_FORMAT_R32_SFLOAT,
  r32_uint = VK_FORMAT_R32_UINT,
  r64_uint = VK_FORMAT_R64_UINT,
  r16g16_sfloat = VK_FORMAT_R16G16_SFLOAT,
  r32g32_sfloat = VK_FORMAT_R32G32_SFLOAT,
  r32g32_uint = VK_FORMAT_R32G32_UINT,
  r8g8b8a8_unorm = VK_FORMAT_R8G8B8A8_UNORM,
  r8g8b8a8_srgb = VK_FORMAT_R8G8B8A8_SRGB,
  b8g8r8a8_srgb = VK_FORMAT_B8G8R8A8_SRGB,
  a2b10g10r10_unorm_pack32 = VK_FORMAT_A2B10G10R10_UNORM_PACK32,
  r16g16b16a16_sfloat = VK_FORMAT_R16G16B16A16_SFLOAT,
  r32g32b32a32_sfloat = VK_FORMAT_R32G32B32A32_SFLOAT
}; // enum class format
 
enum class address_mode : std::int32_t {
  repeat = VK_SAMPLER_ADDRESS_MODE_REPEAT,
  mirror = VK_SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT,
  clamp_to_edge = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE,
  clamp_to_border = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER
}; // enum class address_mode
 
enum class filter : std::int32_t {
  nearest = VK_SAMPLER_MIPMAP_MODE_NEAREST,
  linear = VK_SAMPLER_MIPMAP_MODE_LINEAR
}; // enum class filter
 
class image2d : public image {
 
public:
 
  image2d(const math::vector2u& extent, graphics::format format = graphics::format::r8g8b8a8_unorm, graphics::filter filter = graphics::filter::linear, graphics::address_mode address_mode = graphics::address_mode::repeat, VkImageUsageFlags usage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_STORAGE_BIT, VkSampleCountFlagBits samples = VK_SAMPLE_COUNT_1_BIT, bool anisotropic = false, bool mipmap = false, std::uint32_t array_layers = 1u);
 
  image2d(const std::filesystem::path& path, graphics::format format = graphics::format::r8g8b8a8_srgb, graphics::filter filter = graphics::filter::linear, graphics::address_mode address_mode = graphics::address_mode::repeat, bool anisotropic = false, bool mipmap = false);
 
  image2d(const math::vector2u& extent, graphics::format format, graphics::filter filter, memory::observer_ptr<const std::uint8_t> pixels);
 
  ~image2d() override = default;
 
  auto set_pixels(memory::observer_ptr<const std::uint8_t> pixels) -> void;
 
  auto name() const noexcept -> std::string override {
    return "Image 2D";
  }
 
private:
 
  enum class file_flags : std::uint16_t {
    none = 0,
    compressed = utility::bit_v<0>
  }; // enum class file_flags
 
  struct file_header {
    std::uint64_t magic;
    std::uint16_t version;
    std::uint16_t flags;
    std::uint32_t width;
    std::uint32_t height;
    std::uint32_t channels;
    std::uint32_t uncompressed_size;
    std::uint32_t compressed_size;
  }; // struct file_header
 
  static_assert(sizeof(file_header) == 32u, "file_header layout changed");
 
  static constexpr auto file_magic = utility::make_magic<std::uint64_t>("SBXTEXTR");
  static constexpr auto file_version = std::uint16_t{1u};
  static constexpr auto binary_file_extension = std::string_view{".sbxtex"};
 
  auto _upload_pixels(const std::uint8_t* pixels, std::size_t size) -> void;
 
  auto _load(const std::filesystem::path& path = {}) -> void;
 
  auto _load_binary(const std::filesystem::path& path) -> void;
 
  static auto _process(const std::filesystem::path& path, std::uint32_t width, std::uint32_t height, std::uint32_t channels, const std::uint8_t* pixels) -> void;
 
  bool _anisotropic;
  bool _mipmap;
  std::uint8_t _channels;
 
}; // class image2d
 
using image2d_handle = resource_handle<image2d>;
 
} // namespace sbx::graphics
 
template<>
struct sbx::reflection::description<sbx::graphics::format> {
 
  static constexpr auto name() -> std::string_view {
    return "format";
  }
 
  static constexpr auto enumerators() {
    return std::make_tuple(
      enumerator{"undefined", sbx::graphics::format::undefined},
      enumerator{"r8_unorm", sbx::graphics::format::r8_unorm},
      enumerator{"r16_sfloat", sbx::graphics::format::r16_sfloat},
      enumerator{"r32_sfloat", sbx::graphics::format::r32_sfloat},
      enumerator{"r32_uint", sbx::graphics::format::r32_uint},
      enumerator{"r64_uint", sbx::graphics::format::r64_uint},
      enumerator{"r16g16_sfloat", sbx::graphics::format::r16g16_sfloat},
      enumerator{"r32g32_sfloat", sbx::graphics::format::r32g32_sfloat},
      enumerator{"r32g32_uint", sbx::graphics::format::r32g32_uint},
      enumerator{"r8g8b8a8_unorm", sbx::graphics::format::r8g8b8a8_unorm},
      enumerator{"r8g8b8a8_srgb", sbx::graphics::format::r8g8b8a8_srgb},
      enumerator{"b8g8r8a8_srgb", sbx::graphics::format::b8g8r8a8_srgb},
      enumerator{"a2b10g10r10_unorm_pack32", sbx::graphics::format::a2b10g10r10_unorm_pack32},
      enumerator{"r16g16b16a16_sfloat", sbx::graphics::format::r16g16b16a16_sfloat},
      enumerator{"r32g32b32a32_sfloat", sbx::graphics::format::r32g32b32a32_sfloat}
    );
  }
 
}; // struct sbx::reflection::description<sbx::graphics::format>
 
#endif // LIBSBX_GRAPHICS_IMAGES_IMAGE2D_HPP_