clang tidy 4 and documentation

OSMaxwell · OSMaxwell · commit 67d4d840aca7 · 2023-10-05T15:39:12.000+02:00
diff --git a/Intern/rayx-ui/src/Application.cpp b/Intern/rayx-ui/src/Application.cpp
@@ -26,23 +26,22 @@ Application::Application(uint32_t width, uint32_t height, const char* name)
                            .build();
 }
 
-Application::~Application() {}
+Application::~Application() = default;
 
 void Application::run() {
-    // UBOs
+    // Create UBOs (Uniform Buffer Object)
     std::vector<std::unique_ptr<Buffer>> uboBuffers(SwapChain::MAX_FRAMES_IN_FLIGHT);
-    for (int i = 0; i < uboBuffers.size(); i++) {
-        uboBuffers[i] =
-            std::make_unique<Buffer>(m_Device, sizeof(Camera), 1, VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT);
-        uboBuffers[i]->map();
+    for (auto& uboBuffer : uboBuffers) {
+        uboBuffer = std::make_unique<Buffer>(m_Device, sizeof(Camera), 1, VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT);
+        uboBuffer->map();
     }
 
     // Descriptor set layout
     auto setLayout = DescriptorSetLayout::Builder(m_Device)
                          .addBinding(0, VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, VK_SHADER_STAGE_VERTEX_BIT)  //
                          .build();                                                                      //
     std::vector<VkDescriptorSet> descriptorSets(SwapChain::MAX_FRAMES_IN_FLIGHT);
-    for (int i = 0; i < descriptorSets.size(); i++) {
+    for (unsigned long i = 0; i < descriptorSets.size(); i++) {
         auto bufferInfo = uboBuffers[i]->descriptorInfo();
         DescriptorWriter(*setLayout, *m_DescriptorPool).writeBuffer(0, &bufferInfo).build(descriptorSets[i]);
     }
@@ -95,7 +94,7 @@ void Application::run() {
                 rObjects = triangulateObjects(beamline.m_OpticalElements, m_Device, true);
                 rays = getRays(bundleHist, beamline.m_OpticalElements);
 
-                if (rays.size() > 0) {
+                if (!rays.empty()) {
                     // Temporarily aggregate all vertices, then create a single RenderObject
                     std::vector<Vertex> rayVertices(rays.size() * 2);
                     std::vector<uint32_t> rayIndices(rays.size() * 2);
@@ -109,7 +108,7 @@ void Application::run() {
                 }
             }
 
-            // Update ubo
+            // Update UBO
             uboBuffers[frameIndex]->writeToBuffer(&cam);
             uboBuffers[frameIndex]->flush();
 
diff --git a/Intern/rayx-ui/src/Application.h b/Intern/rayx-ui/src/Application.h
@@ -20,6 +20,13 @@ class Device;
 
 class Application {
   public:
+    /**
+     * @brief Constructs a new rayx-ui application.
+     *
+     * @param width The width of the application window.
+     * @param height The height of the application window.
+     * @param name The name of the application.
+     */
     Application(uint32_t width, uint32_t height, const char* name);
     ~Application();
 
@@ -30,9 +37,9 @@ class Application {
 
   private:
     // --- Order matters ---
-    Window m_Window;
-    Device m_Device;
-    Renderer m_Renderer;
+    Window m_Window; // Application window
+    Device m_Device; // Vulkan device
+    Renderer m_Renderer; // Vulkan renderer
 
     std::unique_ptr<DescriptorPool> m_DescriptorPool{nullptr};
 };
diff --git a/Intern/rayx-ui/src/Camera.cpp b/Intern/rayx-ui/src/Camera.cpp
@@ -1,7 +1,5 @@
 #include "Camera.h"
 
-#include <vulkan/vulkan.h>
-
 #include <fstream>
 #include <glm/gtc/matrix_transform.hpp>
 #include <sstream>
diff --git a/Intern/rayx-ui/src/GraphicsCore/Buffer.cpp b/Intern/rayx-ui/src/GraphicsCore/Buffer.cpp
@@ -2,13 +2,6 @@
 
 #include <cstring>
 
-VkDeviceSize Buffer::getAlignment(VkDeviceSize instanceSize, VkDeviceSize minOffsetAlignment) {
-    if (minOffsetAlignment > 0) {
-        return (instanceSize + minOffsetAlignment - 1) & ~(minOffsetAlignment - 1);
-    }
-    return instanceSize;
-}
-
 /**
  * Allocates buffer memory using given parameters and associates it with a Device.
  * Also calculates memory alignment.
@@ -31,6 +24,13 @@ Buffer::~Buffer() {
     vkFreeMemory(m_Device.device(), m_Memory, nullptr);
 }
 
+VkDeviceSize Buffer::getAlignment(VkDeviceSize instanceSize, VkDeviceSize minOffsetAlignment) {
+    if (minOffsetAlignment > 0) {
+        return (instanceSize + minOffsetAlignment - 1) & ~(minOffsetAlignment - 1);
+    }
+    return instanceSize;
+}
+
 /**
  * This function maps a range of the buffer's memory into the application's address space (making it accessible).
  * The mapped range starts from the given `offset` and extends for `size` bytes.
diff --git a/Intern/rayx-ui/src/GraphicsCore/Descriptors.cpp b/Intern/rayx-ui/src/GraphicsCore/Descriptors.cpp
@@ -23,6 +23,7 @@ std::unique_ptr<DescriptorSetLayout> DescriptorSetLayout::Builder::build() const
 DescriptorSetLayout::DescriptorSetLayout(Device& Device, std::unordered_map<uint32_t, VkDescriptorSetLayoutBinding> bindings)
     : m_Device{Device}, m_bindings{bindings} {
     std::vector<VkDescriptorSetLayoutBinding> setLayoutBindings{};
+    setLayoutBindings.reserve(bindings.size());
     for (auto kv : bindings) {
         setLayoutBindings.push_back(kv.second);
     }
diff --git a/Intern/rayx-ui/src/GraphicsCore/Descriptors.h b/Intern/rayx-ui/src/GraphicsCore/Descriptors.h
@@ -10,7 +10,7 @@ class DescriptorSetLayout {
   public:
     class Builder {
       public:
-        Builder(Device& Device) : m_Device{Device} {}
+        explicit Builder(Device& Device) : m_Device{Device} {}
 
         Builder& addBinding(uint32_t binding, VkDescriptorType descriptorType, VkShaderStageFlags stageFlags, uint32_t count = 1);
         std::unique_ptr<DescriptorSetLayout> build() const;
@@ -39,7 +39,7 @@ class DescriptorPool {
   public:
     class Builder {
       public:
-        Builder(Device& Device) : m_Device{Device} {}
+        explicit Builder(Device& Device) : m_Device{Device} {}
 
         Builder& addPoolSize(VkDescriptorType descriptorType, uint32_t count);
         Builder& setPoolFlags(VkDescriptorPoolCreateFlags flags);
diff --git a/Intern/rayx-ui/src/GraphicsCore/Device.cpp b/Intern/rayx-ui/src/GraphicsCore/Device.cpp
@@ -61,9 +61,9 @@ void Device::createInstance() {
     VkApplicationInfo appInfo = {};
     appInfo.sType = VK_STRUCTURE_TYPE_APPLICATION_INFO;
     appInfo.pApplicationName = "RAYX-UI";
-    appInfo.applicationVersion = VK_MAKE_VERSION(1, 0, 0);
+    appInfo.applicationVersion = VK_MAKE_API_VERSION(1, 0, 0, 0);
     appInfo.pEngineName = "RAYX-Core";
-    appInfo.engineVersion = VK_MAKE_VERSION(1, 0, 0);
+    appInfo.engineVersion = VK_MAKE_API_VERSION(1, 0, 0, 0);
     appInfo.apiVersion = VK_API_VERSION_1_0;
 
     VkInstanceCreateInfo createInfo = {};
diff --git a/Intern/rayx-ui/src/GraphicsCore/Device.h b/Intern/rayx-ui/src/GraphicsCore/Device.h
@@ -26,7 +26,7 @@ class Device {
     const bool enableValidationLayers = true;
 #endif
 
-    Device(Window& window);
+    explicit Device(Window& window);
     ~Device();
 
     // Not copyable or movable
diff --git a/Intern/rayx-ui/src/GraphicsCore/GraphicsPipeline.cpp b/Intern/rayx-ui/src/GraphicsCore/GraphicsPipeline.cpp
@@ -66,6 +66,7 @@ void GraphicsPipeline::createGraphicsPipeline(const std::string& vertFilepath, c
     shaderStages[0].flags = 0;
     shaderStages[0].pNext = nullptr;
     shaderStages[0].pSpecializationInfo = nullptr;
+
     shaderStages[1].sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO;
     shaderStages[1].stage = VK_SHADER_STAGE_FRAGMENT_BIT;
     shaderStages[1].module = m_FragShaderModule;
diff --git a/Intern/rayx-ui/src/GraphicsCore/GraphicsPipeline.h b/Intern/rayx-ui/src/GraphicsCore/GraphicsPipeline.h
@@ -20,13 +20,19 @@ struct PipelineConfigInfo {
     VkPipelineDepthStencilStateCreateInfo depthStencilInfo;
     std::vector<VkDynamicState> dynamicStateEnables;
     VkPipelineDynamicStateCreateInfo dynamicStateInfo;
+
     VkPipelineLayout pipelineLayout = nullptr;
     VkRenderPass renderPass = nullptr;
     VkPrimitiveTopology topology;
     VkPolygonMode polygonMode;
     uint32_t subpass = 0;
 };
 
+/**
+ * @brief The GraphicsPipeline class encapsulates a Vulkan graphics pipeline.
+ *
+ * It handles the creation and destruction of the pipeline, including shader modules, etc.
+ */
 class GraphicsPipeline {
   public:
     GraphicsPipeline(Device& device, const std::string& vertFilepath, const std::string& fragFilepath, const PipelineConfigInfo& createInfo);
@@ -36,6 +42,12 @@ class GraphicsPipeline {
     GraphicsPipeline& operator=(const GraphicsPipeline&) = delete;
 
     void bind(VkCommandBuffer commandBuffer);
+
+    /**
+     * @brief Provides default configuration information for a graphics pipeline.
+     *
+     * @param configInfo The configuration information to be filled with default values.
+     */
     static void defaultPipelineConfigInfo(PipelineConfigInfo& configInfo);
     VkPipeline getHandle() const { return m_Pipeline; }
 
diff --git a/Intern/rayx-ui/src/GraphicsCore/Renderer.cpp b/Intern/rayx-ui/src/GraphicsCore/Renderer.cpp
@@ -22,7 +22,7 @@ void Renderer::recreateSwapChain() {
         std::shared_ptr<SwapChain> oldSwapChain = std::move(m_SwapChain);
         m_SwapChain = std::make_unique<SwapChain>(m_Device, extent, oldSwapChain);
 
-        if (!oldSwapChain->compareSwapFormats(*m_SwapChain.get())) {
+        if (!oldSwapChain->compareSwapFormats(*m_SwapChain)) {
             throw std::runtime_error("Swap chain image(or depth) format has changed!");
         }
     }
diff --git a/Intern/rayx-ui/src/GraphicsCore/Swapchain.cpp b/Intern/rayx-ui/src/GraphicsCore/Swapchain.cpp
@@ -28,7 +28,7 @@ SwapChain::~SwapChain() {
         m_SwapChain = nullptr;
     }
 
-    for (int i = 0; i < m_depthImages.size(); i++) {
+    for (size_t i = 0; i < m_depthImages.size(); i++) {
         vkDestroyImageView(m_Device.device(), m_depthImageViews[i], nullptr);
         vkDestroyImage(m_Device.device(), m_depthImages[i], nullptr);
         vkFreeMemory(m_Device.device(), m_depthImageMemorys[i], nullptr);
@@ -272,7 +272,7 @@ void SwapChain::createDepthResources() {
     m_depthImageMemorys.resize(imageCount());
     m_depthImageViews.resize(imageCount());
 
-    for (int i = 0; i < m_depthImages.size(); i++) {
+    for (size_t i = 0; i < m_depthImages.size(); i++) {
         VkImageCreateInfo imageInfo{};
         imageInfo.sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO;
         imageInfo.imageType = VK_IMAGE_TYPE_2D;
diff --git a/Intern/rayx-ui/src/GraphicsCore/Window.cpp b/Intern/rayx-ui/src/GraphicsCore/Window.cpp
@@ -10,7 +10,7 @@
  *
  * @see: framebufferResizeCallback() for more information on the callback function.
  */
-Window::Window(uint32_t width, uint32_t height, const char* const title) {
+Window::Window(uint32_t width, uint32_t height, const char* title) {
     m_width = width;
     m_height = height;
     m_title = title;
diff --git a/Intern/rayx-ui/src/GraphicsCore/Window.h b/Intern/rayx-ui/src/GraphicsCore/Window.h
@@ -3,7 +3,7 @@
 #define GLFW_INCLUDE_VULKAN
 #include <GLFW/glfw3.h>
 
-struct Extent2D {
+struct [[maybe_unused]] Extent2D {
     uint32_t width;
     uint32_t height;
 };
@@ -24,7 +24,7 @@ class Window {
      * @param height The initial height of the window.
      * @param title The title of the window.
      */
-    Window(uint32_t width, uint32_t height, const char* const title);
+    Window(uint32_t width, uint32_t height, const char* title);
 
     /// Deleted copy constructor.
     Window(const Window&) = delete;
diff --git a/Intern/rayx-ui/src/RenderSystem/ObjectRenderSystem.cpp b/Intern/rayx-ui/src/RenderSystem/ObjectRenderSystem.cpp
@@ -38,8 +38,10 @@ void ObjectRenderSystem::createPipeline(VkRenderPass renderPass) {
     GraphicsPipeline::defaultPipelineConfigInfo(pipelineConfig);
     pipelineConfig.renderPass = renderPass;
     pipelineConfig.pipelineLayout = m_PipelineLayout;
-    m_Pipeline = std::make_unique<GraphicsPipeline>(m_Device, "../../../Intern/rayx-ui/src/Shaders/vert.spv",
-                                                    "../../../Intern/rayx-ui/src/Shaders/frag.spv", pipelineConfig);
+
+    const std::string vertexShader = "../../../Intern/rayx-ui/src/Shaders/vert.spv";
+    const std::string fragmentShader = "../../../Intern/rayx-ui/src/Shaders/frag.spv";
+    m_Pipeline = std::make_unique<GraphicsPipeline>(m_Device, vertexShader, fragmentShader, pipelineConfig);
 }
 
 void ObjectRenderSystem::render(FrameInfo& frameInfo, const std::vector<RenderObject>& objects) {
diff --git a/Intern/rayx-ui/src/RenderSystem/ObjectRenderSystem.h b/Intern/rayx-ui/src/RenderSystem/ObjectRenderSystem.h
@@ -1,13 +1,16 @@
 #pragma once
 
+#include <memory>
+
 #include "FrameInfo.h"
 #include "GraphicsCore/Device.h"
 #include "GraphicsCore/GraphicsPipeline.h"
 #include "RenderObject.h"
-
-// std
-#include <memory>
-
+/**
+ * @brief The ObjectRenderSystem class handles the rendering of a collection of RenderObjects.
+ *
+ * It manages the creation of pipelines and pipeline layouts, as well as the rendering process.
+ */
 class ObjectRenderSystem {
   public:
     ObjectRenderSystem(Device& device, VkRenderPass renderPass, VkDescriptorSetLayout globalSetLayout);
@@ -16,6 +19,12 @@ class ObjectRenderSystem {
     ObjectRenderSystem(const ObjectRenderSystem&) = delete;
     ObjectRenderSystem& operator=(const ObjectRenderSystem&) = delete;
 
+    /**
+     * @brief Renders a collection of RenderObjects.
+     *
+     * @param frameInfo Information about the current frame.
+     * @param objects A vector of RenderObjects to render.
+     */
     void render(FrameInfo& frameInfo, const std::vector<RenderObject>& objects);
 
   private:
diff --git a/Intern/rayx-ui/src/RenderSystem/RayRenderSystem.cpp b/Intern/rayx-ui/src/RenderSystem/RayRenderSystem.cpp
@@ -43,6 +43,8 @@ void RayRenderSystem::createPipeline(VkRenderPass renderPass) {
     pipelineConfig.rasterizationInfo.lineWidth = 2.0f;
     pipelineConfig.renderPass = renderPass;
     pipelineConfig.pipelineLayout = m_PipelineLayout;
-    m_Pipeline = std::make_unique<GraphicsPipeline>(m_Device, "../../../Intern/rayx-ui/src/Shaders/ray_vert.spv",
-                                                    "../../../Intern/rayx-ui/src/Shaders/frag.spv", pipelineConfig);
+
+    const std::string vertexShader = "../../../Intern/rayx-ui/src/Shaders/ray_vert.spv";
+    const std::string fragmentShader = "../../../Intern/rayx-ui/src/Shaders/frag.spv";
+    m_Pipeline = std::make_unique<GraphicsPipeline>(m_Device, vertexShader, fragmentShader, pipelineConfig);
 }
diff --git a/Intern/rayx-ui/src/RenderSystem/RayRenderSystem.h b/Intern/rayx-ui/src/RenderSystem/RayRenderSystem.h
@@ -10,6 +10,11 @@
 
 struct Line;
 
+/**
+ * @brief The RayRenderSystem class handles the rendering of a RenderObject representing rays.
+ *
+ * It manages the creation of pipelines and pipeline layouts, as well as the rendering process.
+ */
 class RayRenderSystem {
   public:
     RayRenderSystem(Device& device, VkRenderPass renderPass, VkDescriptorSetLayout globalSetLayout);
@@ -18,6 +23,12 @@ class RayRenderSystem {
     RayRenderSystem(const RayRenderSystem&) = delete;
     RayRenderSystem& operator=(const RayRenderSystem&) = delete;
 
+    /**
+     * @brief Renders a RenderObject representing rays.
+     *
+     * @param frameInfo Information about the current frame.
+     * @param renderObj An optional RenderObject representing rays.
+     */
     void render(FrameInfo& frameInfo, const std::optional<RenderObject>& renderObj);
 
   private:

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ std::unique_ptr<DescriptorSetLayout> DescriptorSetLayout::Builder::build() const`
`23`	`23`	`DescriptorSetLayout::DescriptorSetLayout(Device& Device, std::unordered_map<uint32_t, VkDescriptorSetLayoutBinding> bindings)`
`24`	`24`	`: m_Device{Device}, m_bindings{bindings} {`
`25`	`25`	`std::vector<VkDescriptorSetLayoutBinding> setLayoutBindings{};`
	`26`	`+ setLayoutBindings.reserve(bindings.size());`
`26`	`27`	`for (auto kv : bindings) {`
`27`	`28`	`setLayoutBindings.push_back(kv.second);`
`28`	`29`	`}`