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

@@ -60,7 +60,7 @@ if(INEXOR_BUILD_DOC)
 endif()
 
 if(INEXOR_BUILD_EXAMPLE)
-    add_subdirectory(example)
+    add_subdirectory(example-app/src)
 endif()
 
 if(INEXOR_BUILD_TESTS)

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.

example-app/include/example_app.hpp

@@ -0,0 +1,47 @@
+#pragma once
+
+#include "../include/example_app_base.hpp"
+
+#include "inexor/vulkan-renderer/rendering/imgui/imgui.hpp"
+#include "inexor/vulkan-renderer/rendering/octree/octree_renderer.hpp"
+
+#include <spdlog/spdlog.h>
+
+namespace inexor::example_app {
+
+/// An example application using Inexor vulkan-renderer
+class ExampleApp : public ExampleAppBase {
+private:
+    std::unique_ptr<ImGuiRenderer> m_imgui_renderer;
+    std::unique_ptr<OctreeRenderer> m_octree_renderer;
+
+public:
+    ExampleApp(int argc, char **argv);
+    ~ExampleApp();
+
+    ExampleApp(const ExampleApp &) = delete;
+    // TODO: Implement me!
+    ExampleApp(ExampleApp &&) noexcept;
+
+    ExampleApp &operator=(const ExampleApp &) = delete;
+    // TODO: Implement me!
+    ExampleApp &operator=(ExampleApp &&) noexcept;
+
+    void initialize() override;
+
+    void load_toml_configuration_file(const std::string &file_name);
+
+    void setup_render_graph() override;
+
+    void cursor_position_callback(GLFWwindow *window, double x_pos, double y_pos) override;
+
+    void keyboard_button_callback(GLFWwindow *window, int key, int scancode, int action, int mods) override;
+
+    void mouse_button_callback(GLFWwindow *window, int button, int action, int mods) override;
+
+    void mouse_scroll_callback(GLFWwindow *window, double x_offset, double y_offset) override;
+
+    void update_imgui() override;
+};
+
+} // namespace inexor::example_app

example-app/include/example_app_base.hpp

