VulkanStagedBuffer.h

Go to the documentation of this file.

#pragma once
#include <optional>
#include <vector>
#include "VulkanBuffer.h"
#include "Engine/Core/VulkanHelper.h"
 
namespace EngineCore {
    struct VulkanStagedBufferSyncObjects {
        VkBufferMemoryBarrier2 releaseBarrier;
        VkBufferMemoryBarrier2 acquireBarrier;
        BufferCopyObject copyObject;
    };
 
    class VulkanStagedBuffer {
    public:
        VulkanStagedBuffer();

        void create(ApplicationContext *context, VkDeviceSize size, VkBufferUsageFlags usage, bool persistentMapping = false);
        void destroy();
 
        VulkanStagedBufferSyncObjects upload(const ApplicationContext *context, const void *data, VkDeviceSize size);

        VulkanStagedBufferSyncObjects uploadPartial(const ApplicationContext *context, const void *data, VkDeviceSize size, VkDeviceSize offset);

        bool ensureSize(VkDeviceSize requiredSize, VkBufferUsageFlags usage);

        void processPendingDeletions();

        [[nodiscard]] bool hasPendingDeletions() const { return !pendingDeletions.empty(); }
 
        [[nodiscard]] const VulkanBuffer& getBuffer() const { return buffer.value(); }
        [[nodiscard]] VulkanBuffer& getBufferRef() { return buffer.value(); }
        [[nodiscard]] const VulkanBuffer& getStagingBuffer() const { return stagingBuffer.value(); }
        [[nodiscard]] VulkanBuffer& getStagingBufferRef() { return stagingBuffer.value(); }

        [[nodiscard]] VkDeviceSize getSize() const;
 
        void setDebugName(const std::string &name, std::optional<uint32_t> index = std::nullopt);
 
    private:
        ApplicationContext* context_ = nullptr;
        std::optional<VulkanBuffer> buffer;
        std::optional<VulkanBuffer> stagingBuffer;
        std::string debugName_;
        bool usePersistentMapping_ = false;

        struct PendingDeletion {
            VulkanBuffer deviceBuffer;
            VulkanBuffer stagingBuffer;
            uint32_t framesRemaining = 0;  
        };
        std::vector<PendingDeletion> pendingDeletions;

        static constexpr uint32_t DELETION_DELAY_FRAMES = 6;
    };
}