[merge] Merge pull request #613 from inexorgame/hanni/cleanup

Cleanup

Author: IAmNotHanni

example/main.cpp

@@ -1,41 +1,15 @@
 #include "inexor/vulkan-renderer/application.hpp"
 
-#include <spdlog/async.h>
-#include <spdlog/sinks/basic_file_sink.h>
-#include <spdlog/sinks/stdout_color_sinks.h>
-#include <spdlog/spdlog.h>
-
 #include <stdexcept>
 
 int main(int argc, char *argv[]) {
-    spdlog::init_thread_pool(8192, 2);
-
-    auto console_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
-    auto file_sink = std::make_shared<spdlog::sinks::basic_file_sink_mt>("vulkan-renderer.log", true);
-    auto vulkan_renderer_log =
-        std::make_shared<spdlog::async_logger>("vulkan-renderer", spdlog::sinks_init_list{console_sink, file_sink},
-                                               spdlog::thread_pool(), spdlog::async_overflow_policy::block);
-    vulkan_renderer_log->set_level(spdlog::level::trace);
-    vulkan_renderer_log->set_pattern("%Y-%m-%d %T.%f %^%l%$ %5t [%-10n] %v");
-    vulkan_renderer_log->flush_on(spdlog::level::debug); // TODO: as long as we don't have a flush on crash
-
-    spdlog::set_default_logger(vulkan_renderer_log);
-
-    spdlog::trace("Inexor vulkan-renderer, BUILD " + std::string(__DATE__) + ", " + __TIME__);
-    spdlog::trace("Parsing command line arguments");
-
-    std::unique_ptr<inexor::vulkan_renderer::Application> renderer;
-
     try {
-        renderer = std::make_unique<inexor::vulkan_renderer::Application>(argc, argv);
-    } catch (const std::runtime_error &exception) {
-        spdlog::critical(exception.what());
-        return 1;
+        using inexor::vulkan_renderer::Application;
+        auto renderer = std::make_unique<Application>(argc, argv);
+        renderer->run();
     } catch (const std::exception &exception) {
         spdlog::critical(exception.what());
         return 1;
     }
-
-    renderer->run();
-    spdlog::trace("Window closed");
+    return 0;
 }

include/inexor/vulkan-renderer/application.hpp