@@ -0,0 +1,102 @@
+#pragma once
+
+#include "inexor/vulkan-renderer/input/keyboard_mouse_data.hpp"
+#include "inexor/vulkan-renderer/rendering/render-graph/render_graph.hpp"
+#include "inexor/vulkan-renderer/tools/cla_parser.hpp"
+#include "inexor/vulkan-renderer/wrapper/device.hpp"
+#include "inexor/vulkan-renderer/wrapper/instance.hpp"
+#include "inexor/vulkan-renderer/wrapper/surface.hpp"
+#include "inexor/vulkan-renderer/wrapper/swapchain.hpp"
+#include "inexor/vulkan-renderer/wrapper/window.hpp"
+
+#include <memory>
+#include <string>
+
+namespace inexor::example_app {
+
+// Using declarations
+using inexor::vulkan_renderer::input::KeyboardMouseInputData;
+using inexor::vulkan_renderer::render_graph::RenderGraph;
+using inexor::vulkan_renderer::tools::CommandLineArgumentParser;
+using inexor::vulkan_renderer::wrapper::Device;
+using inexor::vulkan_renderer::wrapper::Instance;
+using inexor::vulkan_renderer::wrapper::Surface;
+using inexor::vulkan_renderer::wrapper::Swapchain;
+using inexor::vulkan_renderer::wrapper::Window;
+
+/// The command line arguments will be parsed into these options
+struct CommandLineOptions {
+    bool stop_on_validation_error{false};
+    bool vsync_enabled{false};
+};
+
+/// A base class for example apps which use Inexor vulkan-renderer
+class ExampleAppBase {
+private:
+    const std::string m_wnd_title = "inexor-vulkan-renderer-example";
+    std::uint32_t m_wnd_width{1280};
+    std::uint32_t m_wnd_height{720};
+    Window::Mode m_wnd_mode{Window::Mode::WINDOWED};
+    bool m_wnd_resized{false};
+
+    std::unique_ptr<Window> m_window;
+    std::unique_ptr<Instance> m_instance;
+    std::unique_ptr<Surface> m_surface;
+    std::unique_ptr<Device> m_device;
+    std::shared_ptr<Swapchain> m_swapchain;
+    std::unique_ptr<KeyboardMouseInputData> m_input_data;
+
+    void initialize_spdlog();
+
+    void recreate_swapchain();
+
+    /// 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_and_input_callbacks();
+
+protected:
+    CommandLineOptions m_options;
+
+    VKAPI_ATTR VkBool32 VKAPI_CALL
+    validation_layer_debug_messenger_callback(VkDebugUtilsMessageSeverityFlagBitsEXT,
+                                              VkDebugUtilsMessageTypeFlagsEXT,
+                                              const VkDebugUtilsMessengerCallbackDataEXT *,
+                                              void *);
+
+    std::shared_ptr<RenderGraph> m_rendergraph;
+
+public:
+    ExampleAppBase(int argc, char **argv);
+    virtual ~ExampleAppBase();
+
+    ExampleAppBase(const ExampleAppBase &) = delete;
+    // TODO: Implement me!
+    ExampleAppBase(ExampleAppBase &&) noexcept;
+
+    ExampleAppBase &operator=(const ExampleAppBase &) = delete;
+    // TODO: Implement me!
+    ExampleAppBase &operator=(ExampleAppBase &&) noexcept;
+
+    virtual void evaluate_command_line_arguments(const CommandLineArgumentParser &parser) = 0;
+    virtual void cursor_position_callback(GLFWwindow *, double, double) = 0;
+    virtual void keyboard_button_callback(GLFWwindow *, int, int, int, int) = 0;
+    virtual void mouse_button_callback(GLFWwindow *, int, int, int) = 0;
+    virtual void mouse_scroll_callback(GLFWwindow *, double, double) = 0;
+    virtual void initialize() = 0;
+    virtual void process_mouse_input() = 0;
+    virtual void process_keyboard_input() = 0;
+    virtual void render_frame() = 0;
+    virtual void setup_device() = 0;
+    virtual void setup_render_graph() = 0;
+    virtual void shutdown() = 0;
+    virtual void update_imgui() = 0;
+};
+
+} // namespace inexor::example_app

example/CMakeLists.txt → example-app/src/CMakeLists.txt

@@ -1,4 +1,22 @@
-add_executable(inexor-vulkan-renderer-example main.cpp)
+set(INEXOR_EXAMPLE_APP_SOURCE_FILES
+    example_app_base.cpp
+    example_app.cpp)
+
+foreach(FILE ${INEXOR_EXAMPLE_APP_SOURCE_FILES})
+    get_filename_component(PARENT_DIR "${FILE}" PATH)
+
+    string(REPLACE "/" "\\" GROUP "${PARENT_DIR}")
+
+    if("${FILE}" MATCHES ".*\\.cpp")
+        set(GROUP "Source Files\\${GROUP}")
+    elseif("${FILE}" MATCHES ".*\\.hpp")
+        set(GROUP "Header Files\\${GROUP}")
+    endif()
+
+    source_group("${GROUP}" FILES "${FILE}")
+endforeach()
+
+add_executable(inexor-vulkan-renderer-example ${INEXOR_EXAMPLE_APP_SOURCE_FILES})
 
 target_compile_features(inexor-vulkan-renderer-example PRIVATE cxx_std_20)
 target_link_libraries(inexor-vulkan-renderer-example PRIVATE inexor-vulkan-renderer)

example-app/src/example_app.cpp

