foray_managedimage.hpp

Go to the documentation of this file.

#pragma once
#include "../foray_basics.hpp"
#include "../foray_vulkan.hpp"
#include "foray_commandbuffer.hpp"
#include "foray_context.hpp"
#include "foray_managedresource.hpp"
#include <optional>
 
namespace foray::core {
 
    class ManagedImage : public VulkanResource<VkObjectType::VK_OBJECT_TYPE_IMAGE>
    {
      public:
        inline ManagedImage() : VulkanResource("Unnamed Image") {}
        inline virtual ~ManagedImage() { Destroy(); }
 
        struct CreateInfo
        {
            VkImageCreateInfo ImageCI{};
            bool CreateImageView = true;
            VkImageViewCreateInfo ImageViewCI{};
            VmaAllocationCreateInfo AllocCI{};
            std::string Name{"Unnamed Image"};
 
            CreateInfo();
            CreateInfo(VkImageUsageFlags usage, VkFormat format, const VkExtent2D& extent, std::string_view name = "Unnamed Image");
        };
 
        virtual void Create(Context* context, const CreateInfo& createInfo);
 
        virtual void Resize(const VkExtent3D& newextent);
        virtual void Resize(const VkExtent2D& newextent);
 
        virtual void Create(Context* context, VkImageUsageFlags usage, VkFormat format, const VkExtent2D& extent, std::string_view name = "Unnamed Image");
 
        struct QuickTransition
        {
            VkPipelineStageFlags SrcStageMask{VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT};
            VkAccessFlags        SrcAccessMask{0};
            VkPipelineStageFlags DstStageMask{VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT};
            VkAccessFlags        DstAccessMask{0};
            VkImageLayout        OldLayout{VkImageLayout::VK_IMAGE_LAYOUT_UNDEFINED};
            VkImageLayout        NewLayout{VkImageLayout::VK_IMAGE_LAYOUT_UNDEFINED};
            VkImageAspectFlags   AspectMask{VK_IMAGE_ASPECT_COLOR_BIT};
        };
 
        virtual void TransitionLayout(ManagedImage::QuickTransition& quickTransition, VkCommandBuffer commandBuffer = VK_NULL_HANDLE);
 
        void WriteDeviceLocalData(const void* data, size_t size, VkImageLayout layoutAfterWrite, VkBufferImageCopy& imageCopy);
        void WriteDeviceLocalData(HostSyncCommandBuffer& cmdBuffer, const void* data, size_t size, VkImageLayout layoutAfterWrite, VkBufferImageCopy& imageCopy);
 
        void WriteDeviceLocalData(const void* data, size_t size, VkImageLayout layoutAfterWrite);
        void WriteDeviceLocalData(HostSyncCommandBuffer& cmdBuffer, const void* data, size_t size, VkImageLayout layoutAfterWrite);
 
        virtual void Destroy() override;
        virtual bool Exists() const override { return mAllocation; }
 
        FORAY_GETTER_CR(CreateInfo)
        FORAY_GETTER_V(Image)
        FORAY_GETTER_V(ImageView)
        FORAY_GETTER_V(Allocation)
        FORAY_GETTER_CR(AllocInfo)
        FORAY_GETTER_V(Format)
        FORAY_GETTER_CR(Extent3D)
        inline VkExtent2D GetExtent2D() const { return VkExtent2D{mExtent3D.width, mExtent3D.height}; }
 
        virtual void SetName(std::string_view name) override;
 
        VkSampleCountFlagBits GetSampleCount() const { return mCreateInfo.ImageCI.samples; }
 
      protected:
        Context*          mContext{};
        CreateInfo        mCreateInfo;
        VkImage           mImage{};
        VkImageView       mImageView{};
        VkFormat          mFormat{};
        VmaAllocation     mAllocation{};
        VmaAllocationInfo mAllocInfo{};
        VkDeviceSize      mSize{};
        VkExtent3D        mExtent3D{};
 
        void CheckImageFormatSupport(const CreateInfo& createInfo);
        void UpdateDebugNames();
    };
}  // namespace foray::core