Custom thread pool, static GPU & CPU memory allocations

.github/workflows/ci.yml

@@ -27,4 +27,4 @@ jobs:
       run: cmake --build ${{github.workspace}}/build --config debug
 
     - name: Build-Release
-      run: cmake --build ${{github.workspace}}/build --config release
+      run: cmake --build ${{github.workspace}}/build --config release

.gitignore

@@ -1,6 +1,11 @@
-external/DirectXAgilitySDK
-external/DirectXShaderCompiler
+external/agility-sdk
+external/dxc
 agility.zip
 dxc.zip
 build/
 .vs/
+*.sln
+*.vcxproj
+*.filters
+*.user
+vcpkg_installed

CMakeLists.txt

@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.24)
 set(CMAKE_CXX_STANDARD 20)
 
 project(voxel-engine 
-        VERSION 0.1 
+        VERSION 0.2 
         DESCRIPTION "A voxel engine made for learning purposes"
         LANGUAGES CXX)
 
@@ -13,10 +13,13 @@ set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_DEBUG ${CMAKE_BINARY_DIR}/debug/bin)
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_DEBUG ${CMAKE_BINARY_DIR}/debug/bin)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG ${CMAKE_BINARY_DIR}/debug/bin)
 
-
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR}/release/bin)
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR}/release/bin)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR}/release/bin)
 
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELWITHDEBINFO ${CMAKE_BINARY_DIR}/release/bin)
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELWITHDEBINFO ${CMAKE_BINARY_DIR}/release/bin)
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELWITHDEBINFO ${CMAKE_BINARY_DIR}/release/bin)
+
 add_subdirectory(external)
-add_subdirectory(src)
+add_subdirectory(src)

CMakeSettings.json

