Refactor rendergraph

.clang-format

@@ -3,8 +3,10 @@ BasedOnStyle: LLVM
 AccessModifierOffset: -4
 AllowShortBlocksOnASingleLine: Empty
 AllowShortCaseLabelsOnASingleLine: false
+BinPackParameters: false
 AllowShortFunctionsOnASingleLine: Empty
 AllowShortIfStatementsOnASingleLine: Never
+AllowAllParametersOfDeclarationOnNextLine: false
 AllowShortLoopsOnASingleLine: false
 AlwaysBreakTemplateDeclarations: Yes
 ColumnLimit: 120

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.24)
+cmake_minimum_required(VERSION 4.0)
 project(inexor-vulkan-renderer CXX)
 
 # Stop in source builds
@@ -23,17 +23,15 @@ message(STATUS "CXX Compiler executable: ${CMAKE_CXX_COMPILER}")
 message(STATUS "Linker executable: ${CMAKE_LINKER}")
 message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
 
-# The marked constants in application.hpp will be replaced with the following values
 set(INEXOR_ENGINE_NAME "Inexor Engine")
-set(INEXOR_APP_NAME "Inexor Vulkan-renderer example")
-
 set(INEXOR_ENGINE_VERSION_MAJOR 0)
 set(INEXOR_ENGINE_VERSION_MINOR 1)
 set(INEXOR_ENGINE_VERSION_PATCH 0)
 
-set(INEXOR_APP_VERSION_MAJOR 0)
-set(INEXOR_APP_VERSION_MINOR 1)
-set(INEXOR_APP_VERSION_PATCH 0)
+# The version of Vulkan API that is used
+set(INEXOR_VULKAN_VERSION_MAJOR 1)
+set(INEXOR_VULKAN_VERSION_MINOR 3)
+set(INEXOR_VULKAN_VERSION_PATCH 0)
 
 # Download dependencies through CMake
 include (cmake/dependencies.cmake)
@@ -60,7 +58,7 @@ if(INEXOR_BUILD_DOC)
 endif()
 
 if(INEXOR_BUILD_EXAMPLE)
-    add_subdirectory(example)
+    add_subdirectory(example-app/src)
 endif()
 
 if(INEXOR_BUILD_TESTS)

cmake/dependencies.cmake

