Merge remote-tracking branch 'origin/master' into asset-conversion-v3

Author: devsh

.gitmodules

@@ -102,6 +102,9 @@
 [submodule "3rdparty/imguizmo"]
 	path = 3rdparty/imguizmo
 	url = git@github.com:Devsh-Graphics-Programming/ImGuizmo.git
+[submodule "3rdparty/imgui_test_engine"]
+	path = 3rdparty/imgui_test_engine
+	url = git@github.com:ocornut/imgui_test_engine.git
 [submodule "3rdparty/git-version-tracking"]
 	path = 3rdparty/git-version-tracking
 	url = git@github.com:Devsh-Graphics-Programming/cmake-git-version-tracking.git

3rdparty/CMakeLists.txt

@@ -233,9 +233,6 @@ if(_NBL_COMPILE_WITH_OPEN_EXR_)
 	set(BUILD_TESTING ${_OLD_BUILD_TESTING})
 endif()
 
-
-
-
 #gli
 option(_NBL_COMPILE_WITH_GLI_ "Build with GLI library" ON)
 if(_NBL_COMPILE_WITH_GLI_)
@@ -289,54 +286,113 @@ add_library(spirv_cross OBJECT
 target_compile_definitions(spirv_cross PUBLIC SPIRV_CROSS_EXCEPTIONS_TO_ASSERTIONS)
 
 # cmake-git-version-tracking
+# note that checking if a repository is dirty may cost build time (especially a lot if like us you have a lot of submodules) - by default we run with all checks but if you want to increase build time iterations I recommend to exclude this check
+option(GIT_EXCLUDE_IS_DIRTY "Exclude IS_DIRTY from git tracking checks, will increase build time iterations at the expense of the meta information loss" OFF)
 add_subdirectory(git-version-tracking EXCLUDE_FROM_ALL)
 NBL_ADD_GIT_TRACKING_META_LIBRARY(nabla "${NBL_ROOT_PATH}")
 NBL_ADD_GIT_TRACKING_META_LIBRARY(dxc "${CMAKE_CURRENT_SOURCE_DIR}/dxc/dxc")
 NBL_GENERATE_GIT_TRACKING_META()
 
 if(NBL_BUILD_IMGUI)
+	set(NBL_IMGUI_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/imgui")
+	set(NBL_IMGUI_TEST_ENGINE_PROJECT_ROOT "${THIRD_PARTY_SOURCE_DIR}/imgui_test_engine")
+	set(NBL_IMGUI_TEST_ENGINE_ROOT "${NBL_IMGUI_TEST_ENGINE_PROJECT_ROOT}/imgui_test_engine")
+	set(NBL_IMGUI_TEST_SUITE_ROOT "${NBL_IMGUI_TEST_ENGINE_PROJECT_ROOT}/imgui_test_suite")
+	set(NBL_IMPLOT_ROOT "${NBL_IMGUI_TEST_SUITE_ROOT}/thirdparty/implot")
+
 	add_library(imgui STATIC
-		"imgui/imconfig.h"
-		"imgui/imgui_demo.cpp"
-		"imgui/imgui_draw.cpp"
-		"imgui/imgui_internal.h"
-		"imgui/imgui_tables.cpp"
-		"imgui/imgui_widgets.cpp"
-		"imgui/imgui.cpp"
-		"imgui/imgui.h"
-		"imgui/misc/cpp/imgui_stdlib.cpp"
-		"imgui/misc/cpp/imgui_stdlib.h"
-		"imgui/imstb_rectpack.h"
-		"imgui/imstb_textedit.h"
-		"imgui/imstb_truetype.h"
+		"${NBL_IMGUI_ROOT}/imconfig.h"
+		"${NBL_IMGUI_ROOT}/imgui_demo.cpp"
+		"${NBL_IMGUI_ROOT}/imgui_draw.cpp"
+		"${NBL_IMGUI_ROOT}/imgui_internal.h"
+		"${NBL_IMGUI_ROOT}/imgui_tables.cpp"
+		"${NBL_IMGUI_ROOT}/imgui_widgets.cpp"
+		"${NBL_IMGUI_ROOT}/imgui.cpp"
+		"${NBL_IMGUI_ROOT}/misc/freetype/imgui_freetype.cpp"
+		"${NBL_IMGUI_ROOT}/imgui.h"
+		"${NBL_IMGUI_ROOT}/misc/cpp/imgui_stdlib.cpp"
+		"${NBL_IMGUI_ROOT}/misc/cpp/imgui_stdlib.h"
+		"${NBL_IMGUI_ROOT}/imstb_rectpack.h"
+		"${NBL_IMGUI_ROOT}/imstb_textedit.h"
+		"${NBL_IMGUI_ROOT}/imstb_truetype.h"
 	)
-	target_include_directories(imgui
-		PUBLIC "imgui"
-		PUBLIC "imgui/misc/cpp"
-		PUBLIC "imgui/backends"
+	
+	target_link_libraries(imgui PUBLIC freetype)
+	
+	target_include_directories(imgui PUBLIC 
+		"${NBL_IMGUI_ROOT}"
+		"${NBL_IMGUI_ROOT}/misc/cpp"
+		"${NBL_IMGUI_ROOT}/backends"
+		"${NBL_IMGUI_TEST_SUITE_ROOT}"
+		$<TARGET_PROPERTY:freetype,INCLUDE_DIRECTORIES>
 	)
 
-	# ImPlot
 	add_library(implot STATIC
-		"implot/implot.h"
-		"implot/implot_internal.h"
-		"implot/implot.cpp"
-		"implot/implot_items.cpp"
+		"${NBL_IMPLOT_ROOT}/implot.h"
+		"${NBL_IMPLOT_ROOT}/implot_internal.h"
+		"${NBL_IMPLOT_ROOT}/implot.cpp"
+		"${NBL_IMPLOT_ROOT}/implot_items.cpp"
+		"${NBL_IMPLOT_ROOT}/implot_demo.cpp"
 	)
+	
 	target_include_directories(implot
-		PUBLIC "imgui"
+		PUBLIC $<TARGET_PROPERTY:imgui,INCLUDE_DIRECTORIES>
+		PUBLIC "${NBL_IMPLOT_ROOT}"
 	)
+	
 	target_link_libraries(implot PUBLIC imgui)
 	target_compile_definitions(implot PUBLIC IMPLOT_DEBUG IMPLOT_DLL_EXPORT)
-	set_property(TARGET implot PROPERTY CXX_STANDARD 11)
+	set_target_properties(implot PROPERTIES CXX_STANDARD 20)
+	
 	if(MSVC)
 		target_compile_options(implot PRIVATE /MT /W4 /WX /arch:AVX2 /fp:fast /permissive-) 
 	else()
 		target_compile_options(implot PRIVATE -Wall -Wextra -pedantic -Werror -mavx2 -Ofast)
 	endif()
+
+	file(GLOB_RECURSE NBL_TEST_SUITE_SOURCES CONFIGURE_DEPENDS "${NBL_IMGUI_TEST_SUITE_ROOT}/imgui_test*.cpp")
+	file(GLOB_RECURSE NBL_TEST_SUITE_SOURCES CONFIGURE_DEPENDS "${NBL_IMGUI_TEST_SUITE_ROOT}/imgui_test*.cpp")
+
+	add_library(imtestsuite STATIC
+		${NBL_TEST_SUITE_SOURCES}
+	)
+	
+	target_include_directories(imtestsuite PUBLIC
+		"${NBL_IMGUI_TEST_ENGINE_PROJECT_ROOT}"
+		"${NBL_IMGUI_TEST_ENGINE_ROOT}"
+		"${NBL_IMGUI_TEST_SUITE_ROOT}"
+		$<TARGET_PROPERTY:imgui,INCLUDE_DIRECTORIES>
+		$<TARGET_PROPERTY:implot,INCLUDE_DIRECTORIES>
+	)
+	
+	set_target_properties(imtestsuite PROPERTIES CXX_STANDARD 14) # NOTE! THOSE TESTS DO NOT COMPILE WITH HIGHER STANDARDS SO WE WRAP SOURCES INTO LIBRARY COMPILED WITH LOWER ONE
+	target_link_libraries(imtestsuite PUBLIC implot)
+	
+	file(GLOB_RECURSE NBL_TEST_ENGINE_SOURCES CONFIGURE_DEPENDS "${NBL_IMGUI_TEST_ENGINE_ROOT}/*.cpp")
+	
+	add_library(imtestengine STATIC
+		${NBL_TEST_ENGINE_SOURCES}
+	)
+	
+	target_include_directories(imtestengine PUBLIC
+		$<TARGET_PROPERTY:imtestsuite,INCLUDE_DIRECTORIES>
+	)
+	
+	target_link_libraries(imtestengine PUBLIC imtestsuite)
 
 	set(IMGUIZMO_BUILD_EXAMPLE OFF)
 	add_subdirectory(imguizmo EXCLUDE_FROM_ALL)
+
+	# note we override imgui config with our own
+	set(NBL_IMGUI_USER_CONFIG_FILEPATH "${NBL_IMGUI_ROOT}/nabla_imconfig.h")
+
+	if(NOT EXISTS "${NBL_IMGUI_USER_CONFIG_FILEPATH}")
+		message(FATAL_ERROR "\"${NBL_IMGUI_USER_CONFIG_FILEPATH}\" doesn't exist!")
+	endif()
+	
+	target_compile_definitions(imgui PUBLIC
+		IMGUI_USER_CONFIG="${NBL_IMGUI_USER_CONFIG_FILEPATH}"
+	)
 endif()
 
 add_library(aesGladman OBJECT
@@ -427,7 +483,7 @@ if (NBL_BUILD_MITSUBA_LOADER)
 	list(APPEND NBL_3RDPARTY_TARGETS expat)
 endif()
 if (NBL_BUILD_IMGUI)
-	list(APPEND NBL_3RDPARTY_TARGETS imgui implot imguizmo)
+	list(APPEND NBL_3RDPARTY_TARGETS imgui implot imtestsuite imtestengine imguizmo)
 endif()
 if(ENABLE_HLSL)
 	list(APPEND NBL_3RDPARTY_TARGETS HLSL)

3rdparty/imgui_test_engine

@@ -258,6 +258,7 @@ macro(nbl_create_executable_project _EXTRA_SOURCES _EXTRA_OPTIONS _EXTRA_INCLUDE
 	nbl_project_process_test_module()
 endmacro()
 
+# TODO this macro needs more love
 macro(nbl_create_ext_library_project EXT_NAME LIB_HEADERS LIB_SOURCES LIB_INCLUDES LIB_OPTIONS DEF_OPTIONS)
 	set(LIB_NAME "NblExt${EXT_NAME}")
 	project(${LIB_NAME})
@@ -1281,4 +1282,20 @@ endmacro()
 
 macro(write_source_definitions NBL_FILE NBL_WRAPPER_CODE_TO_WRITE)
 	file(WRITE "${NBL_FILE}" "${NBL_WRAPPER_CODE_TO_WRITE}")
+endmacro()
+
+function(NBL_GET_ALL_TARGETS NBL_OUTPUT_VAR)
+    set(NBL_TARGETS)
+    NBL_GET_ALL_TARGETS_RECURSIVE(NBL_TARGETS ${CMAKE_CURRENT_SOURCE_DIR})
+    set(${NBL_OUTPUT_VAR} ${NBL_TARGETS} PARENT_SCOPE)
+endfunction()
+
+macro(NBL_GET_ALL_TARGETS_RECURSIVE NBL_TARGETS NBL_DIRECTORY)
+    get_property(NBL_SUBDIRECTORIES DIRECTORY ${NBL_DIRECTORY} PROPERTY SUBDIRECTORIES)
+    foreach(NBL_SUBDIRECTORY ${NBL_SUBDIRECTORIES})
+        NBL_GET_ALL_TARGETS_RECURSIVE(${NBL_TARGETS} ${NBL_SUBDIRECTORY})
+    endforeach()
+
+    get_property(NBL_GATHERED_TARGETS DIRECTORY ${NBL_DIRECTORY} PROPERTY BUILDSYSTEM_TARGETS)
+    list(APPEND ${NBL_TARGETS} ${NBL_GATHERED_TARGETS})
 endmacro()

cmake/common.cmake

@@ -17,13 +17,6 @@
 #ifndef __NABLA_H_INCLUDED__
 #define __NABLA_H_INCLUDED__
 
-// meta info
-#include "git_info.h"
-
-namespace nbl {
-	NBL_API2 const gtml::GitInfo& getGitInfo(gtml::E_GIT_REPO_META repo);
-}
-
 // core lib
 #include "nbl/core/declarations.h"
 
@@ -72,4 +65,12 @@ namespace nbl {
 
 #include "SColor.h"
 
+// meta info
+#include "git_info.h"
+
+namespace nbl {
+	const NBL_API2 gtml::GitInfo& getGitInfo(gtml::E_GIT_REPO_META repo);
+}
+
+
 #endif // __NABLA_H_INCLUDED__

examples_tests

@@ -24,7 +24,8 @@ class ICPUDescriptorSetLayout : public IDescriptorSetLayout<ICPUSampler>, public
 	public:
 		_NBL_STATIC_INLINE_CONSTEXPR uint32_t IMMUTABLE_SAMPLER_HIERARCHYLEVELS_BELOW = 1u;
 
-        ICPUDescriptorSetLayout(const SBinding* const _begin, const SBinding* const _end) : base_t({_begin,_end}) {}
+        [[deprecated("Use contructor with std::span!")]] ICPUDescriptorSetLayout(const SBinding* const _begin, const SBinding* const _end) : base_t({_begin,_end}) {}
+        ICPUDescriptorSetLayout(const std::span<const SBinding> bindings) : base_t(bindings) {}
 
         core::smart_refctd_ptr<IAsset> clone(uint32_t _depth = ~0u) const override
         {

include/nabla.h

@@ -1,11 +1,9 @@
 #ifndef _NBL_I_CPU_RENDERPASS_H_INCLUDED_
 #define _NBL_I_CPU_RENDERPASS_H_INCLUDED_
 
-
 #include "nbl/asset/IAsset.h"
 #include "nbl/asset/IRenderpass.h"
 
-
 namespace nbl::asset
 {
 
@@ -17,7 +15,8 @@ class ICPURenderpass : public IRenderpass, public IAsset
             const SCreationParamValidationResult validation = validateCreationParams(_params);
             if (!validation)
                 return nullptr;
-            return core::smart_refctd_ptr<ICPURenderpass>(new ICPURenderpass(_params,validation), core::dont_grab);
+
+            return core::smart_refctd_ptr<ICPURenderpass>(new ICPURenderpass(_params, validation), core::dont_grab);
         }
 
         inline core::smart_refctd_ptr<IAsset> clone(uint32_t _depth = ~0u) const override
@@ -42,7 +41,7 @@ class ICPURenderpass : public IRenderpass, public IAsset
         inline size_t getDependantCount() const override {return 0ull;}
 
     protected:
-        using IRenderpass::IRenderpass;
+        inline ICPURenderpass(const SCreationParams& _params, const SCreationParamValidationResult& _validation) : IRenderpass(_params, _validation) {}
         inline ~ICPURenderpass() = default;
 
         inline IAsset* getDependant_impl(const size_t ix) override {return nullptr;}

include/nbl/asset/ICPUDescriptorSetLayout.h

@@ -11,7 +11,7 @@
 namespace nbl::asset
 {
 
-class IRenderpass
+class NBL_API2 IRenderpass
 {
     public:
         enum class LOAD_OP : uint8_t
@@ -356,6 +356,7 @@ class IRenderpass
 
     protected:
         IRenderpass(const SCreationParams& params, const SCreationParamValidationResult& counts);
+
         virtual ~IRenderpass() {}
 
         SCreationParams m_params;

include/nbl/asset/ICPURenderpass.h

@@ -32,7 +32,7 @@ class NBL_API2 CHLSLCompiler final : public IShaderCompiler
 
 		struct SOptions : IShaderCompiler::SCompilerOptions
 		{
-			std::span<const std::string> dxcOptions;
+			std::span<const std::string> dxcOptions; // TODO: span is a VIEW to memory, so to something which we should treat immutable - why not span of string_view then? Since its span we force users to keep those std::strings alive anyway but now we cannnot even make nice constexpr & pass such expression here directly
 			IShader::E_CONTENT_TYPE getCodeContentType() const override { return IShader::E_CONTENT_TYPE::ECT_HLSL; };
 		};
 
@@ -54,18 +54,11 @@ class NBL_API2 CHLSLCompiler final : public IShaderCompiler
 		std::string preprocessShader(std::string&& code, IShader::E_SHADER_STAGE& stage, const SPreprocessorOptions& preprocessOptions, std::vector<std::string>& dxc_compile_flags_override, std::vector<CCache::SEntry::SPreprocessingDependency>* dependencies = nullptr) const;
 
 		void insertIntoStart(std::string& code, std::ostringstream&& ins) const override;
-		constexpr static inline const wchar_t* RequiredArguments[] = {
-			L"-spirv",
-			L"-Zpr",
-			L"-enable-16bit-types",
-			L"-fvk-use-scalar-layout",
-			L"-Wno-c++11-extensions",
-			L"-Wno-c++1z-extensions",
-			L"-Wno-c++14-extensions",
-			L"-Wno-gnu-static-float-init",
-			L"-fspv-target-env=vulkan1.3"
-		};
-		constexpr static inline uint32_t RequiredArgumentCount = sizeof(RequiredArguments) / sizeof(RequiredArguments[0]);
+		
+		static constexpr auto getRequiredArguments() //! returns required arguments for the compiler's backend
+		{
+			return std::span(RequiredArguments);
+		}
 
 	protected:
 		// This can't be a unique_ptr due to it being an undefined type 
@@ -81,6 +74,23 @@ class NBL_API2 CHLSLCompiler final : public IShaderCompiler
 				ret.setCommonData(options);
 			return ret;
 		}
+
+	private:
+		// we cannot have PUBLIC data symbol in header we do export - endpoint application will fail on linker with delayed DLL loading mechanism (thats why we trick it with private member hidden from the export + provide exported getter)
+		// https://learn.microsoft.com/en-us/previous-versions/w59k653y(v=vs.100)?redirectedfrom=MSDN
+		constexpr static inline auto RequiredArguments = std::to_array<const wchar_t*> // TODO: and if dxcOptions is span of std::string then why w_chars there? https://en.cppreference.com/w/cpp/string/basic_string
+		({ 
+			L"-spirv",
+			L"-Zpr",
+			L"-enable-16bit-types",
+			L"-fvk-use-scalar-layout",
+			L"-Wno-c++11-extensions",
+			L"-Wno-c++1z-extensions",
+			L"-Wno-c++14-extensions",
+			L"-Wno-gnu-static-float-init",
+			L"-fspv-target-env=vulkan1.3",
+			L"-HV", L"202x"
+		});
 };
 
 }