@@ -1,26 +1,26 @@
-{
-  "configurations": [
-    {
-      "name": "debug",
-      "generator": "Ninja",
-      "configurationType": "Debug",
-      "inheritEnvironments": [ "msvc_x64_x64" ],
-      "buildRoot": "${projectDir}\\build",
-      "installRoot": "${projectDir}\\out\\install\\${name}",
-      "cmakeCommandArgs": "",
-      "buildCommandArgs": "",
-      "ctestCommandArgs": ""
-    },
-    {
-      "name": "release",
-      "generator": "Ninja",
-      "configurationType": "Release",
-      "inheritEnvironments": [ "msvc_x64_x64" ],
-      "buildRoot": "${projectDir}\\build",
-      "installRoot": "${projectDir}\\out\\install\\${name}",
-      "cmakeCommandArgs": "",
-      "buildCommandArgs": "",
-      "ctestCommandArgs": ""
-    }
-  ]
+{
+	"configurations": [
+		{
+			"name": "debug",
+			"generator": "Ninja",
+			"configurationType": "Debug",
+			"inheritEnvironments": [ "msvc_x64_x64" ],
+			"buildRoot": "${projectDir}\\build",
+			"installRoot": "${projectDir}\\out\\install\\${name}",
+			"cmakeCommandArgs": "",
+			"buildCommandArgs": "",
+			"ctestCommandArgs": ""
+		},
+		{
+			"name": "release",
+			"generator": "Ninja",
+			"configurationType": "RelWithDebInfo",
+			"inheritEnvironments": [ "msvc_x64_x64" ],
+			"buildRoot": "${projectDir}\\build",
+			"installRoot": "${projectDir}\\out\\install\\${name}",
+			"cmakeCommandArgs": "",
+			"buildCommandArgs": "",
+			"ctestCommandArgs": ""
+		}
+	]
 }

external/CMakeLists.txt

@@ -3,17 +3,35 @@ include(FetchContent)
 FetchContent_Declare(
     imgui
     GIT_REPOSITORY https://github.com/ocornut/imgui
-    GIT_TAG v1.90.9
+    GIT_TAG v1.91.9
     GIT_PROGRESS TRUE
+    GIT_SHALLOW TRUE
 )
 
+# Thank you deccer for https://github.com/deccer/CMake-Glfw-OpenGL-Template/blob/main/lib/CMakeLists.txt!!
 FetchContent_Declare(
-    thread-pool
-    GIT_REPOSITORY https://github.com/bshoshany/thread-pool
-    GIT_PROGRESS TRUE
+    tracy
+    GIT_REPOSITORY  https://github.com/wolfpld/tracy.git
+    GIT_TAG         v0.11.1
+    GIT_SHALLOW     TRUE
+    GIT_PROGRESS    TRUE
 )
 
-FetchContent_MakeAvailable(imgui thread-pool)
+FetchContent_Declare(
+    fastnoise2
+    GIT_REPOSITORY  https://github.com/Auburn/FastNoise2
+    GIT_TAG         v0.10.0-alpha
+    GIT_SHALLOW     FALSE 
+    GIT_PROGRESS    TRUE
+)
+
+set(TRACY_ENABLE ON CACHE BOOL "Enable profiling")
+set(TRACY_ONLY_IPV4 ON CACHE BOOL "IPv4 only")
+option(TRACY_ENABLE "Enable profiling" ON)
+option(TRACY_ONLY_IPV4 "IPv4 only" ON)
+set(FASTNOISE2_NOISETOOL OFF CACHE BOOL "Build Noise Tool" FORCE)
+
+FetchContent_MakeAvailable(imgui tracy fastnoise2)
 
 add_library(libimgui
     ${imgui_SOURCE_DIR}/imgui.cpp
@@ -26,12 +44,11 @@ add_library(libimgui
 )
 
 target_include_directories(libimgui PUBLIC 
-${imgui_SOURCE_DIR} 
-${imgui_SOURCE_DIR}/backends
+	${imgui_SOURCE_DIR} 
+	${imgui_SOURCE_DIR}/backends
 )
 
 target_link_libraries(libimgui PUBLIC d3d12 dxguid dxgi)
 
 add_library(external INTERFACE)
-target_link_libraries(external INTERFACE libimgui)
-target_include_directories(external INTERFACE ${thread-pool_SOURCE_DIR})
+target_link_libraries(external INTERFACE libimgui TracyClient FastNoise)

imgui.ini

@@ -3,10 +3,18 @@ Pos=60,60
 Size=400,400
 
 [Window][Debug Controller]
-Pos=964,203
+Pos=1411,129
 Size=409,265
 
 [Window][Dear ImGui Metrics/Debugger]
-Pos=1063,473
-Size=339,341
+Pos=76,63
+Size=418,710
+
+[Window][Dear ImGui Demo]
+Pos=650,20
+Size=550,680
+
+[Window][About Dear ImGui]
+Pos=484,185
+Size=570,160
 

include/voxel-engine/camera.hpp

@@ -1,9 +1,9 @@
 #pragma once
 
-class Camera
+class camera_t
 {
   public:
-    DirectX::XMMATRIX update_and_get_view_matrix(const float delta_time);
+    DirectX::XMMATRIX update_and_get_view_matrix(const u8 *const keyboard_state, const f32 delta_time);
 
   public:
     DirectX::XMFLOAT4 m_position{0.0f, 0.0f, -5.0f, 1.0f};
@@ -12,13 +12,13 @@ class Camera
     DirectX::XMFLOAT4 m_right{1.0f, 0.0f, 0.0f, 0.0f};
     DirectX::XMFLOAT4 m_front{0.0f, 0.0f, 1.0f, 0.0f};
 
-    float m_movement_speed{500.0f};
-    float m_rotation_speed{1.0f};
+    f32 m_movement_speed{150.0f};
+    f32 m_rotation_speed{1.0f};
 
     // Used to determine how 'smooth' the camera behaves.
     // For now, both rotation and movement use the same friction value, purely for simplicity.
-    float m_friction{0.30f};
+    f32 m_friction{0.30f};
 
-    float m_pitch{};
-    float m_yaw{};
+    f32 m_pitch{};
+    f32 m_yaw{};
 };

include/voxel-engine/common.hpp

@@ -3,8 +3,7 @@
 #include "types.hpp"
 
 // Helper function to print to console in debug mode if the passed Hresult has failed.
-static inline void throw_if_failed(const HRESULT hr,
-                                   const std::source_location src_loc = std::source_location::current())
+inline void throw_if_failed(const HRESULT hr, const std::source_location src_loc = std::source_location::current())
 {
     if constexpr (VX_DEBUG_MODE)
     {
@@ -17,12 +16,12 @@ static inline void throw_if_failed(const HRESULT hr,
 }
 
 // Helper functions to go from 1d to 3d and vice versa.
-static inline size_t convert_to_1d(const DirectX::XMUINT3 index_3d, const size_t N)
+inline size_t convert_to_1d(const DirectX::XMUINT3 index_3d, const size_t N)
 {
     return index_3d.x + N * (index_3d.y + (index_3d.z * N));
 }
 
-static inline DirectX::XMUINT3 convert_to_3d(const size_t index, const size_t N)
+inline DirectX::XMUINT3 convert_to_3d(const size_t index, const size_t N)
 {
     // For reference, index = x + y * N + z * N * N.
     const u32 z = static_cast<u32>(index / (N * N));
@@ -33,16 +32,18 @@ static inline DirectX::XMUINT3 convert_to_3d(const size_t index, const size_t N)
     return {x, y, z};
 }
 
-static inline void name_d3d12_object(ID3D12Object *const object, const std::wstring_view name)
+inline void name_d3d12_object(ID3D12Object *const object, const std::wstring_view name)
 {
     if constexpr (VX_DEBUG_MODE)
     {
         object->SetName(std::wstring(name).c_str());
     }
 }
 
-static inline size_t round_up_to_multiple(size_t a, size_t multiple)
+inline size_t round_up_to_multiple(const size_t a, const size_t multiple)
 {
+    assert(multiple != 0);
+
     if (a % multiple == 0)
     {
         return a;

include/voxel-engine/filesystem.hpp

@@ -3,12 +3,12 @@
 // A simple class that can get the relative path of a file / folder with respect to the executable.
 // NOTE : Makes the assumption that between the executable and the project root directory, there is NO OTHER folder with
 // the name "voxel-engine".
-class FileSystem
+class file_system_t
 {
   public:
-    static FileSystem &instance()
+    static file_system_t &instance()
     {
-        static FileSystem fs{};
+        static file_system_t fs{};
         return fs;
     }
 
@@ -28,7 +28,7 @@ class FileSystem
     }
 
   private:
-    explicit FileSystem();
+    explicit file_system_t();
 
   private:
     std::string m_root_directory{};

include/voxel-engine/pch.hpp

@@ -6,8 +6,13 @@ constexpr bool VX_DEBUG_MODE = true;
 constexpr bool VX_DEBUG_MODE = false;
 #endif
 
+// Basically, when no profiler is attached tracy will start going crazy with memory.
+// If TRACY_ON_DEMAND is defined, this memory issue will not occur.
+#define TRACY_ON_DEMAND
+
 // Windows includes.
 #define WIN32_LEAN_AND_MEAN
+#define NOMINMAX
 #include <Windows.h>
 
 // Dx12 / Com headers.
@@ -44,4 +49,8 @@ constexpr bool VX_DEBUG_MODE = false;
 
 // Custom includes.
 #include "common.hpp"
-#include "types.hpp"
+#include "types.hpp"
+
+// Leak symbols from wrl/client.h to global namespace (so that I don't have to keep doing Microsoft::WRL::ComPtr<T> each
+// time).
+using namespace Microsoft::WRL;