@@ -30,9 +30,10 @@ FetchContent_Declare(glfw
 
 FetchContent_Declare(glm
     GIT_REPOSITORY https://github.com/g-truc/glm.git
-    GIT_TAG 0.9.9.8
+    GIT_TAG 1.0.1
     GIT_SHALLOW ON
-    GIT_PROGRESS ON)
+    GIT_PROGRESS ON
+    FIND_PACKAGE_ARGS 1.0.1)
 
 FetchContent_Declare(gtest
     GIT_REPOSITORY https://github.com/google/googletest
@@ -62,16 +63,16 @@ FetchContent_Declare(stb
 
 FetchContent_Declare(tinygltf
     GIT_REPOSITORY https://github.com/syoyo/tinygltf.git
-    GIT_TAG v2.8.6
+    GIT_TAG v2.9.5
     GIT_PROGRESS ON
-    FIND_PACKAGE_ARGS 2.8.6)
+    FIND_PACKAGE_ARGS 2.9.5)
 
 FetchContent_Declare(toml
     GIT_REPOSITORY https://github.com/ToruNiina/toml11.git
-    GIT_TAG v3.7.1
+    GIT_TAG v4.4.0
     GIT_SHALLOW ON
     GIT_PROGRESS ON
-    FIND_PACKAGE_ARGS 3.7.1)
+    FIND_PACKAGE_ARGS 4.4.0)
 
 FetchContent_Declare(vma
     GIT_REPOSITORY https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git
@@ -81,9 +82,9 @@ FetchContent_Declare(vma
 
 FetchContent_Declare(volk
     GIT_REPOSITORY https://github.com/zeux/volk
-    GIT_TAG 1.3.215
+    GIT_TAG 1.4.304
     GIT_PROGRESS ON
-    FIND_PACKAGE_ARGS 1.3.215)
+    FIND_PACKAGE_ARGS 1.4.304)
 
 FetchContent_Declare(Vulkan
     GIT_REPOSITORY https://github.com/KhronosGroup/Vulkan-Headers

documentation/source/development/debugging/cla.rst

@@ -25,14 +25,6 @@ You can start vulkan-renderer with the following command line arguments:
 
 .. warning:: You should never disable validation layers because they offer extensive error checks for debugging.
 
-.. option:: --no-vk-debug-markers
-
-    Disables `Vulkan debug markers <https://www.saschawillems.de/blog/2016/05/28/tutorial-on-using-vulkans-vk_ext_debug_marker-with-renderdoc/>`__ (even if ``--renderdoc`` is specified).
-
-.. option:: --renderdoc
-
-    Enables the `RenderDoc <https://renderdoc.org/>`__ debug layer.
-
 .. option:: --vsync
 
 .. warning:: Vsync is currently not implemented. The command line argument will be ignored.

documentation/source/development/debugging/renderdoc.rst

@@ -2,99 +2,5 @@ RenderDoc
 =========
 
 - `RenderDoc <https://renderdoc.org/>`__ is a free and open source graphics debugger for Vulkan API (and other APIs) developed by `Baldur Karlsson <https://github.com/baldurk>`__.
-- It is a very powerful graphics debugging and visualization tool which makes debugging Vulkan application as easy as possible.
-- Inexor has full RenderDoc integration. This includes `internal resource naming using Vulkan debug markers <https://www.saschawillems.de/blog/2016/05/28/tutorial-on-using-vulkans-vk_ext_debug_marker-with-renderdoc/>`__.
-- The following tutorial shows how to debug Inexor using RenderDoc.
+- It is a very powerful graphics debugging and visualization tool which simplifies debugging Vulkan application a lot.
 - You can read up more details in `RenderDoc's documentation <https://renderdoc.org/docs/getting_started/quick_start.html>`__.
-
-RenderDoc Tutorial for Windows
-------------------------------
-
-Step 1: Open Inexor in Visual Studio and add a breakpoint before Vulkan initialization
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- The best spot would be right after ``main()``:
-
-.. image:: /development/debugging/images/renderdoc/VisualStudioBreakpoint.jpg
-    :width: 800
-    :alt: A breakpoint after the main function in Visual Studio debugger.
-
-Step 2: Open RenderDoc.
-^^^^^^^^^^^^^^^^^^^^^^^
-
-.. image:: /development/debugging/images/renderdoc/RenderDoc_step_1.jpg
-    :width: 800
-    :alt: RenderDoc right after starting it.
-
-Step 3: Start debugging inexor-vulkan-renderer and halt at the breakpoint
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. image:: /development/debugging/images/renderdoc/VisualStudioDebugging.jpg
-    :width: 800
-    :alt: Visual Studio interrupts the program because of a breakpoint.
-
-Step 4: "Inject into process" inexor-vulkan-renderer.exe using RenderDoc
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. image:: /development/debugging/images/renderdoc/RenderDoc_step_2.jpg
-    :width: 800
-    :alt: "Inject into process" in RenderDoc's menu.
-
-Step 5: Search for "inexor-vulkan-renderer.exe" and click "inject"
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- You will see a warning Windows Firewall the first time you do this.
-- This is because RenderDoc is reading memory from inexor-vulkan-renderer.
-- Accept the Windows Firewall warning to allow RenderDoc to read memory.
-
-.. image:: /development/debugging/images/renderdoc/RenderDoc_step_3.jpg
-    :width: 800
-    :alt: Injecting into inexor-vulkan-renderer.
-
-Step 6: Continue debugging in Visual Studio
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- RenderDoc should now look like this.
-
-.. image:: /development/debugging/images/renderdoc/RenderDoc_step_4.jpg
-    :width: 800
-    :alt: Injecting into inexor-vulkan-renderer.
-
-- Press ``F5`` to continue program execution from the breakpoint.
-- RenderDoc is now connected to inexor-vulkan-renderer:
-
-.. image:: /development/debugging/images/renderdoc/RenderDoc_step_5.jpg
-    :width: 800
-    :alt: RenderDoc is connected inexor-vulkan-renderer.
-
-- You can see RenderDoc's overlay in inexor-vulkan-renderer.exe:
-
-.. image:: /development/debugging/images/renderdoc/RenderDoc_step_6.jpg
-    :width: 800
-    :alt: Taking a RenderDoc snapshot. 
-
-Step 7: Debug inexor-vulkan-renderer.exe as usual and press F12 to take RenderDoc snapshots
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- You can take multiple snapshots with either ``PRINT`` or ``F12`` key.
-
-.. image:: /development/debugging/images/renderdoc/RenderDoc_step_7.jpg
-    :width: 800
-    :alt: Taking a RenderDoc snapshot. 
-
-- You can see the snapshots in RenderDoc right after you took them:
-
-.. image:: /development/debugging/images/renderdoc/RenderDoc_step_8.jpg
-    :width: 800
-    :alt: Taking a RenderDoc snapshot. 
-
-Step 8: Open a snapshot to analyze the rendering of this frame
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- Double click on a snapshot to open it:
-
-.. image:: /development/debugging/images/renderdoc/RenderDoc_step_9.jpg
-    :width: 800
-    :alt: Taking a RenderDoc snapshot. 
-
-- Have fun inspecting!

documentation/source/development/getting-started.rst

@@ -37,7 +37,7 @@ Optional Software
     Improve your build times with ninja.
 
 `RenderDoc <https://renderdoc.org/>`__
-    Powerful open source graphics debugger. Inexor has full RenderDoc integration.
+    A very powerful open source graphics debugger.
 
 `Doxygen <http://www.doxygen.nl/download.html>`__
     Required for generating the documentation.

documentation/source/development/reference/rendergraph.rst

@@ -0,0 +1,3 @@
+Rendergraph
+===========
+

example-app/include/example_app.hpp

@@ -0,0 +1,132 @@
+#pragma once
+
+#include "inexor/vulkan-renderer/input/keyboard_mouse_data.hpp"
+#include "inexor/vulkan-renderer/render-graph/render_graph.hpp"
+#include "inexor/vulkan-renderer/render-modules/imgui_renderer.hpp"
+#include "inexor/vulkan-renderer/render-modules/octree_renderer.hpp"
+#include "inexor/vulkan-renderer/tools/camera.hpp"
+#include "inexor/vulkan-renderer/tools/cla_parser.hpp"
+#include "inexor/vulkan-renderer/world/cube.hpp"
+#include "inexor/vulkan-renderer/wrapper/device.hpp"
+#include "inexor/vulkan-renderer/wrapper/instance.hpp"
+#include "inexor/vulkan-renderer/wrapper/pipelines/pipeline_cache.hpp"
+#include "inexor/vulkan-renderer/wrapper/surface.hpp"
+#include "inexor/vulkan-renderer/wrapper/swapchain.hpp"
+#include "inexor/vulkan-renderer/wrapper/window.hpp"
+
+#include <spdlog/spdlog.h>
+
+#include <chrono>
+
+namespace inexor::vulkan_renderer::example_app {
+
+// Using declarations
+using input::KeyboardMouseInputData;
+using render_graph::Buffer;
+using render_graph::BufferType;
+using render_graph::RenderGraph;
+using render_graph::TextureResource;
+using render_graph::TextureUsage;
+using render_modules::ImGuiRenderer;
+using render_modules::OctreeRenderer;
+using tools::Camera;
+using tools::CameraMovement;
+using tools::CameraType;
+using tools::CommandLineArgumentParser;
+using world::Cube;
+using wrapper::Device;
+using wrapper::Instance;
+using wrapper::Surface;
+using wrapper::Swapchain;
+using wrapper::Window;
+using wrapper::pipelines::PipelineCache;
+
+/// The command line arguments will be parsed into these options
+struct CommandLineOptions {
+    bool stop_on_validation_error{false};
+    bool vsync_enabled{true};
+    std::optional<std::uint32_t> preferred_gpu{std::nullopt};
+    // Add your option here...
+};
+
+/// An example app using Inexor vulkan-renderer engine
+class ExampleApp {
+private:
+    CommandLineOptions m_options;
+    std::unique_ptr<PipelineCache> m_pipeline_cache;
+    std::unique_ptr<Instance> m_instance;
+    std::unique_ptr<Window> m_window;
+    std::unique_ptr<Surface> m_surface;
+    std::unique_ptr<Device> m_device;
+    std::shared_ptr<Swapchain> m_swapchain;
+    std::shared_ptr<RenderGraph> m_rendergraph;
+
+    std::weak_ptr<TextureResource> m_back_buffer;
+    std::weak_ptr<TextureResource> m_depth_buffer;
+
+    std::vector<std::shared_ptr<Cube>> m_octrees;
+    std::unique_ptr<OctreeRenderer> m_octree_renderer;
+
+    std::unique_ptr<ImGuiRenderer> m_imgui_renderer;
+
+    float m_time_passed{0.0f};
+    std::shared_ptr<Camera> m_camera;
+    KeyboardMouseInputData m_input_data;
+
+    std::chrono::time_point<std::chrono::high_resolution_clock> m_duration{std::chrono::high_resolution_clock::now()};
+    std::chrono::time_point<std::chrono::high_resolution_clock> m_last_time{std::chrono::high_resolution_clock::now()};
+
+    void create_physical_device();
+    void create_window();
+    void initialize_spdlog();
+    void setup_octree_rendering();
+    void setup_render_graph();
+    void recreate_swapchain();
+    void render_frame();
+    void update_time();
+
+    /// Because GLFW is a C-style API, we can't use a pointer to non-static class methods as window or input callback.
+    /// A good explanation can be found on Stack Overflow:
+    /// https://stackoverflow.com/questions/7676971/pointing-to-a-function-that-is-a-class-member-glfw-setkeycallback
+    /// In order to fix this, we can pass a lambda to glfwSetKeyCallback, which calls our callbacks internally. There is
+    /// another problem: Inside of the lambda, we need to call the member function. In order to do so, we need to have
+    /// access to the this-pointer. Unfortunately, the this-pointer can't be captured in the lambda capture like
+    /// [this](){}, because the glfw would not accept the lambda then. To fix this problem, we store the this pointer
+    /// using glfwSetWindowUserPointer. Inside of these lambdas, we then cast the pointer to Application* again,
+    /// allowing us to finally use the callbacks.
+    void setup_window_input_callbacks();
+
+    /// A swap function for move assignment constructor and move assignment operator
+    /// @param other A reference to the other instance of ExampleApp to swap with
+    void swap(ExampleApp &other);
+
+    /// The callback for validation messages (VK_EXT_debug_utils)
+    /// @param severity The severity of the message (info, warning, error)
+    /// @param type The type of message (validation, performance)
+    /// @param data Additional data related to the message
+    /// @param user_data Additional user-defined data related to the message
+    /// @return This will always return ``VK_FALSE``, meaning the app will continue to run
+    static VkBool32 validation_layer_debug_messenger_callback(VkDebugUtilsMessageSeverityFlagBitsEXT severity,
+                                                              VkDebugUtilsMessageTypeFlagsEXT type,
+                                                              const VkDebugUtilsMessengerCallbackDataEXT *data,
+                                                              void *user_data);
+
+public:
+    /// Default constructor
+    /// @param argc The number of arguments passed to the main function
+    /// @param argv The arguments passed to the main function
+    ExampleApp(int argc, char *argv[]);
+
+    void cursor_position_callback(GLFWwindow *, double, double);
+    void keyboard_button_callback(GLFWwindow *, int, int, int, int);
+    void mouse_button_callback(GLFWwindow *, int, int, int);
+    void mouse_scroll_callback(GLFWwindow *, double, double);
+    void parse_command_line_arguments(int argc, char *argv[]);
+    void process_mouse_input();
+    void process_keyboard_input();
+    void run();
+    void update_imgui();
+    void check_octree_collisions();
+};
+
+} // namespace inexor::vulkan_renderer::example_app

example-app/include/example_app_meta.hpp

@@ -0,0 +1,21 @@
+#pragma once
+
+#include <array>
+
+#define MAKE_API_VERSION(major, minor, patch) \
+    ((((uint32_t)(major)) << 22U) | (((uint32_t)(minor)) << 12U) | ((uint32_t)(patch)))
+
+namespace inexor::vulkan_renderer::example_app {
+
+/// The following data will be filled when CMake configures this file
+constexpr const char *APP_NAME{"Example-app"};
+constexpr std::uint32_t APP_VERSION{MAKE_API_VERSION(0, 1, 0)};
+constexpr const char *APP_VERSION_STR{"0.1.0"};
+constexpr const char* ENGINE_NAME{"Inexor Engine"};
+constexpr std::uint32_t ENGINE_VERSION{MAKE_API_VERSION(0, 1, 0)};
+constexpr std::uint32_t USED_VULKAN_API_VERSION{MAKE_API_VERSION(1, 3, 0)};
+constexpr const char *ENGINE_VERSION_STR{"0.1.0"};
+constexpr const char *BUILD_GIT = "c96fcc1";
+constexpr const char *BUILD_TYPE = "Release";
+
+} // namespace inexor::vulkan_renderer::example_app

example-app/include/example_app_meta.hpp.in

@@ -0,0 +1,21 @@
+#pragma once
+
+#include <array>
+
+#define MAKE_API_VERSION(major, minor, patch) \
+    ((((uint32_t)(major)) << 22U) | (((uint32_t)(minor)) << 12U) | ((uint32_t)(patch)))
+
+namespace inexor::vulkan_renderer::example_app {
+
+/// The following data will be filled when CMake configures this file
+constexpr const char *APP_NAME{"${INEXOR_EXAMPLE_APP_NAME}"};
+constexpr std::uint32_t APP_VERSION{MAKE_API_VERSION(${INEXOR_EXAMPLE_APP_VERSION_MAJOR}, ${INEXOR_EXAMPLE_APP_VERSION_MINOR}, ${INEXOR_EXAMPLE_APP_VERSION_PATCH})};
+constexpr const char *APP_VERSION_STR{"${INEXOR_EXAMPLE_APP_VERSION_MAJOR}.${INEXOR_EXAMPLE_APP_VERSION_MINOR}.${INEXOR_EXAMPLE_APP_VERSION_PATCH}"};
+constexpr const char* ENGINE_NAME{"${INEXOR_ENGINE_NAME}"};
+constexpr std::uint32_t ENGINE_VERSION{MAKE_API_VERSION(${INEXOR_ENGINE_VERSION_MAJOR}, ${INEXOR_ENGINE_VERSION_MINOR}, ${INEXOR_ENGINE_VERSION_PATCH})};
+constexpr std::uint32_t USED_VULKAN_API_VERSION{MAKE_API_VERSION(${INEXOR_VULKAN_VERSION_MAJOR}, ${INEXOR_VULKAN_VERSION_MINOR}, ${INEXOR_VULKAN_VERSION_PATCH})};
+constexpr const char *ENGINE_VERSION_STR{"${INEXOR_ENGINE_VERSION_MAJOR}.${INEXOR_ENGINE_VERSION_MINOR}.${INEXOR_ENGINE_VERSION_PATCH}"};
+constexpr const char *BUILD_GIT = "${INEXOR_GIT_SHA}";
+constexpr const char *BUILD_TYPE = "${CMAKE_BUILD_TYPE}";
+
+} // namespace inexor::vulkan_renderer::example_app