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

Hanni/cleanup

Author: IAmNotHanni

benchmarks/CMakeLists.txt

@@ -34,3 +34,22 @@ target_link_libraries(
     PUBLIC
     benchmark::benchmark
 )
+
+if(MSVC)
+    # Group dependencies in Visual Studio
+    set(THIRD_PARTY_TARGETS
+        benchmark
+        benchmark_main
+        # Note that benchmark requires gtest
+        gmock
+        gmock_main
+        gtest
+        gtest_main
+    )
+    # Move all dependencies into a subfolder
+    set_target_properties(${THIRD_PARTY_TARGETS}
+        PROPERTIES
+            EXCLUDE_FROM_ALL TRUE
+            FOLDER "Dependencies"
+    )
+endif()

benchmarks/engine_benchmark_main.cpp

@@ -1,11 +1,11 @@
 #include <benchmark/benchmark.h>
 
-#include "inexor/vulkan-renderer/meta.hpp"
+#include "inexor/vulkan-renderer/meta/meta.hpp"
 
 #include <iostream>
 
 int main(int argc, char **argv) {
-    using namespace inexor::vulkan_renderer;
+    using namespace inexor::vulkan_renderer::meta;
 
     // Print engine and application metadata.
     std::cout << ENGINE_NAME << ", version " << ENGINE_VERSION_STR << std::endl;

include/inexor/vulkan-renderer/imgui.hpp

@@ -1,7 +1,7 @@
 #pragma once
 
 #include "inexor/vulkan-renderer/render_graph.hpp"
-#include "inexor/vulkan-renderer/wrapper/descriptor.hpp"
+#include "inexor/vulkan-renderer/wrapper/descriptors/descriptor.hpp"
 #include "inexor/vulkan-renderer/wrapper/gpu_texture.hpp"
 #include "inexor/vulkan-renderer/wrapper/shader.hpp"
 
@@ -32,7 +32,7 @@ class ImGUIOverlay {
     std::unique_ptr<wrapper::GpuTexture> m_imgui_texture;
     std::unique_ptr<wrapper::Shader> m_vertex_shader;
     std::unique_ptr<wrapper::Shader> m_fragment_shader;
-    std::unique_ptr<wrapper::ResourceDescriptor> m_descriptor;
+    std::unique_ptr<wrapper::descriptors::ResourceDescriptor> m_descriptor;
     std::vector<std::uint32_t> m_index_data;
     std::vector<ImDrawVert> m_vertex_data;
 

include/inexor/vulkan-renderer/meta.hpp.in renamed to include/inexor/vulkan-renderer/meta/meta.hpp.in

@@ -2,7 +2,7 @@
 
 #include <array>
 
-namespace inexor::vulkan_renderer {
+namespace inexor::vulkan_renderer::meta {
 
 /// The following data will be replaced by CMake setup.
 constexpr const char *APP_NAME{"${INEXOR_APP_NAME}"};

include/inexor/vulkan-renderer/renderer.hpp

@@ -1,10 +1,10 @@
 #pragma once
 
-#include "inexor/vulkan-renderer/camera.hpp"
 #include "inexor/vulkan-renderer/fps_counter.hpp"
 #include "inexor/vulkan-renderer/imgui.hpp"
 #include "inexor/vulkan-renderer/octree_gpu_vertex.hpp"
 #include "inexor/vulkan-renderer/time_step.hpp"
+#include "inexor/vulkan-renderer/tools/camera.hpp"
 #include "inexor/vulkan-renderer/wrapper/instance.hpp"
 #include "inexor/vulkan-renderer/wrapper/uniform_buffer.hpp"
 #include "inexor/vulkan-renderer/wrapper/window/surface.hpp"
@@ -35,7 +35,7 @@ class VulkanRenderer {
 
     bool m_vsync_enabled{false};
 
-    std::unique_ptr<Camera> m_camera;
+    std::unique_ptr<tools::Camera> m_camera;
 
     std::unique_ptr<Window> m_window;
     std::unique_ptr<wrapper::Instance> m_instance;
@@ -48,7 +48,7 @@ class VulkanRenderer {
     std::vector<wrapper::Shader> m_shaders;
     std::vector<wrapper::GpuTexture> m_textures;
     std::vector<wrapper::UniformBuffer> m_uniform_buffers;
-    std::vector<wrapper::ResourceDescriptor> m_descriptors;
+    std::vector<wrapper::descriptors::ResourceDescriptor> m_descriptors;
     std::vector<OctreeGpuVertex> m_octree_vertices;
     std::vector<std::uint32_t> m_octree_indices;
 

include/inexor/vulkan-renderer/camera.hpp renamed to include/inexor/vulkan-renderer/tools/camera.hpp

@@ -7,7 +7,7 @@
 #include <array>
 #include <vector>
 
-namespace inexor::vulkan_renderer {
+namespace inexor::vulkan_renderer::tools {
 
 namespace directions {
 /// The default value of the camera's front vector.
@@ -225,4 +225,4 @@ class Camera {
         return m_perspective_matrix;
     }
 };
-} // namespace inexor::vulkan_renderer
+} // namespace inexor::vulkan_renderer::tools

include/inexor/vulkan-renderer/wrapper/descriptor.hpp renamed to include/inexor/vulkan-renderer/wrapper/descriptors/descriptor.hpp

@@ -6,9 +6,11 @@
 #include <vector>
 
 namespace inexor::vulkan_renderer::wrapper {
-
 // Forward declaration
 class Device;
+} // namespace inexor::vulkan_renderer::wrapper
+
+namespace inexor::vulkan_renderer::wrapper::descriptors {
 
 /// @brief RAII wrapper class for resource descriptors.
 class ResourceDescriptor {
@@ -49,4 +51,4 @@ class ResourceDescriptor {
     }
 };
 
-} // namespace inexor::vulkan_renderer::wrapper
+} // namespace inexor::vulkan_renderer::wrapper::descriptors

include/inexor/vulkan-renderer/wrapper/descriptor_builder.hpp renamed to include/inexor/vulkan-renderer/wrapper/descriptors/descriptor_builder.hpp

@@ -10,9 +10,12 @@
 #include <vector>
 
 namespace inexor::vulkan_renderer::wrapper {
-
-// Forward declarations
+// Forward declaration
 class Device;
+} // namespace inexor::vulkan_renderer::wrapper
+
+namespace inexor::vulkan_renderer::wrapper::descriptors {
+
 class ResourceDescriptor;
 
 class DescriptorBuilder {
@@ -96,4 +99,4 @@ DescriptorBuilder &DescriptorBuilder::add_uniform_buffer(const VkBuffer uniform_
     return *this;
 }
 
-} // namespace inexor::vulkan_renderer::wrapper
+} // namespace inexor::vulkan_renderer::wrapper::descriptors

src/CMakeLists.txt

@@ -1,6 +1,5 @@
 set(INEXOR_SOURCE_FILES
     vulkan-renderer/application.cpp
-    vulkan-renderer/camera.cpp
     vulkan-renderer/exception.cpp
     vulkan-renderer/fps_counter.cpp
     vulkan-renderer/imgui.cpp
@@ -15,15 +14,14 @@ set(INEXOR_SOURCE_FILES
     vulkan-renderer/io/byte_stream.cpp
     vulkan-renderer/io/nxoc_parser.cpp
 
+    vulkan-renderer/tools/camera.cpp
     vulkan-renderer/tools/cla_parser.cpp
     vulkan-renderer/tools/device_info.cpp
     vulkan-renderer/tools/enumerate.cpp
     vulkan-renderer/tools/file.cpp
     vulkan-renderer/tools/representation.cpp
 
     vulkan-renderer/wrapper/cpu_texture.cpp
-    vulkan-renderer/wrapper/descriptor.cpp
-    vulkan-renderer/wrapper/descriptor_builder.cpp
     vulkan-renderer/wrapper/device.cpp
     vulkan-renderer/wrapper/framebuffer.cpp
     vulkan-renderer/wrapper/gpu_memory_buffer.cpp
@@ -38,6 +36,9 @@ set(INEXOR_SOURCE_FILES
     vulkan-renderer/wrapper/commands/command_buffer.cpp
     vulkan-renderer/wrapper/commands/command_pool.cpp
 
+    vulkan-renderer/wrapper/descriptors/descriptor.cpp
+    vulkan-renderer/wrapper/descriptors/descriptor_builder.cpp
+
     vulkan-renderer/wrapper/window/window.cpp
     vulkan-renderer/wrapper/window/surface.cpp
 
@@ -100,8 +101,8 @@ endif()
 
 # Replace variables in header file with CMake values
 configure_file(
-    ${PROJECT_SOURCE_DIR}/include/inexor/vulkan-renderer/meta.hpp.in
-    ${CMAKE_CURRENT_BINARY_DIR}/include/inexor/vulkan-renderer/meta.hpp
+    ${PROJECT_SOURCE_DIR}/include/inexor/vulkan-renderer/meta/meta.hpp.in
+    ${CMAKE_CURRENT_BINARY_DIR}/include/inexor/vulkan-renderer/meta/meta.hpp
 )
 
 target_include_directories(
@@ -144,3 +145,32 @@ target_link_libraries(inexor-vulkan-renderer
     volk::volk
     Vulkan::Headers
     VulkanMemoryAllocator)
+
+if(MSVC)
+    # Group dependencies in Visual Studio
+    set(THIRD_PARTY_TARGETS
+        glfw
+        fmt
+        glm
+        imgui
+        spdlog
+        volk
+        VulkanMemoryAllocator
+        tinygltf
+        toml11
+        # Also those extra ones
+        loader_example
+        uninstall
+        update_mappings
+        Continuous
+        Experimental
+        Nightly
+        NightlyMemoryCheck
+    )
+    # Move all dependencies into a subfolder
+    set_target_properties(${THIRD_PARTY_TARGETS}
+        PROPERTIES
+            EXCLUDE_FROM_ALL TRUE
+            FOLDER "Dependencies"
+    )
+endif()

src/vulkan-renderer/application.cpp

@@ -1,15 +1,15 @@
 #include "inexor/vulkan-renderer/application.hpp"
 
-#include "inexor/vulkan-renderer/camera.hpp"
 #include "inexor/vulkan-renderer/exception.hpp"
-#include "inexor/vulkan-renderer/meta.hpp"
+#include "inexor/vulkan-renderer/meta/meta.hpp"
 #include "inexor/vulkan-renderer/octree_gpu_vertex.hpp"
 #include "inexor/vulkan-renderer/standard_ubo.hpp"
+#include "inexor/vulkan-renderer/tools/camera.hpp"
 #include "inexor/vulkan-renderer/tools/cla_parser.hpp"
 #include "inexor/vulkan-renderer/tools/enumerate.hpp"
 #include "inexor/vulkan-renderer/world/collision.hpp"
 #include "inexor/vulkan-renderer/wrapper/cpu_texture.hpp"
-#include "inexor/vulkan-renderer/wrapper/descriptor_builder.hpp"
+#include "inexor/vulkan-renderer/wrapper/descriptors/descriptor_builder.hpp"
 #include "inexor/vulkan-renderer/wrapper/instance.hpp"
 
 #include <GLFW/glfw3.h>
@@ -286,7 +286,7 @@ void Application::initialize_spdlog() {
     auto console_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
 
     // A copy of the console output will automatically be saved to a logfile
-    auto file_sink = std::make_shared<spdlog::sinks::basic_file_sink_mt>(std::string(APP_NAME) + ".log", true);
+    auto file_sink = std::make_shared<spdlog::sinks::basic_file_sink_mt>(std::string(meta::APP_NAME) + ".log", true);
     auto logger = std::make_shared<spdlog::async_logger>("main", spdlog::sinks_init_list{console_sink, file_sink},
                                                          spdlog::thread_pool(), spdlog::async_overflow_policy::block);
 
@@ -303,6 +303,8 @@ void Application::initialize_spdlog() {
 Application::Application(int argc, char **argv) {
     initialize_spdlog();
 
+    using namespace vulkan_renderer::meta;
+
     spdlog::trace("Application version: {}.{}.{}", APP_VERSION[0], APP_VERSION[1], APP_VERSION[2]);
     spdlog::trace("Engine version: {}.{}.{}", ENGINE_VERSION[0], ENGINE_VERSION[1], ENGINE_VERSION[2]);
 
@@ -451,7 +453,7 @@ Application::Application(int argc, char **argv) {
 
     // Create an instance of the resource descriptor builder.
     // This allows us to make resource descriptors with the help of a builder pattern.
-    wrapper::DescriptorBuilder descriptor_builder(*m_device);
+    wrapper::descriptors::DescriptorBuilder descriptor_builder(*m_device);
 
     // Make use of the builder to create a resource descriptor for the uniform buffer.
     m_descriptors.emplace_back(
@@ -492,7 +494,8 @@ void Application::update_imgui_overlay() {
     ImGui::PushStyleVar(ImGuiStyleVar_WindowRounding, 0);
     ImGui::SetNextWindowPos(ImVec2(10, 10));
     ImGui::SetNextWindowSize(ImVec2(330, 0));
-    ImGui::Begin("Inexor Vulkan-renderer", nullptr,
+    using namespace vulkan_renderer::meta;
+    ImGui::Begin(APP_NAME, 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],
@@ -526,6 +529,8 @@ void Application::process_input() {
 
     auto deadzone_lambda = [](const float state) { return (glm::abs(state) < 0.2f) ? 0.0f : state; };
 
+    using namespace tools;
+
     if (m_camera->type() == CameraType::LOOK_AT &&
         m_input->kbm_data().is_mouse_button_pressed(GLFW_MOUSE_BUTTON_LEFT)) {
         m_camera->rotate(static_cast<float>(cursor_pos_delta[0]), -static_cast<float>(cursor_pos_delta[1]));