Merge pull request #18 from CapsCollective/feature/command-buffer

Added Command Buffer wrapper class

Author: Raelr

engine/render/renderer/Renderer.cpp

@@ -15,7 +15,8 @@
 namespace Siege
 {
 Renderer* Renderer::instance {nullptr};
-Utils::MHArray<VkCommandBuffer> Renderer::commandBuffers;
+Vulkan::CommandBuffer Renderer::commandBuffers;
+uint32_t Renderer::currentFrameIndex = 0;
 
 Renderer::Renderer(Window& window) : window {window}
 {
@@ -37,7 +38,7 @@ Renderer::Renderer(Window& window) : window {window}
     Renderer3D::Initialise();
     Renderer2D::Initialise();
 
-    CreateCommandBuffers();
+    commandBuffers = Vulkan::CommandBuffer(Vulkan::Swapchain::MAX_FRAMES_IN_FLIGHT);
 }
 
 Renderer::~Renderer()
@@ -47,25 +48,9 @@ Renderer::~Renderer()
     Renderer3D::DestroyRenderer3D();
 }
 
-void Renderer::CreateCommandBuffers()
-{
-    commandBuffers = Utils::MHArray<VkCommandBuffer>(Vulkan::Swapchain::MAX_FRAMES_IN_FLIGHT);
-
-    VkCommandBufferAllocateInfo allocInfo {};
-    allocInfo.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
-    allocInfo.level = VK_COMMAND_BUFFER_LEVEL_PRIMARY;
-    allocInfo.commandPool = Vulkan::Context::GetCurrentDevice()->GetCommandPool();
-    allocInfo.commandBufferCount = static_cast<uint32_t>(commandBuffers.Size());
-
-    CC_ASSERT(vkAllocateCommandBuffers(Vulkan::Context::GetVkLogicalDevice(),
-                                       &allocInfo,
-                                       OUT commandBuffers.Data()) == VK_SUCCESS,
-              "Failed to allocate command buffer");
-}
-
 void Renderer::DrawFrame()
 {
-    auto commandBuffer = GetCurrentCommandBuffer();
+    auto commandBuffer = commandBuffers.GetActiveCommandBuffer();
 
     Renderer2D::GlobalData global2DData = {projection};
 
@@ -101,7 +86,7 @@ void Renderer::RecreateSwapChain()
 
 bool Renderer::StartFrame()
 {
-    CC_ASSERT(!isFrameStarted, "Can't start a frame when a frame is already in progress!");
+    CC_ASSERT(!isFrameStarted, "Can't start a frame when a frame is already in progress!")
 
     auto& swapchain = context.GetSwapchain();
 
@@ -114,19 +99,13 @@ bool Renderer::StartFrame()
     }
 
     CC_ASSERT(result == Vulkan::Utils::SUCCESS || result == Vulkan::Utils::SUBOPTIMAL,
-              "Failed to acquire swapchain image!");
+              "Failed to acquire swapchain image!")
 
     isFrameStarted = true;
 
-    VkCommandBuffer commandBuffer = GetCurrentCommandBuffer();
-
-    VkCommandBufferBeginInfo beginInfo {};
-    beginInfo.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO;
-
-    CC_ASSERT(vkBeginCommandBuffer(OUT commandBuffer, &beginInfo) == VK_SUCCESS,
-              "Failed to begin recording command buffer");
+    commandBuffers.Begin(currentFrameIndex);
 
-    BeginSwapChainRenderPass(commandBuffer);
+    BeginSwapChainRenderPass();
 
     return true;
 }
@@ -139,14 +118,13 @@ void Renderer::EndFrame()
 
     DrawFrame();
 
-    VkCommandBuffer commandBuffer = GetCurrentCommandBuffer();
+    EndSwapChainRenderPass();
 
-    EndSwapChainRenderPass(commandBuffer);
+    commandBuffers.End();
 
-    CC_ASSERT(vkEndCommandBuffer(OUT commandBuffer) == VK_SUCCESS,
-              "Failed to record command buffer!");
+    commandBuffers.SetActiveBufferIndex(currentFrameIndex);
 
-    auto result = swapchain.SubmitCommandBuffers(&commandBuffer, &currentImageIndex);
+    auto result = swapchain.SubmitCommandBuffers(commandBuffers, currentImageIndex);
 
     if (result == Vulkan::Utils::ERROR_RESIZED || window.WasResized())
     {
@@ -161,17 +139,15 @@ void Renderer::EndFrame()
     Renderer2D::Flush();
 }
 