@@ -0,0 +1,66 @@
+#include "../include/example_app.hpp"
+
+#include <toml.hpp>
+
+#include <memory>
+
+namespace inexor::example_app {
+
+ExampleApp::ExampleApp(int argc, char **argv) : ExampleAppBase(argc, argv) {}
+
+ExampleApp::~ExampleApp() {}
+
+void ExampleApp::initialize() {
+    //
+}
+
+void ExampleApp::setup_render_graph() {
+    spdlog::trace("Setting up rendergraph");
+    m_octree_renderer = std::make_unique<OctreeRenderer>(m_rendergraph);
+    m_imgui_renderer = std::make_unique<ImGuiRenderer>(m_rendergraph);
+}
+
+void ExampleApp::update_imgui() {
+    ImGuiIO &io = ImGui::GetIO();
+    io.DeltaTime = m_time_passed + 0.00001f;
+    auto cursor_pos = m_input_data->get_cursor_pos();
+    io.MousePos = ImVec2(static_cast<float>(cursor_pos[0]), static_cast<float>(cursor_pos[1]));
+    io.MouseDown[0] = m_input_data->is_mouse_button_pressed(GLFW_MOUSE_BUTTON_LEFT);
+    io.MouseDown[1] = m_input_data->is_mouse_button_pressed(GLFW_MOUSE_BUTTON_RIGHT);
+    io.DisplaySize =
+        ImVec2(static_cast<float>(m_swapchain->extent().width), static_cast<float>(m_swapchain->extent().height));
+
+    ImGui::NewFrame();
+    ImGui::PushStyleVar(ImGuiStyleVar_WindowRounding, 0);
+    ImGui::SetNextWindowPos(ImVec2(10, 10));
+    ImGui::SetNextWindowSize(ImVec2(330, 0));
+    ImGui::Begin("Inexor Vulkan-renderer", nullptr,
+                 ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove);
+    ImGui::Text("%s", m_device->gpu_name().c_str());
+    ImGui::Text("Engine version %d.%d.%d (Git sha %s)", ENGINE_VERSION[0], ENGINE_VERSION[1], ENGINE_VERSION[2],
+                BUILD_GIT);
+    ImGui::Text("Vulkan API %d.%d.%d", VK_API_VERSION_MAJOR(wrapper::Instance::REQUIRED_VK_API_VERSION),
+                VK_API_VERSION_MINOR(wrapper::Instance::REQUIRED_VK_API_VERSION),
+                VK_API_VERSION_PATCH(wrapper::Instance::REQUIRED_VK_API_VERSION));
+    const auto &cam_pos = m_camera->position();
+    ImGui::Text("Camera position (%.2f, %.2f, %.2f)", cam_pos.x, cam_pos.y, cam_pos.z);
+    const auto &cam_rot = m_camera->rotation();
+    ImGui::Text("Camera rotation: (%.2f, %.2f, %.2f)", cam_rot.x, cam_rot.y, cam_rot.z);
+    const auto &cam_front = m_camera->front();
+    ImGui::Text("Camera vector front: (%.2f, %.2f, %.2f)", cam_front.x, cam_front.y, cam_front.z);
+    const auto &cam_right = m_camera->right();
+    ImGui::Text("Camera vector right: (%.2f, %.2f, %.2f)", cam_right.x, cam_right.y, cam_right.z);
+    const auto &cam_up = m_camera->up();
+    ImGui::Text("Camera vector up (%.2f, %.2f, %.2f)", cam_up.x, cam_up.y, cam_up.z);
+    ImGui::Text("Yaw: %.2f pitch: %.2f roll: %.2f", m_camera->yaw(), m_camera->pitch(), m_camera->roll());
+    const auto cam_fov = m_camera->fov();
+    ImGui::Text("Field of view: %d", static_cast<std::uint32_t>(cam_fov));
+    ImGui::PushItemWidth(150.0f);
+    ImGui::PopItemWidth();
+    ImGui::PopStyleVar();
+    ImGui::End();
+    ImGui::EndFrame();
+    ImGui::Render();
+}
+
+} // namespace inexor::example_app