Image.h

// Copyright (c) 2024 Michael Carlie. All Rights Reserved.
//
// This software is released under the MIT License.
// https://opensource.org/licenses/MIT
 
#ifndef INCLUDE_VULKANENGINE_IMAGE_H_
#define INCLUDE_VULKANENGINE_IMAGE_H_
 
#include <VulkanEngine/ImageBase.h>
#include <VulkanEngine/StagedBufferDestination.h>
 
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wnullability-completeness"
#endif
#include <vk_mem_alloc.h>
#ifdef __clang__
#pragma clang diagnostic pop
#endif
 
namespace VulkanEngine {
 
template <vk::Format format, vk::ImageType image_type, vk::ImageTiling tiling,
          vk::SampleCountFlagBits  // NOLINT(whitespace/indent_namespace)
              sample_count_flags>  // NOLINT(whitespace/indent_namespace)
class Image : public StagedBufferDestination, public ImageBase {
 public:
  Image(vk::ImageLayout initial_layout, vk::ImageUsageFlags usage_flags,
        VmaMemoryUsage vma_memory_usage, uint32_t _width, uint32_t _height,
        uint32_t _depth, size_t pixel_size, bool generate_mip_maps);
 
  virtual ~Image();
 
  void setImageData(const void* data);
 
  void createImageView(vk::ImageViewType image_view_type,
                       vk::ImageAspectFlags image_aspect_flags);
 
  void transitionImageLayout(vk::ImageLayout new_layout,
                             const vk::CommandBuffer& command_buffer = nullptr);
 
  const vk::Format getVkFormat() const;
 
  const vk::SampleCountFlagBits getVkSampleCountFlags() const;
 
  virtual vk::Image getVkImage() const;
 
  virtual vk::ImageView getVkImageView() const;
 
 protected:
  virtual void insertTransferCommand(const vk::CommandBuffer& command_buffer,
                                     const vk::Buffer& source_buffer);
 
  virtual size_t getStagingBufferSize() const;
 
 private:
  void createImage(vk::ImageUsageFlags usage_flags, VmaMemoryUsage vma_usage);
 
  void generateMipmaps(const vk::CommandBuffer& command_buffer);
 
 protected:
  uint32_t width;
 
  uint32_t height;
 
  uint32_t depth;
 
  size_t data_size;
 
  uint32_t mipmap_levels;
 
  vk::ImageLayout vk_image_layout;
 
  vk::Image vk_image;
 
  vk::ImageView vk_image_view;
 
  VkImageCreateInfo image_create_info;
};
 
}  // namespace VulkanEngine
 
#include <Image.cpp>  // NOLINT(build/include)
 
#endif  // INCLUDE_VULKANENGINE_IMAGE_H_