foray_managedbuffer.hpp

Go to the documentation of this file.

#pragma once
#include "../foray_vma.hpp"
#include "../foray_vulkan.hpp"
#include "foray_commandbuffer.hpp"
#include "foray_context.hpp"
#include "foray_managedresource.hpp"
 
namespace foray::core {
 
    class ManagedBuffer : public VulkanResource<VkObjectType::VK_OBJECT_TYPE_BUFFER>
    {
      public:
        struct CreateInfo
        {
            VkBufferCreateInfo BufferCreateInfo{};
            VmaAllocationCreateInfo AllocationCreateInfo{};
            VkDeviceSize Alignment{};
            std::string Name{};
 
            CreateInfo();
            CreateInfo(VkBufferUsageFlags usage, VkDeviceSize size, VmaMemoryUsage memoryUsage, VmaAllocationCreateFlags flags = {}, std::string_view name = "");
        };
 
      public:
        ManagedBuffer() : VulkanResource("Unnamed Buffer"){};
 
        void Create(Context* context, const CreateInfo& createInfo);
        void CreateForStaging(Context* context, VkDeviceSize size, const void* data = nullptr, std::string_view bufferName = {});
        void Create(Context* context, VkBufferUsageFlags usage, VkDeviceSize size, VmaMemoryUsage memoryUsage, VmaAllocationCreateFlags flags = {}, std::string_view name = "");
 
        virtual void Destroy() override;
 
        virtual bool Exists() const override { return !!mAllocation; }
 
        void WriteDataDeviceLocal(const void* data, VkDeviceSize size, VkDeviceSize offset = 0);
        void WriteDataDeviceLocal(HostSyncCommandBuffer& cmdBuffer, const void* data, VkDeviceSize size, VkDeviceSize offset = 0);
 
        void Map(void*& data);
        void Unmap();
 
        void MapAndWrite(const void* data, size_t size = 0);
 
        inline virtual ~ManagedBuffer()
        {
            if(!!mAllocation)
            {
                Destroy();
            }
        }
 
        FORAY_GETTER_V(Buffer);
        FORAY_GETTER_V(IsMapped);
        FORAY_GETTER_V(Allocation);
        FORAY_GETTER_CR(AllocationInfo);
        FORAY_GETTER_V(Name);
        FORAY_GETTER_V(Size);
        FORAY_GETTER_V(Alignment);
 
        VkDeviceAddress GetDeviceAddress() const;
 
        virtual void SetName(std::string_view name) override;
 
        inline VkDescriptorBufferInfo GetVkDescriptorBufferInfo() const { return VkDescriptorBufferInfo{.buffer = mBuffer, .offset = 0, .range = mSize}; }
        void FillVkDescriptorBufferInfo(VkDescriptorBufferInfo& bufferInfo) const;
 
      protected:
        Context*          mContext{};
        VkBuffer          mBuffer{};
        VmaAllocation     mAllocation{};
        VmaAllocationInfo mAllocationInfo{};
        VkDeviceSize      mSize      = {};
        VkDeviceSize      mAlignment = {};
        bool              mIsMapped  = false;
 
        void UpdateDebugNames();
    };
 
}  // namespace foray::core