Merge branch 'master' of github.com:Devsh-Graphics-Programming/Nabla into compute_ptr_2

Author: nipunG314

.vsconfig

@@ -0,0 +1,24 @@
+{
+  "version": "1.0",
+  "components": [
+    "Microsoft.VisualStudio.Component.CoreEditor",
+    "Microsoft.VisualStudio.Workload.CoreEditor",
+    "Microsoft.Component.MSBuild",
+    "Microsoft.VisualStudio.Component.VC.CoreIde",
+    "Microsoft.VisualStudio.Component.Windows10SDK",
+    "Microsoft.VisualStudio.Component.VC.Tools.x86.x64",
+    "Microsoft.VisualStudio.Component.Graphics.Tools",
+    "Microsoft.VisualStudio.Component.VC.DiagnosticTools",
+    "Microsoft.VisualStudio.Component.Windows11SDK.22621",
+    "Microsoft.VisualStudio.Component.VC.ATL",
+    "Microsoft.VisualStudio.Component.SecurityIssueAnalysis",
+    "Microsoft.VisualStudio.Component.VC.ATLMFC",
+    "Microsoft.VisualStudio.ComponentGroup.NativeDesktop.Core",
+    "Microsoft.VisualStudio.ComponentGroup.WebToolsExtensions.CMake",
+    "Microsoft.VisualStudio.Component.VC.CMake.Project",
+    "Microsoft.VisualStudio.Component.VC.ASAN",
+    "Microsoft.VisualStudio.Workload.NativeDesktop",
+    "Microsoft.Net.ComponentGroup.TargetingPacks.Common"
+  ],
+  "extensions": []
+}

3rdparty/CMakeLists.txt

@@ -175,6 +175,8 @@ option(WITH_JAVA "libjpeg-turbo" OFF)
 set(CMAKE_INSTALL_DOCDIR "${CMAKE_CURRENT_BINARY_DIR}/libjpeg-turbo/install/docdir")
 set(CMAKE_INSTALL_MANDIR "${CMAKE_CURRENT_BINARY_DIR}/libjpeg-turbo/install/mandir")
 add_subdirectory(libjpeg-turbo libjpeg-turbo EXCLUDE_FROM_ALL)
+NBL_TARGET_FORCE_ASSEMBLER_EXECUTABLE(simd ASM_NASM libjpeg-turbo/simd/)
+
 unset(CMAKE_INSTALL_DOCDIR)
 unset(CMAKE_INSTALL_MANDIR)
 
@@ -281,14 +283,15 @@ 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_USER_CONFIG_ISD "${CMAKE_CURRENT_BINARY_DIR}/imgui/config/include")
 	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")
@@ -376,79 +379,14 @@ if(NBL_BUILD_IMGUI)
 
 	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()
 
-	# override test engine config with our own
-string(APPEND NBL_IMPL_IMCONFIG_CONTENT
-[=[
-#include "imgui_test_suite_imconfig.h" // use test engine's config
-
-// note we override it with default imguis (void*) type
-#include <cstdint>
-
-//! Custom "ImTextureID" info struct for Nabla UI backend purposes about resource sampler & texture descriptor binding's array indicies
-//! must be 4 bytes size & alignment to pass imgui static asserts (it checks for contiguous blocks in memory to make sure it can do some memcpies)
-struct SImResourceInfo 
-{ 
-	//! texture descriptor binding's array index
-    uint32_t textureID : 26; 
-
-	//! sampler descriptor binding's array index
-	uint32_t samplerIx : 6;
-
-    SImResourceInfo() : textureID(0u), samplerIx(0u) {}
-
-    SImResourceInfo(uint32_t texID) 
-    {
-        textureID = texID;
-        samplerIx = 0u;
-    }
-
-	explicit operator intptr_t() const
-	{
-		return static_cast<intptr_t>(textureID);
-	}
-
-    bool operator==(const SImResourceInfo& other) const
-    {
-        return textureID == other.textureID;
-    }
-
-    bool operator!=(const SImResourceInfo& other) const
-    {
-        return textureID != other.textureID;
-    }
-
-    bool operator<(const SImResourceInfo& other) const
-    {
-        return textureID < other.textureID;
-    }
-
-    bool operator>(const SImResourceInfo& other) const
-    {
-        return textureID > other.textureID;
-    }
-
-    bool operator<=(const SImResourceInfo& other) const
-    {
-        return textureID <= other.textureID;
-    }
-
-    bool operator>=(const SImResourceInfo& other) const
-    {
-        return textureID >= other.textureID;
-    }
-};
-
-#define ImTextureID SImResourceInfo
-#define IMGUI_ENABLE_FREETYPE
-#define IMGUI_DISABLE_OBSOLETE_KEYIO
-#undef IMGUI_DISABLE_OBSOLETE_FUNCTIONS // but remove this cuz it break things
-]=]
-)
-	set(NBL_IMGUI_USER_CONFIG_FILEPATH "${NBL_IMGUI_USER_CONFIG_ISD}/nabla_imconfig.h")
-	file(WRITE "${NBL_IMGUI_USER_CONFIG_FILEPATH}" "${NBL_IMPL_IMCONFIG_CONTENT}")
-	
-	# USER DEFINED IMGUI CONFIG, IMPACTS THE BUILD
 	target_compile_definitions(imgui PUBLIC
 		IMGUI_USER_CONFIG="${NBL_IMGUI_USER_CONFIG_FILEPATH}"
 	)

