VulkanStagedBuffer.h

Go to the documentation of this file.

#pragma once
#include "Buffer.h"
#include "Engine/Core/VulkanHelper.h"
 
#include <array>
#include <optional>
#include <vector>
 
namespace Engine::Core
{
    class ApplicationContext;
}  // namespace Engine::Core
 
namespace Vulkan {
    struct StagedBufferSyncObjects {
        VkBufferMemoryBarrier2 releaseBarrier;

        VkBufferMemoryBarrier2 acquireBarrier;

        BufferCopyObject copyObject;
    };

    class StagedBuffer {
    public:
        static constexpr uint32_t STAGING_BUFFER_COUNT = 2;
 
        StagedBuffer();

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

        StagedBufferSyncObjects uploadPartial( const Engine::Core::ApplicationContext *context, const void *data, VkDeviceSize size, VkDeviceSize offset);

        void advanceStagingBuffer() { currentStagingIndex_ = (currentStagingIndex_ + 1) % STAGING_BUFFER_COUNT; }

        bool ensureSize(VkDeviceSize requiredSize, VkBufferUsageFlags usage);

        void processPendingDeletions();

        [[nodiscard]] bool hasPendingDeletions() const { return !pendingDeletions.empty(); }
 
        [[nodiscard]] const Vulkan::Buffer& getBuffer() const { return buffer.value(); }
        [[nodiscard]] Vulkan::Buffer& getBufferRef() { return buffer.value(); }
        [[nodiscard]] const Vulkan::Buffer& getStagingBuffer() const { return stagingBuffers_[currentStagingIndex_].value(); }
        [[nodiscard]] Vulkan::Buffer& getStagingBufferRef() { return stagingBuffers_[currentStagingIndex_].value(); }

        [[nodiscard]] VkDeviceSize getSize() const;
 
        void setDebugName(const std::string &name, std::optional<uint32_t> index = std::nullopt);
 
    private:
        Engine::Core::ApplicationContext * context_ = nullptr;
        std::optional<Buffer> buffer;
        std::array<std::optional<Vulkan::Buffer>, STAGING_BUFFER_COUNT> stagingBuffers_;
        uint32_t currentStagingIndex_ = 0;
        std::string debugName_;
        bool usePersistentMapping_ = false;

        struct PendingDeletion {
            Vulkan::Buffer deviceBuffer;
            std::array<Vulkan::Buffer, STAGING_BUFFER_COUNT> stagingBuffers;
            uint32_t framesRemaining = 0;  
        };
        std::vector<PendingDeletion> pendingDeletions;

        static constexpr uint32_t DELETION_DELAY_FRAMES = 6;
    };
}