foray_inflightframe.hpp

Go to the documentation of this file.

#pragma once
#include "../core/foray_commandbuffer.hpp"
#include "../core/foray_core_declares.hpp"
#include <vector>
 
namespace foray::base {
 
    enum class ESwapchainInteractResult
    {
        Nominal,
        Resized
    };
 
    using CmdBufferIndex                               = int32_t;
    static const CmdBufferIndex PRIMARY_COMMAND_BUFFER = -1;
 
    class InFlightFrame
    {
      public:
        void Create(core::Context* context, uint32_t auxCommandBufferCount = 0);
        void Destroy();
 
        inline virtual ~InFlightFrame() { Destroy(); }
 
        ESwapchainInteractResult AcquireSwapchainImage();
        ESwapchainInteractResult Present();
 
        void ClearSwapchainImage(VkCommandBuffer cmdBuffer, core::ImageLayoutCache& imgLayoutCache);
        void PrepareSwapchainImageForPresent(VkCommandBuffer cmdBuffer, core::ImageLayoutCache& imgLayoutCache);
 
        bool HasFinishedExecution();
        void WaitForExecutionFinished();
        void ResetFence();
 
        void SubmitAll();
 
        core::DeviceSyncCommandBuffer&       GetAuxiliaryCommandBuffer(uint32_t index);
        core::DeviceSyncCommandBuffer&       GetPrimaryCommandBuffer();
        core::DeviceSyncCommandBuffer&       GetCommandBuffer(CmdBufferIndex index);
        const core::DeviceSyncCommandBuffer& GetAuxiliaryCommandBuffer(uint32_t index) const;
        const core::DeviceSyncCommandBuffer& GetPrimaryCommandBuffer() const;
        const core::DeviceSyncCommandBuffer& GetCommandBuffer(CmdBufferIndex index) const;
 
        FORAY_GETTER_V(SwapchainImageIndex)
        FORAY_GETTER_V(SwapchainImageReady)
        FORAY_GETTER_V(PrimaryCompletedSemaphore)
        FORAY_GETTER_V(PrimaryCompletedFence)
 
      protected:
        core::Context* mContext = nullptr;
 
        std::vector<std::unique_ptr<core::DeviceSyncCommandBuffer>> mAuxiliaryCommandBuffers;
        core::DeviceSyncCommandBuffer                               mPrimaryCommandBuffer;
        VkSemaphore mSwapchainImageReady       = nullptr;
        VkSemaphore mPrimaryCompletedSemaphore = nullptr;
        VkFence     mPrimaryCompletedFence     = nullptr;
 
        uint32_t mSwapchainImageIndex = 0;
    };
}  // namespace foray::base