3rdparty/git-version-tracking

@@ -13,7 +13,11 @@ include(ExternalProject)
 include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/toolchains/android/build.cmake)
 
 project(Nabla LANGUAGES CXX C)
-enable_language(C CXX ASM)
+enable_language(C CXX ASM ASM_NASM)
+
+if(MSVC)
+	enable_language(ASM_MASM)
+endif()
 
 option(NBL_STATIC_BUILD "" OFF) # ON for static builds, OFF for shared
 option(NBL_DYNAMIC_MSVC_RUNTIME "" ON)
@@ -30,7 +34,7 @@ endif()
 if(NBL_STATIC_BUILD)
 	message(STATUS "Static Nabla build enabled!")
 else()
-	if(WIN32 AND MSVC)
+	if(MSVC)
 		if(NBL_DYNAMIC_MSVC_RUNTIME)
 			message(STATUS "Shared Nabla build enabled!")
 		else()
@@ -66,6 +70,14 @@ set(NBL_BUILTIN_RESOURCES_DIRECTORY_PATH "${NBL_ROOT_PATH}/include/nbl/builtin")
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${NBL_ROOT_PATH}/cmake" CACHE PATH "")
 get_property(NBL_IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
 
+include(common)
+
+option(NBL_ENABLE_VS_CONFIG_IMPORT "Request import of .vsconfig file with VS components required to build Nabla" OFF)
+
+if(NBL_ENABLE_VS_CONFIG_IMPORT)
+	NBL_IMPORT_VS_CONFIG()
+endif()
+
 # Configure CCache if available
 find_program(CCACHE_FOUND ccache)
 if(CCACHE_FOUND)
@@ -189,7 +201,6 @@ get_filename_component(NBL_MEDIA_DIRECTORY_ABS "${NBL_MEDIA_DIRECTORY}" ABSOLUTE
 
 include(submodules/update)
 find_package(Python3 COMPONENTS Interpreter REQUIRED)
-include(common)
 
 add_subdirectory(${THIRD_PARTY_SOURCE_DIR})
 

3rdparty/imgui

@@ -5,7 +5,6 @@
 		"minor": 29,
 		"patch": 2
 	},
-
 	"configurePresets": [
 		{
 			"name": "ci-configure-base",
@@ -109,21 +108,27 @@
 			"inherits": "ci-configure-static-windows-base",
 			"displayName": "[CI]: Static library target, Ninja multi-config generator",
 			"description": "Configure as static library with Ninja multi-config generator",
-			"generator": "Ninja Multi-Config"
+			"generator": "Ninja Multi-Config",
+			"cacheVariables": {
+				"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
+			}
 		},
 		{
 			"name": "ci-configure-dynamic-ninja-multi",
 			"inherits": "ci-configure-dynamic-windows-base",
 			"displayName": "[CI]: Dynamic library target, Ninja multi-config generator",
 			"description": "Configure as dynamic library with Ninja multi-config generator",
-			"generator": "Ninja Multi-Config"
+			"generator": "Ninja Multi-Config",
+			"cacheVariables": {
+				"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
+			}
 		},
 		{
 			"name": "user-configure-base",
 			"hidden": true,
 			"cacheVariables": {
 				"NBL_CI_MODE": "OFF",
-				"NBL_UPDATE_GIT_SUBMODULE": "ON",
+				"NBL_UPDATE_GIT_SUBMODULE": "OFF",
 				"NBL_RUN_TESTS": "OFF",
 				"NBL_CPACK_CI": "OFF"
 			}
@@ -193,14 +198,20 @@
 			"inherits": "user-configure-static-windows-base",
 			"displayName": "[USER]: Static library target, Ninja multi-config generator",
 			"description": "Configure as static library with Ninja multi-config generator",
-			"generator": "Ninja Multi-Config"
+			"generator": "Ninja Multi-Config",
+			"cacheVariables": {
+				"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
+			}
 		},
 		{
 			"name": "user-configure-dynamic-ninja-multi",
 			"inherits": "user-configure-dynamic-windows-base",
 			"displayName": "[USER]: Dynamic library target, Ninja multi-config generator",
 			"description": "Configure as dynamic library with Ninja multi-config generator",
-			"generator": "Ninja Multi-Config"
+			"generator": "Ninja Multi-Config",
+			"cacheVariables": {
+				"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
+			}
 		},
 		{
 			"name": "user-configure-static-ninja-release",
@@ -209,7 +220,8 @@
 			"description": "Configure as static Release library with Ninja single-config generator",
 			"generator": "Ninja",
 			"cacheVariables": {
-				"CMAKE_BUILD_TYPE": "Release"
+				"CMAKE_BUILD_TYPE": "Release",
+				"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
 			}
 		},
 		{
@@ -219,7 +231,8 @@
 			"description": "Configure as dynamic Release library with Ninja single-config generator",
 			"generator": "Ninja",
 			"cacheVariables": {
-				"CMAKE_BUILD_TYPE": "Release"
+				"CMAKE_BUILD_TYPE": "Release",
+				"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
 			}
 		},
 		{
@@ -229,7 +242,8 @@
 			"description": "Configure as static RelWithDebInfo library with Ninja single-config generator",
 			"generator": "Ninja",
 			"cacheVariables": {
-				"CMAKE_BUILD_TYPE": "RelWithDebInfo"
+				"CMAKE_BUILD_TYPE": "RelWithDebInfo",
+				"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
 			}
 		},
 		{
@@ -239,7 +253,8 @@
 			"description": "Configure as dynamic RelWithDebInfo library with Ninja single-config generator",
 			"generator": "Ninja",
 			"cacheVariables": {
-				"CMAKE_BUILD_TYPE": "RelWithDebInfo"
+				"CMAKE_BUILD_TYPE": "RelWithDebInfo",
+				"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
 			}
 		},
 		{
@@ -249,7 +264,8 @@
 			"description": "Configure as static Debug library with Ninja single-config generator",
 			"generator": "Ninja",
 			"cacheVariables": {
-				"CMAKE_BUILD_TYPE": "Debug"
+				"CMAKE_BUILD_TYPE": "Debug",
+				"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
 			}
 		},
 		{
@@ -259,7 +275,8 @@
 			"description": "Configure as dynamic Debug library with Ninja single-config generator",
 			"generator": "Ninja",
 			"cacheVariables": {
-				"CMAKE_BUILD_TYPE": "Debug"
+				"CMAKE_BUILD_TYPE": "Debug",
+				"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
 			}
 		}
 	],
@@ -413,7 +430,6 @@
 			"displayName": "[USER]: Dynamic Debug library target, Ninja single-config generator",
 			"description": "Build Nabla as dynamic Debug library with Ninja single-config generator"
 		}
