foray_imagelayoutcache.hpp

Go to the documentation of this file.

#pragma once
#include "../foray_vulkan.hpp"
#include "foray_core_declares.hpp"
#include <unordered_map>
 
namespace foray::core {
    class ImageLayoutCache
    {
      public:
        VkImageLayout Get(VkImage image) const;
        VkImageLayout Get(const ManagedImage& image) const;
        VkImageLayout Get(const ManagedImage* image) const;
 
        void Set(VkImage image, VkImageLayout layout);
        void Set(const ManagedImage& image, VkImageLayout layout);
        void Set(const ManagedImage* image, VkImageLayout layout);
 
        struct Barrier
        {
            VkAccessFlags           SrcAccessMask       = VkAccessFlagBits::VK_ACCESS_NONE;
            VkAccessFlags           DstAccessMask       = VkAccessFlagBits::VK_ACCESS_NONE;
            uint32_t                SrcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
            uint32_t                DstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
            VkImageLayout           NewLayout;
            VkImageSubresourceRange SubresourceRange = VkImageSubresourceRange{.aspectMask = VkImageAspectFlagBits::VK_IMAGE_ASPECT_COLOR_BIT, .levelCount = 1U, .layerCount = 1U};
        };
 
        struct Barrier2
        {
            VkPipelineStageFlags2   SrcStageMask        = VK_PIPELINE_STAGE_2_NONE;
            VkAccessFlags2          SrcAccessMask       = VK_ACCESS_2_NONE;
            VkPipelineStageFlags2   DstStageMask        = VK_PIPELINE_STAGE_2_NONE;
            VkAccessFlags2          DstAccessMask       = VK_ACCESS_2_NONE;
            uint32_t                SrcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
            uint32_t                DstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
            VkImageLayout           NewLayout;
            VkImageSubresourceRange SubresourceRange = VkImageSubresourceRange{.aspectMask = VkImageAspectFlagBits::VK_IMAGE_ASPECT_COLOR_BIT, .levelCount = 1U, .layerCount = 1U};
        };
 
        VkImageMemoryBarrier  MakeBarrier(VkImage image, const Barrier& barrier);
        VkImageMemoryBarrier  MakeBarrier(const ManagedImage* image, const Barrier& barrier);
        VkImageMemoryBarrier  MakeBarrier(const ManagedImage& image, const Barrier& barrier);
        VkImageMemoryBarrier2 MakeBarrier(VkImage image, const Barrier2& barrier);
        VkImageMemoryBarrier2 MakeBarrier(const ManagedImage* image, const Barrier2& barrier);
        VkImageMemoryBarrier2 MakeBarrier(const ManagedImage& image, const Barrier2& barrier);
 
        void CmdBarrier(VkCommandBuffer      cmdBuffer,
                        VkImage              image,
                        const Barrier&       barrier,
                        VkPipelineStageFlags srcStageMask,
                        VkPipelineStageFlags dstStageMask,
                        VkDependencyFlags    depFlags = 0);
        void CmdBarrier(VkCommandBuffer      cmdBuffer,
                        const ManagedImage*  image,
                        const Barrier&       barrier,
                        VkPipelineStageFlags srcStageMask,
                        VkPipelineStageFlags dstStageMask,
                        VkDependencyFlags    depFlags = 0);
        void CmdBarrier(VkCommandBuffer      cmdBuffer,
                        const ManagedImage&  image,
                        const Barrier&       barrier,
                        VkPipelineStageFlags srcStageMask,
                        VkPipelineStageFlags dstStageMask,
                        VkDependencyFlags    depFlags = 0);
        void CmdBarrier(VkCommandBuffer cmdBuffer, VkImage image, const Barrier2& barrier, VkDependencyFlags depFlags = 0);
        void CmdBarrier(VkCommandBuffer cmdBuffer, const ManagedImage* image, const Barrier2& barrier, VkDependencyFlags depFlags = 0);
        void CmdBarrier(VkCommandBuffer cmdBuffer, const ManagedImage& image, const Barrier2& barrier, VkDependencyFlags depFlags = 0);
 
      protected:
        std::unordered_map<VkImage, VkImageLayout> mLayoutCache;
    };
}  // namespace foray::core