-void Renderer::BeginSwapChainRenderPass(VkCommandBuffer commandBuffer)
+void Renderer::BeginSwapChainRenderPass()
 {
     auto& swapchain = context.GetSwapchain();
 
-    CC_ASSERT(isFrameStarted, "Can't start render pass while the frame hasn't started!");
-    CC_ASSERT(commandBuffer == GetCurrentCommandBuffer(),
-              "Can't begin a render pass on a command buffer from another frame!");
+    CC_ASSERT(isFrameStarted, "Can't start render pass while the frame hasn't started!")
 
     auto swapExtent = swapchain.GetExtent();
 
-    swapchain.BeginRenderPass(OUT commandBuffer, currentImageIndex, {{clearValue}, {{{1.f, 0.f}}}});
+    swapchain.BeginRenderPass(commandBuffers, currentImageIndex, {{clearValue}, {{{1.f, 0.f}}}});
 
     VkViewport viewport {};
     viewport.x = 0.0f;
@@ -182,18 +158,16 @@ void Renderer::BeginSwapChainRenderPass(VkCommandBuffer commandBuffer)
     viewport.maxDepth = 1.0f;
     VkRect2D scissor {{0, 0}, {swapExtent.width, swapExtent.height}};
 
-    vkCmdSetViewport(commandBuffer, 0, 1, &viewport);
-    vkCmdSetScissor(commandBuffer, 0, 1, &scissor);
+    vkCmdSetViewport(commandBuffers.GetActiveCommandBuffer(), 0, 1, &viewport);
+    vkCmdSetScissor(commandBuffers.GetActiveCommandBuffer(), 0, 1, &scissor);
 }
 
-void Renderer::EndSwapChainRenderPass(VkCommandBuffer commandBuffer)
+void Renderer::EndSwapChainRenderPass()
 {
     auto& swapchain = context.GetSwapchain();
 
-    CC_ASSERT(isFrameStarted, "Can't end render pass while the frame hasn't started!");
-    CC_ASSERT(commandBuffer == GetCurrentCommandBuffer(),
-              "Can't end a render pass on a command buffer from another frame!");
+    CC_ASSERT(isFrameStarted, "Can't end render pass while the frame hasn't started!")
 
-    swapchain.EndRenderPass(commandBuffer);
+    swapchain.EndRenderPass(commandBuffers);
 }
 } // namespace Siege

engine/render/renderer/Renderer.h

@@ -16,6 +16,7 @@
 #include "material/Material.h"
 #include "model/Model.h"
 #include "pipeline/Pipeline.h"
+#include "render/renderer/platform/vulkan/CommandBuffer.h"
 #include "render/renderer/platform/vulkan/Context.h"
 #include "render/window/Window.h"
 #include "renderer/Renderer2D.h"
@@ -31,12 +32,6 @@ class Renderer
 
     ~Renderer();
 
-    int GetCurrentFrameIndex() const
-    {
-        CC_ASSERT(!isFrameStarted, "Can't get frame index when frame is not in progress!");
-        return currentFrameIndex;
-    }
-
     float GetAspectRatio() const
     {
         return static_cast<float>(window.GetWidth()) / static_cast<float>(window.GetHeight());
@@ -47,12 +42,6 @@ class Renderer
         projection = {projectionMat, viewMat};
     }
 
-    VkCommandBuffer GetCurrentCommandBuffer() const
-    {
-        CC_ASSERT(isFrameStarted, "Can't get command buffer when frame is not in progress!")
-        return commandBuffers[currentFrameIndex];
-    }
-
     bool StartFrame();
     void EndFrame();
 
@@ -79,27 +68,25 @@ class Renderer
 private:
 
     static Renderer* instance;
-    static Utils::MHArray<VkCommandBuffer> commandBuffers;
+    static Vulkan::CommandBuffer commandBuffers;
+    static uint32_t currentFrameIndex;
 
     Vulkan::Context context;
 
     // Make this adjustable in the window, not the renderer.
     VkClearColorValue clearValue {{0.96f, 0.96f, 0.96f, 1.f}};
 
-    void CreateCommandBuffers();
-
     void RecreateSwapChain();
 
-    void BeginSwapChainRenderPass(VkCommandBuffer commandBuffer);
-    void EndSwapChainRenderPass(VkCommandBuffer commandBuffer);
+    void BeginSwapChainRenderPass();
+    void EndSwapChainRenderPass();
 
     void DrawFrame();
 
     Window& window;
 
     uint32_t currentImageIndex;
     bool isFrameStarted {false};
-    int currentFrameIndex {0};
 
     CameraData projection;
 };

engine/render/renderer/pass/RenderPass.cpp