-		
 	],
 	"packagePresets": [
 		{

CMakeLists.txt

@@ -1298,4 +1298,38 @@ macro(NBL_GET_ALL_TARGETS_RECURSIVE NBL_TARGETS NBL_DIRECTORY)
 
     get_property(NBL_GATHERED_TARGETS DIRECTORY ${NBL_DIRECTORY} PROPERTY BUILDSYSTEM_TARGETS)
     list(APPEND ${NBL_TARGETS} ${NBL_GATHERED_TARGETS})
+endmacro()
+
+function(NBL_IMPORT_VS_CONFIG)
+	if(WIN32 AND "${CMAKE_GENERATOR}" MATCHES "Visual Studio")
+		message(STATUS "Requesting import of .vsconfig file! Configuration will continue after Visual Studio Installer is closed.")
+		set(NBL_DEVENV_ISOLATION_INI_PATH "${CMAKE_GENERATOR_INSTANCE}/Common7/IDE/devenv.isolation.ini")
+		file(READ ${NBL_DEVENV_ISOLATION_INI_PATH} NBL_DEVENV_ISOLATION_INI_CONTENT)
+		string(REPLACE "/" "\\" NBL_VS_INSTALLATION_PATH ${CMAKE_GENERATOR_INSTANCE})
+		string(REGEX MATCH "SetupEngineFilePath=\"([^\"]*)\"" _match "${NBL_DEVENV_ISOLATION_INI_CONTENT}")
+		set(NBL_VS_INSTALLER_PATH "${CMAKE_MATCH_1}")
+
+		execute_process(COMMAND "${NBL_VS_INSTALLER_PATH}" modify --installPath "${NBL_VS_INSTALLATION_PATH}" --config "${NBL_ROOT_PATH}/.vsconfig" --allowUnsignedExtensions
+			ERROR_VARIABLE vsconfig_error
+			RESULT_VARIABLE vsconfig_result
+		)
+
+		if(NOT vsconfig_result EQUAL 0)
+    		message(FATAL_ERROR "Visual Studio Installer error: ${vsconfig_error}")
+		endif()
+	else()
+		message(FATAL_ERORR "Cannot request importing VS config, doesn't meet requirements!")
+	endif()
+
+endfunction()
+
+macro(NBL_TARGET_FORCE_ASSEMBLER_EXECUTABLE _NBL_TARGET_ _NBL_ASM_DIALECT_ _NBL_PREPEND_PATH_TRANSFORM_)
+	get_target_property(_NBL_TARGET_SOURCES_ "${_NBL_TARGET_}" SOURCES)
+	list(FILTER _NBL_TARGET_SOURCES_ INCLUDE REGEX "\\.asm$")
+	list(TRANSFORM _NBL_TARGET_SOURCES_ PREPEND "${_NBL_PREPEND_PATH_TRANSFORM_}")
+
+	set_source_files_properties(${_NBL_TARGET_SOURCES_}
+		TARGET_DIRECTORY "${_NBL_TARGET_}"
+		PROPERTIES LANGUAGE "${_NBL_ASM_DIALECT_}"
+	)
 endmacro()

CMakePresets.json

@@ -46,18 +46,23 @@ You also have options `BUILD_EXAMPLES` and `BUILD_TOOLS` which do exactly what t
 
 For Windows *MSVC* required, *MinGW* build system maintenance will be delegated to the community.
 
-### Ninja Multi-Config generator
+### Ninja Multi-Config generator & MSVC
 
-The target toolset is MSVC. Before invoking CMake you need to [initialize VS's environment](https://learn.microsoft.com/en-us/cpp/build/cmake-presets-vs?view=msvc-170#sourcing-the-environment-when-building-with-command-line-generators-on-windows) by calling
+#### Command line
+
+Open command line, init MSVC [toolset environment](https://learn.microsoft.com/en-us/cpp/build/cmake-presets-vs?view=msvc-170#sourcing-the-environment-when-building-with-command-line-generators-on-windows) by calling
 
 ```cmd
 vcvarsall.bat <platform>
 ```
 
-in your cmd (eg. `vcvarsall.bat x64` call will initialize environment for amd64, for more info go [here](https://learn.microsoft.com/en-us/cpp/build/building-on-the-command-line?view=msvc-170#vcvarsall-syntax)). Once initialization is done you can use Ninja CMake preset to build Nabla, eg.
+(eg. `vcvarsall.bat x64` call will initialize environment for amd64, for more info see [following](https://learn.microsoft.com/en-us/cpp/build/building-on-the-command-line?view=msvc-170#vcvarsall-syntax)). Once initialized fire a ninja preset.
 
 ```cmd
+cmake --preset user-configure-dynamic-ninja-multi
 cmake --build --preset user-build-dynamic-ninja-multi --config Debug -- --quiet
 ```
 
-The build preset will pick configure preset associated with it and invoke configure then build. Pay attention that if you don't initialize VS's environment the following will fail to compile with MSVC toolset.
+#### With Visual Studio
+
+Follow VS [tutorial](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio?view=msvc-170).