Merge pull request #17 from CapsCollective/feature/swapchain-vulkan-separation

Refactored swapchain class to be more readable

Author: Raelr

README.md

@@ -100,7 +100,7 @@ If you want to build with validation layers then the setup scripts should be run
 
 ```console
 // Linux & macOS
-$ ./scripts/install.sh --include-validation-layers
+$ ./scripts/setup.sh --include-validation-layers
 ```
 ```console
 // Windows
@@ -111,7 +111,7 @@ $ ./scripts/install.sh --include-validation-layers
 
 ### Building the Project
 
-Assuming all dependencies have been satisfied, the project can be build and run using the following command:
+Assuming all dependencies have been satisfied, the project can be build using the following command:
 
 ```console
 // Linux and macOS
@@ -128,9 +128,7 @@ $ make CXXFLAGS="-DENABLE_VALIDATION_LAYERS=1"
 > mingw32-make CXXFLAGS="-DENABLE_VALIDATION_LAYERS=1"
 ```
 
-These commands should build the project and immediately run executable.
-
-Once these are done the project should be built and ready to go. Enjoy!
+Once it completes, all targets should be built and ready to run from the newly generated `output` directory.
 
 ### Working With Siege
 

engine/render/renderer/Renderer.cpp

@@ -10,6 +10,8 @@
 
 #include "Renderer.h"
 
+#include "platform/vulkan/utils/Types.h"
+
 namespace Siege
 {
 Renderer* Renderer::instance {nullptr};
@@ -19,9 +21,11 @@ Renderer::Renderer(Window& window) : window {window}
 {
     if (instance == nullptr) instance = this;
 
-    context.Init(Window::GetRequiredExtensions, Window::CreateWindowSurface);
+    auto extent = window.GetExtent();
 
-    swapChain.SetWindowExtents(window.GetExtent());
+    context.Init({extent.width, extent.height},
+                 Window::GetRequiredExtensions,
+                 Window::CreateWindowSurface);
 
     DescriptorPool::AddPoolSize(VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, 10);
     DescriptorPool::AddPoolSize(VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, 10);
@@ -45,7 +49,7 @@ Renderer::~Renderer()
 
 void Renderer::CreateCommandBuffers()
 {
-    commandBuffers = Utils::MHArray<VkCommandBuffer>(SwapChain::MAX_FRAMES_IN_FLIGHT);
+    commandBuffers = Utils::MHArray<VkCommandBuffer>(Vulkan::Swapchain::MAX_FRAMES_IN_FLIGHT);
 
     VkCommandBufferAllocateInfo allocInfo {};
     allocInfo.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
@@ -79,15 +83,16 @@ void Renderer::RecreateSwapChain()
         window.WaitEvents();
     }
 
-    auto oldImageFormat = swapChain.GetImageFormat();
-    auto oldDepthFormat = swapChain.GetDepthFormat();
+    auto& swapchain = context.GetSwapchain();
+
+    auto oldImageFormat = swapchain.GetImageFormat();
+    auto oldDepthFormat = swapchain.GetDepthFormat();
 
-    // Re-create swapchain
-    swapChain.RecreateSwapchain();
+    context.RecreateSwapchain({extent.width, extent.height});
 
     // Re-create the pipeline once the swapchain renderpass
     // becomes available again.
-    if (!swapChain.CompareSwapFormats(oldImageFormat, oldDepthFormat))
+    if (!swapchain.IsSameSwapFormat(oldImageFormat, oldDepthFormat))
     {
         Renderer3D::RecreateMaterials();
         Renderer2D::RecreateMaterials();
@@ -98,15 +103,17 @@ bool Renderer::StartFrame()
 {
     CC_ASSERT(!isFrameStarted, "Can't start a frame when a frame is already in progress!");
 
-    auto result = swapChain.AcquireNextImage(&currentImageIndex);
+    auto& swapchain = context.GetSwapchain();
 
-    if (result == VK_ERROR_OUT_OF_DATE_KHR)
+    auto result = swapchain.AcquireNextImage(&currentImageIndex);
+
+    if (result == Vulkan::Utils::ERROR_OUT_OF_DATE)
     {
         RecreateSwapChain();
         return false;
     }
 
-    CC_ASSERT(result == VK_SUCCESS || result == VK_SUBOPTIMAL_KHR,
+    CC_ASSERT(result == Vulkan::Utils::SUCCESS || result == Vulkan::Utils::SUBOPTIMAL,
               "Failed to acquire swapchain image!");
 
     isFrameStarted = true;
@@ -126,7 +133,9 @@ bool Renderer::StartFrame()
 
 void Renderer::EndFrame()
 {
-    CC_ASSERT(isFrameStarted, "Can't end frame while frame is not in progress!");
+    CC_ASSERT(isFrameStarted, "Can't end frame while frame is not in progress!")
+
+    auto& swapchain = context.GetSwapchain();
 
     DrawFrame();
 
@@ -137,63 +146,54 @@ void Renderer::EndFrame()
     CC_ASSERT(vkEndCommandBuffer(OUT commandBuffer) == VK_SUCCESS,
               "Failed to record command buffer!");
 
-    auto result = swapChain.SubmitCommandBuffers(&commandBuffer, &currentImageIndex);
+    auto result = swapchain.SubmitCommandBuffers(&commandBuffer, &currentImageIndex);
 
-    if (result == VK_ERROR_OUT_OF_DATE_KHR || result == VK_SUBOPTIMAL_KHR || window.WasResized())
+    if (result == Vulkan::Utils::ERROR_RESIZED || window.WasResized())
     {
         window.ResetWindowResized();
         RecreateSwapChain();
     }
-    else if (result != VK_SUCCESS)
-    {
-        CC_ASSERT(result == VK_SUCCESS, "Failed to submit command buffer for drawing!");
-    }
 
     isFrameStarted = false;
-    currentFrameIndex = (currentFrameIndex + 1) % SwapChain::MAX_FRAMES_IN_FLIGHT;
+    currentFrameIndex = (currentFrameIndex + 1) % Vulkan::Swapchain::MAX_FRAMES_IN_FLIGHT;
 
     Renderer3D::Flush();
     Renderer2D::Flush();
 }
 
 void Renderer::BeginSwapChainRenderPass(VkCommandBuffer commandBuffer)
 {
+    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!");
 
-    uint32_t clearValueCount = 2;
-    VkClearValue clearValues[clearValueCount];
-    clearValues[0].color = clearValue;
-    clearValues[1].depthStencil = {1.0f, 0};
+    auto swapExtent = swapchain.GetExtent();
 
-    RenderPass::Begin(swapChain.GetRenderPass()->GetRenderPass(),
-                      OUT commandBuffer,
-                      swapChain.GetFrameBuffer(currentImageIndex),
-                      {0, 0},
-                      swapChain.GetSwapChainExtent(),
-                      clearValues,
-                      clearValueCount);
+    swapchain.BeginRenderPass(OUT commandBuffer, currentImageIndex, {{clearValue}, {{{1.f, 0.f}}}});
 
     VkViewport viewport {};
     viewport.x = 0.0f;
     viewport.y = 0.0f;
-    viewport.width = static_cast<float>(swapChain.GetSwapChainExtent().width);
-    viewport.height = static_cast<float>(swapChain.GetSwapChainExtent().height);
+    viewport.width = static_cast<float>(swapExtent.width);
+    viewport.height = static_cast<float>(swapExtent.height);
     viewport.minDepth = 0.0f;
     viewport.maxDepth = 1.0f;
-    VkRect2D scissor {{0, 0}, swapChain.GetSwapChainExtent()};
+    VkRect2D scissor {{0, 0}, {swapExtent.width, swapExtent.height}};
 
     vkCmdSetViewport(commandBuffer, 0, 1, &viewport);
     vkCmdSetScissor(commandBuffer, 0, 1, &scissor);
 }
 
 void Renderer::EndSwapChainRenderPass(VkCommandBuffer commandBuffer)
 {
+    auto& swapchain = context.GetSwapchain();
+
     CC_ASSERT(isFrameStarted, "Can't end 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!");
+              "Can't end a render pass on a command buffer from another frame!");
 
-    RenderPass::End(commandBuffer);
+    swapchain.EndRenderPass(commandBuffer);
 }
 } // namespace Siege

engine/render/renderer/Renderer.h

@@ -20,7 +20,6 @@
 #include "render/window/Window.h"
 #include "renderer/Renderer2D.h"
 #include "renderer/Renderer3D.h"
-#include "swapchain/Swapchain.h"
 
 namespace Siege
 {
@@ -32,16 +31,6 @@ class Renderer
 
     ~Renderer();
 
-    SwapChain& GetSwapChain()
-    {
-        return swapChain;
-    }
-
-    VkRenderPass GetSwapChanRenderPass()
-    {
-        return swapChain.GetRenderPass()->GetRenderPass();
-    }
-
     int GetCurrentFrameIndex() const
     {
         CC_ASSERT(!isFrameStarted, "Can't get frame index when frame is not in progress!");
@@ -50,19 +39,14 @@ class Renderer
 
     float GetAspectRatio() const
     {
-        return swapChain.ExtentAspectRatio();
+        return static_cast<float>(window.GetWidth()) / static_cast<float>(window.GetHeight());
     }
 
     void SetProjection(const Mat4& projectionMat, const Mat4& viewMat)
     {
         projection = {projectionMat, viewMat};
     }
 
-    bool IsFrameStarted() const
-    {
-        return isFrameStarted;
-    }
-
     VkCommandBuffer GetCurrentCommandBuffer() const
     {
         CC_ASSERT(isFrameStarted, "Can't get command buffer when frame is not in progress!")
@@ -113,8 +97,6 @@ class Renderer
 
     Window& window;
 
-    SwapChain swapChain;
-
     uint32_t currentImageIndex;
     bool isFrameStarted {false};
     int currentFrameIndex {0};

engine/render/renderer/Renderer3D.cpp

@@ -0,0 +1,8 @@
+//
+// Created by Aryeh Zinn on 29/9/2022.
+//
+
+#include "Renderer3D.h"
+
+namespace Siege
+{} // namespace Siege

engine/render/renderer/Renderer3D.h

@@ -0,0 +1,16 @@
+//
+// Created by Aryeh Zinn on 29/9/2022.
+//
+
+#ifndef SIEGE_ENGINE_RENDERER3D_H
+#define SIEGE_ENGINE_RENDERER3D_H
+
+namespace Siege
+{
+
+class Renderer3D
+{};
+
+} // namespace Siege
+
+#endif // SIEGE_ENGINE_RENDERER3D_H

engine/render/renderer/material/Material.cpp

@@ -11,7 +11,6 @@
 #include <utils/Logging.h>
 
 #include "../mesh/Mesh.h"
-#include "../swapchain/Swapchain.h"
 #include "render/renderer/platform/vulkan/Context.h"
 #include "render/renderer/platform/vulkan/utils/Descriptor.h"
 
@@ -127,7 +126,7 @@ void Material::CreatePipeline()
     pipelineConfig.rasterizationInfo.polygonMode = (VkPolygonMode) shaderSettings.mode;
     pipelineConfig.inputAssemblyInfo.topology = (VkPrimitiveTopology) shaderSettings.topology;
 
-    pipelineConfig.renderPass = SwapChain::GetInstance()->GetRenderPass()->GetRenderPass();
+    pipelineConfig.renderPass = Vulkan::Context::GetSwapchain().GetRenderPass()->GetRenderPass();
     pipelineConfig.pipelineLayout = pipelineLayout;
 
     pipelineConfig.vertexData =

engine/render/renderer/pass/RenderPass.cpp

@@ -22,15 +22,20 @@ RenderPass::~RenderPass()
 
 void RenderPass::DestroyRenderPass()
 {
-    vkDestroyRenderPass(Vulkan::Context::GetVkLogicalDevice(), renderPass, nullptr);
+    auto device = Vulkan::Context::GetVkLogicalDevice();
+    if (device)
+    {
+        vkDestroyRenderPass(device, renderPass, nullptr);
+        renderPass = VK_NULL_HANDLE;
+    }
 }
 
 void RenderPass::Begin(VkRenderPass renderPass,
                        VkCommandBuffer commandBuffer,
                        VkFramebuffer frameBuffer,
                        VkOffset2D offset,
                        VkExtent2D extent,
-                       VkClearValue* clearValues,
+                       const VkClearValue* clearValues,
                        uint32_t clearValueCount)
 {
     VkRenderPassBeginInfo renderPassInfo {};

engine/render/renderer/pass/RenderPass.h

@@ -144,6 +144,11 @@ class RenderPass
         Initialise(config);
     }
 
+    inline RenderPass(RenderPass&& other)
+    {
+        Swap(other);
+    }
+
     /**
      * @brief Initialises the RenderPass. Creating a RenderPass requires us to explicitly state what
      * operations the RenderPass will be responsible for, along with any graphics stages the
@@ -190,7 +195,7 @@ class RenderPass
                       VkFramebuffer frameBuffer,
                       VkOffset2D offset,
                       VkExtent2D extent,
-                      VkClearValue* clearValues,
+                      const VkClearValue* clearValues,
                       uint32_t clearValueCount);
 
     /**

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

@@ -17,12 +17,14 @@ namespace Siege::Vulkan
 {
 Context::~Context()
 {
+    swapchain.~Swapchain();
     logicalDevice.~LogicalDevice();
     vkDestroySurfaceKHR(vulkanInstance.GetInstance(), surface, nullptr);
     vulkanInstance.~Instance();
 }
 
-void Context::Init(Instance::GetSurfaceExtensionsCallback surfaceExtensionsCallback,
+void Context::Init(const Utils::Extent2D& extent,
+                   Instance::GetSurfaceExtensionsCallback surfaceExtensionsCallback,
                    GetWindowSurfaceCallBack windowSurfaceCallback)
 {
     CC_ASSERT(volkInitialize() == VK_SUCCESS, "Unable to initialise Volk!")
@@ -35,10 +37,24 @@ void Context::Init(Instance::GetSurfaceExtensionsCallback surfaceExtensionsCallb
     physicalDevice = PhysicalDevice(surface, vulkanInstance);
 
     logicalDevice = LogicalDevice(surface, physicalDevice);
+
+    swapchain = Swapchain(extent);
 }
 
 Context& Context::Get()
 {
     return Renderer::Context();
 }
+
+void Context::RecreateSwapchain(const Utils::Extent2D& extent)
+{
+    auto oldSwapchain = Get().GetSwapchain().GetRaw();
+    Get().RecreateSwapchain(extent, oldSwapchain);
+}
+
+void Context::RecreateSwapchain(const Utils::Extent2D& extent, VkSwapchainKHR oldSwapchain)
+{
+    swapchain = Swapchain(extent, oldSwapchain);
+}
+
 } // namespace Siege::Vulkan