@@ -31,7 +31,7 @@ void RenderPass::DestroyRenderPass()
 }
 
 void RenderPass::Begin(VkRenderPass renderPass,
-                       VkCommandBuffer commandBuffer,
+                       Vulkan::CommandBuffer& commandBuffer,
                        VkFramebuffer frameBuffer,
                        VkOffset2D offset,
                        VkExtent2D extent,
@@ -49,12 +49,14 @@ void RenderPass::Begin(VkRenderPass renderPass,
     renderPassInfo.clearValueCount = clearValueCount;
     renderPassInfo.pClearValues = clearValues;
 
-    vkCmdBeginRenderPass(OUT commandBuffer, &renderPassInfo, VK_SUBPASS_CONTENTS_INLINE);
+    vkCmdBeginRenderPass(OUT commandBuffer.GetActiveCommandBuffer(),
+                         &renderPassInfo,
+                         VK_SUBPASS_CONTENTS_INLINE);
 }
 
-void RenderPass::End(VkCommandBuffer commandBuffer)
+void RenderPass::End(Vulkan::CommandBuffer& commandBuffer)
 {
-    vkCmdEndRenderPass(OUT commandBuffer);
+    vkCmdEndRenderPass(OUT commandBuffer.GetActiveCommandBuffer());
 }
 
 RenderPass::RenderPass() = default;

engine/render/renderer/pass/RenderPass.h

@@ -10,6 +10,7 @@
 #define SIEGE_ENGINE_RENDER_PASS_H
 
 #include "../Core.h"
+#include "render/renderer/platform/vulkan/CommandBuffer.h"
 #include "utils/Attachments.h"
 
 namespace Siege
@@ -191,7 +192,7 @@ class RenderPass
      * @param clearValueCount The number of clear values provided
      */
     static void Begin(VkRenderPass renderPass,
-                      VkCommandBuffer commandBuffer,
+                      Vulkan::CommandBuffer& commandBuffer,
                       VkFramebuffer frameBuffer,
                       VkOffset2D offset,
                       VkExtent2D extent,
@@ -204,7 +205,7 @@ class RenderPass
      *
      * @param commandBuffer The command buffer currently being recorded to
      */
-    static void End(VkCommandBuffer commandBuffer);
+    static void End(Vulkan::CommandBuffer& commandBuffer);
 
     inline RenderPass& operator=(RenderPass&& other) noexcept
     {

engine/render/renderer/platform/vulkan/CommandBuffer.cpp

@@ -0,0 +1,67 @@
+//
+//  Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
+//
+//  This code is released under an unmodified zlib license.
+//  For conditions of distribution and use, please see:
+//      https://opensource.org/licenses/Zlib
+//
+
+#include "CommandBuffer.h"
+
+#include "Context.h"
+#include "utils/CommandBuffer.h"
+#include "utils/SubmitCommands.h"
+
+namespace Siege::Vulkan
+{
+CommandBuffer::CommandBuffer(uint32_t count)
+{
+    auto device = Context::GetVkLogicalDevice();
+    auto pool = Context::GetCurrentDevice()->GetCommandPool();
+
+    commandBuffers = Utils::CommandBuffer::AllocateCommandBuffers(device, pool, count);
+}
+
+void CommandBuffer::Begin(int32_t index)
+{
+    auto commandBuffer = commandBuffers[index];
+
+    Utils::CommandBuffer::BeginSingleTimeCommand(commandBuffer);
+
+    activeCommandBuffer = commandBuffer;
+}
+
+void CommandBuffer::End()
+{
+    Utils::CommandBuffer::EndCommandBuffer(activeCommandBuffer);
+
+    activeCommandBuffer = nullptr;
+}
+
+void CommandBuffer::Submit(const size_t index)
+{
+    Vulkan::Fence fence(1, Fence::FENCE_EMPTY);
+
+    Utils::SubmitGraphicsCommand()
+        .ToQueue(Vulkan::Context::GetCurrentDevice()->GetGraphicsQueue())
+        .WithCommandBuffers({commandBuffers[index]})
+        .Submit(fence.Get());
+
+    fence.Wait();
+}
+
+void CommandBuffer::Swap(CommandBuffer& other)
+{
+    auto tmpCmdBuffers = std::move(commandBuffers);
+    auto tmpActiveCmdBuffer = activeCommandBuffer;
+    auto tmpCurrentActiveBufferIndex = currentActiveBufferIndex;
+
+    commandBuffers = std::move(other.commandBuffers);
+    activeCommandBuffer = other.activeCommandBuffer;
+    currentActiveBufferIndex = other.currentActiveBufferIndex;
+
+    other.commandBuffers = std::move(tmpCmdBuffers);
+    other.activeCommandBuffer = tmpActiveCmdBuffer;
+    other.currentActiveBufferIndex = tmpCurrentActiveBufferIndex;
+}
+} // namespace Siege::Vulkan