@@ -32,7 +32,6 @@ class Application : public VulkanRenderer {
     /// @brief file_name The TOML configuration file.
     /// @note It was collectively decided not to use JSON for configuration files.
     void load_toml_configuration_file(const std::string &file_name);
-    void load_textures();
     void load_shaders();
     /// @param initialize Initialize worlds with a fixed seed, which is useful for benchmarking and testing
     void load_octree_geometry(bool initialize);
@@ -43,6 +42,7 @@ class Application : public VulkanRenderer {
     /// Use the camera's position and view direction vector to check for ray-octree collisions with all octrees.
     void check_octree_collisions();
     void process_input();
+    void initialize_spdlog();
 
 public:
     Application(int argc, char **argv);

include/inexor/vulkan-renderer/render_graph.hpp

@@ -16,19 +16,26 @@
 // TODO: Compute stages.
 // TODO: Uniform buffers.
 
-// Forward declarations
 namespace inexor::vulkan_renderer::wrapper {
-class CommandBuffer;
+// Forward declaration
 class Shader;
 }; // namespace inexor::vulkan_renderer::wrapper
 
+namespace inexor::vulkan_renderer::wrapper::commands {
+// Forward declaration
+class CommandBuffer;
+} // namespace inexor::vulkan_renderer::wrapper::commands
+
 namespace inexor::vulkan_renderer {
 
 // Forward declarations
 class PhysicalResource;
 class PhysicalStage;
 class RenderGraph;
 
+// Using declaration
+using wrapper::commands::CommandBuffer;
+
 /// @brief Base class of all render graph objects (resources and stages).
 /// @note This is just for internal use.
 struct RenderGraphObject {
@@ -167,7 +174,7 @@ class RenderStage : public RenderGraphObject {
 
     std::vector<VkDescriptorSetLayout> m_descriptor_layouts;
     std::vector<VkPushConstantRange> m_push_constant_ranges;
-    std::function<void(const PhysicalStage &, const wrapper::CommandBuffer &)> m_on_record{[](auto &, auto &) {}};
+    std::function<void(const PhysicalStage &, const CommandBuffer &)> m_on_record{[](auto &, auto &) {}};
 
 protected:
     explicit RenderStage(std::string name) : m_name(std::move(name)) {}
@@ -393,7 +400,7 @@ class RenderGraph {
 
     // Functions for building stage related vulkan objects.
     void build_pipeline_layout(const RenderStage *, PhysicalStage &) const;
-    void record_command_buffer(const RenderStage *, const wrapper::CommandBuffer &cmd_buf,
+    void record_command_buffer(const RenderStage *, const wrapper::commands::CommandBuffer &cmd_buf,
                                std::uint32_t image_index) const;
 
     // Functions for building graphics stage related vulkan objects.
@@ -427,7 +434,7 @@ class RenderGraph {
     /// @brief Submits the command frame's command buffers for drawing.
     /// @param image_index The current image index, retrieved from Swapchain::acquire_next_image
     /// @param cmd_buf The command buffer
-    void render(std::uint32_t image_index, const wrapper::CommandBuffer &cmd_buf);
+    void render(std::uint32_t image_index, const wrapper::commands::CommandBuffer &cmd_buf);
 };
 
 template <typename T>

include/inexor/vulkan-renderer/renderer.hpp

@@ -7,11 +7,14 @@
 #include "inexor/vulkan-renderer/time_step.hpp"
 #include "inexor/vulkan-renderer/wrapper/instance.hpp"
 #include "inexor/vulkan-renderer/wrapper/uniform_buffer.hpp"
-#include "inexor/vulkan-renderer/wrapper/window.hpp"
-#include "inexor/vulkan-renderer/wrapper/window_surface.hpp"
+#include "inexor/vulkan-renderer/wrapper/window/surface.hpp"
+#include "inexor/vulkan-renderer/wrapper/window/window.hpp"
 
 namespace inexor::vulkan_renderer {
 
+using wrapper::window::Window;
+using wrapper::window::WindowSurface;
+
 class VulkanRenderer {
 protected:
     std::vector<VkPipelineShaderStageCreateInfo> m_shader_stages;
@@ -24,7 +27,7 @@ class VulkanRenderer {
 
     std::uint32_t m_window_width{0};
     std::uint32_t m_window_height{0};
-    wrapper::Window::Mode m_window_mode{wrapper::Window::Mode::WINDOWED};
+    Window::Mode m_window_mode{Window::Mode::WINDOWED};
 
     std::string m_window_title;
 
@@ -34,10 +37,10 @@ class VulkanRenderer {
 
     std::unique_ptr<Camera> m_camera;
 
-    std::unique_ptr<wrapper::Window> m_window;
+    std::unique_ptr<Window> m_window;
     std::unique_ptr<wrapper::Instance> m_instance;
     std::unique_ptr<wrapper::Device> m_device;
-    std::unique_ptr<wrapper::WindowSurface> m_surface;
+    std::unique_ptr<WindowSurface> m_surface;
     std::unique_ptr<wrapper::Swapchain> m_swapchain;
     std::unique_ptr<ImGUIOverlay> m_imgui_overlay;
     std::unique_ptr<RenderGraph> m_render_graph;

include/inexor/vulkan-renderer/vk_tools/device_info.hpp renamed to include/inexor/vulkan-renderer/tools/device_info.hpp

@@ -5,7 +5,7 @@
 #include <string>
 #include <vector>
 
-namespace inexor::vulkan_renderer::vk_tools {
+namespace inexor::vulkan_renderer::tools {
 
 /// Transform a ``VkPhysicalDeviceFeatures`` into a ``std::vector<VkBool32>``
 /// @note The size of the vector will be determined by the number of ``VkBool32`` variables in the
@@ -19,4 +19,4 @@ namespace inexor::vulkan_renderer::vk_tools {
 /// @return The name of the physical device
 [[nodiscard]] std::string get_physical_device_name(VkPhysicalDevice physical_device);
 
-} // namespace inexor::vulkan_renderer::vk_tools
+} // namespace inexor::vulkan_renderer::tools

include/inexor/vulkan-renderer/vk_tools/enumerate.hpp renamed to include/inexor/vulkan-renderer/tools/enumerate.hpp

@@ -4,7 +4,7 @@
 
 #include <vector>
 
-namespace inexor::vulkan_renderer::vk_tools {
+namespace inexor::vulkan_renderer::tools {
 
 /// All functions which contain the word "all" in it, call some vkEnumerate.. function,
 /// while all functions without it call vkGet..
@@ -45,4 +45,4 @@ namespace inexor::vulkan_renderer::vk_tools {
 [[nodiscard]] std::vector<VkPresentModeKHR> get_surface_present_modes(VkPhysicalDevice physical_device,
                                                                       VkSurfaceKHR surface);
 
-} // namespace inexor::vulkan_renderer::vk_tools
+} // namespace inexor::vulkan_renderer::tools

include/inexor/vulkan-renderer/vk_tools/representation.hpp renamed to include/inexor/vulkan-renderer/tools/representation.hpp

@@ -4,7 +4,7 @@
 
 #include <string>
 
-namespace inexor::vulkan_renderer::vk_tools {
+namespace inexor::vulkan_renderer::tools {
 
 /// @brief This function returns a textual representation of the vulkan object T.
 template <typename T>
@@ -23,4 +23,4 @@ template <typename T>
 /// If you want to convert it into an std::string_view, see the matching ```as_string``` template
 [[nodiscard]] std::string_view result_to_description(VkResult result);
 
-} // namespace inexor::vulkan_renderer::vk_tools
+} // namespace inexor::vulkan_renderer::tools

include/inexor/vulkan-renderer/wrapper/command_buffer.hpp renamed to include/inexor/vulkan-renderer/wrapper/commands/command_buffer.hpp

@@ -1,17 +1,28 @@
 #pragma once
 
-#include "inexor/vulkan-renderer/wrapper/fence.hpp"
 #include "inexor/vulkan-renderer/wrapper/gpu_memory_buffer.hpp"
+#include "inexor/vulkan-renderer/wrapper/synchronization/fence.hpp"
 
 #include <cassert>
 #include <memory>
 #include <span>
 #include <vector>
 
 namespace inexor::vulkan_renderer::wrapper {
-
 // Forward declaration
 class Device;
+} // namespace inexor::vulkan_renderer::wrapper
+
+namespace inexor::vulkan_renderer::wrapper::synchronization {
+// Forward declaration
+class Fence;
+} // namespace inexor::vulkan_renderer::wrapper::synchronization
+
+namespace inexor::vulkan_renderer::wrapper::commands {
+
+// Using declarations
+using wrapper::Device;
+using wrapper::synchronization::Fence;
 
 /// @brief RAII wrapper class for VkCommandBuffer.
 /// @todo Make trivially copyable (this class doesn't really "own" the command buffer, more just an OOP wrapper).
@@ -364,4 +375,4 @@ class CommandBuffer {
     const CommandBuffer &submit_and_wait() const; // NOLINT
 };
 
-} // namespace inexor::vulkan_renderer::wrapper
+} // namespace inexor::vulkan_renderer::wrapper::commands

include/inexor/vulkan-renderer/wrapper/command_pool.hpp renamed to include/inexor/vulkan-renderer/wrapper/commands/command_pool.hpp

@@ -3,14 +3,16 @@
 #include <spdlog/spdlog.h>
 #include <volk.h>
 
-#include "inexor/vulkan-renderer/wrapper/command_buffer.hpp"
+#include "inexor/vulkan-renderer/wrapper/commands/command_buffer.hpp"
 
 #include <cassert>
 
 namespace inexor::vulkan_renderer::wrapper {
-
 // Forward declaration
 class Device;
+} // namespace inexor::vulkan_renderer::wrapper
+
+namespace inexor::vulkan_renderer::wrapper::commands {
 
 /// @brief RAII wrapper class for VkCommandPool.
 class CommandPool {
@@ -49,4 +51,4 @@ class CommandPool {
     [[nodiscard]] const CommandBuffer &request_command_buffer(const std::string &name);
 };
 
-} // namespace inexor::vulkan_renderer::wrapper
+} // namespace inexor::vulkan_renderer::wrapper::commands

include/inexor/vulkan-renderer/wrapper/device.hpp

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "inexor/vulkan-renderer/wrapper/command_pool.hpp"
+#include "inexor/vulkan-renderer/wrapper/commands/command_pool.hpp"
 
 #include <array>
 #include <functional>
@@ -13,6 +13,9 @@ namespace inexor::vulkan_renderer::wrapper {
 // Forward declaration
 class Instance;
 
+using wrapper::commands::CommandBuffer;
+using wrapper::commands::CommandPool;
+
 /// A wrapper struct for physical device data
 struct DeviceInfo {
     std::string name;