Builtin Resources CMake Refactor

3rdparty/dxc/CMakeLists.txt

@@ -135,4 +135,11 @@ CACHE INTERNAL "")
 
 set(DXC_DLL 
 	$<IF:$<CONFIG:Debug>,${NBL_DXC_DEBUG_DLL},${NBL_DXC_RELEASE_DLL}>
+CACHE INTERNAL "")
+
+cmake_path(GET NBL_DXC_DEBUG_DLL FILENAME _NBL_DXC_DEBUG_DLL_NAME_)
+cmake_path(GET NBL_DXC_RELEASE_DLL FILENAME _NBL_DXC_RELEASE_DLL_NAME_)
+
+set(DXC_DLL_NAME 
+	$<IF:$<CONFIG:Debug>,${_NBL_DXC_DEBUG_DLL_NAME_},${_NBL_DXC_RELEASE_DLL_NAME_}>
 CACHE INTERNAL "")

CMakeLists.txt

@@ -2,7 +2,7 @@
 # This file is part of the "Nabla Engine".
 # For conditions of distribution and use, see copyright notice in nabla.h.in or nabla.h
 
-cmake_minimum_required(VERSION 3.25)
+cmake_minimum_required(VERSION 3.26)
 #policies
 cmake_policy(SET CMP0112 NEW)
 
@@ -56,6 +56,7 @@ endif()
 
 get_filename_component(NBL_ROOT_PATH "${CMAKE_CURRENT_SOURCE_DIR}" ABSOLUTE)
 get_filename_component(NBL_ROOT_PATH_BINARY "${CMAKE_CURRENT_BINARY_DIR}" ABSOLUTE)
+set(NBL_BUILTIN_RESOURCES_DIRECTORY_PATH "${NBL_ROOT_PATH}/include")
 
 # Configure CCache if available
 find_program(CCACHE_FOUND ccache)

cmake/common.cmake

@@ -221,6 +221,7 @@ macro(nbl_create_ext_library_project EXT_NAME LIB_HEADERS LIB_SOURCES LIB_INCLUD
 	add_dependencies(${LIB_NAME} Nabla)
 
 	get_target_property(_NBL_NABLA_TARGET_BINARY_DIR_ Nabla BINARY_DIR)
+	get_target_property(_BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY_ nblBuiltinResourceData BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY)
 
 	target_include_directories(${LIB_NAME}
 		PUBLIC ${_NBL_NABLA_TARGET_BINARY_DIR_}/build/import
@@ -230,6 +231,7 @@ macro(nbl_create_ext_library_project EXT_NAME LIB_HEADERS LIB_SOURCES LIB_INCLUD
 		PUBLIC ${CMAKE_SOURCE_DIR}/include
 		PUBLIC ${CMAKE_SOURCE_DIR}/src
 		PUBLIC ${CMAKE_SOURCE_DIR}/source/Nabla
+		PUBLIC ${_BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY_}
 		PRIVATE ${LIB_INCLUDES}
 	)
 	add_dependencies(${LIB_NAME} Nabla)
@@ -339,6 +341,13 @@ function(nbl_install_file _FILE _RELATIVE_DESTINATION)
 	install(FILES ${_FILE} DESTINATION relwithdebinfo/include/${_RELATIVE_DESTINATION} CONFIGURATIONS RelWithDebInfo)
 endfunction()
 
+function(nbl_install_builtin_resources _TARGET_)
+	get_target_property(_BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY_ ${_TARGET_} BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY)
+	get_target_property(_BUILTIN_RESOURCES_HEADERS_ ${_TARGET_} BUILTIN_RESOURCES_HEADERS)
+
+	nbl_install_headers("${_BUILTIN_RESOURCES_HEADERS_}" "${_BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY_}")
+endfunction()
+
 function(nbl_install_config_header _CONF_HDR_NAME)
 	nbl_get_conf_dir(dir_deb Debug)
 	nbl_get_conf_dir(dir_rel Release)
@@ -351,6 +360,18 @@ function(nbl_install_config_header _CONF_HDR_NAME)
 	install(FILES ${file_relWithDebInfo} DESTINATION relwithdebinfo/include CONFIGURATIONS RelWithDebInfo)
 endfunction()
 
+# links builtin resource target to a target
+# @_TARGET_@ is target name builtin resource target will be linked to
+# @_BS_TARGET_@ is a builtin resource target
+
+function(LINK_BUILTIN_RESOURCES_TO_TARGET _TARGET_ _BS_TARGET_)
+	add_dependencies(${EXECUTABLE_NAME} ${_BS_TARGET_})
+	target_link_libraries(${EXECUTABLE_NAME} PUBLIC ${_BS_TARGET_})
+
+	get_target_property(_BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY_ ${_BS_TARGET_} BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY)
+	target_include_directories(${EXECUTABLE_NAME} PUBLIC "${_BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY_}")
+endfunction()
+
 macro(nbl_android_create_apk _TARGET)
 	get_target_property(TARGET_NAME ${_TARGET} NAME)
 	# TARGET_NAME_IDENTIFIER is identifier that can be used in code

cmake/install/nbl/sharedDefines.h.in

@@ -4,4 +4,5 @@
 */
 
 #define _NABLA_DLL_NAME_ "@_NABLA_DLL_NAME_@"
+#define _DXC_DLL_NAME_ "@_DXC_DLL_NAME_@"
 #define _NABLA_INSTALL_DIR_ @_NABLA_INSTALL_DIR_@

cmake/scripts/nbl/nablaDefines.cmake

@@ -42,6 +42,10 @@ if(NOT DEFINED _NABLA_DLL_NAME_)
 	message(FATAL_ERROR  "_NABLA_DLL_NAME_ variable must be specified for this script!")
 endif()
 
+if(NOT DEFINED _DXC_DLL_NAME_)
+	message(FATAL_ERROR  "_DXC_DLL_NAME_ variable must be specified for this script!")
+endif()
+
 if(NOT DEFINED _NABLA_INSTALL_DIR_)
 	message(FATAL_ERROR  "_NABLA_INSTALL_DIR_ variable must be specified for this script!")
 endif()

include/nbl/config/BuildConfigOptions.h.in

@@ -79,6 +79,8 @@
 #endif
 #endif
 
+#define NBL_BUILTIN_RESOURCES_DIRECTORY_PATH "@NBL_BUILTIN_RESOURCES_DIRECTORY_PATH@"
+
 // DDL exports
 #cmakedefine _NBL_SHARED_BUILD_
 #ifdef _NBL_SHARED_BUILD_

include/nbl/scene/ICullingLoDSelectionSystem.h

@@ -490,7 +490,17 @@ class ICullingLoDSelectionSystem : public virtual core::IReferenceCounted
 			auto getShader = [device]<core::StringLiteral Path>() -> shader_source_and_path
 			{
 				auto system = device->getPhysicalDevice()->getSystem();
-				auto glslFile = system->loadBuiltinData<Path>();
+
+				auto loadBuiltinData = [&](const std::string _path) -> core::smart_refctd_ptr<const nbl::system::IFile>
+				{
+					nbl::system::ISystem::future_t<core::smart_refctd_ptr<nbl::system::IFile>> future;
+					system->createFile(future, system::path(_path), core::bitflag(nbl::system::IFileBase::ECF_READ) | nbl::system::IFileBase::ECF_MAPPABLE);
+					if (future.wait())
+						return future.copy();
+					return nullptr;
+				};
+
+				auto glslFile = loadBuiltinData(Path.value);
 				core::smart_refctd_ptr<asset::ICPUBuffer> glsl;
 				{
 					glsl = core::make_smart_refctd_ptr<asset::ICPUBuffer>(glslFile->getSize());

include/nbl/scene/ISkinInstanceCacheManager.h

@@ -26,7 +26,16 @@ class ISkinInstanceCacheManager : public virtual core::IReferenceCounted
 			auto system = device->getPhysicalDevice()->getSystem();
 			auto createShader = [&system,&device](auto uniqueString, asset::IShader::E_SHADER_STAGE type=asset::IShader::ESS_COMPUTE) -> core::smart_refctd_ptr<video::IGPUSpecializedShader>
 			{
-				auto glslFile = system->loadBuiltinData<decltype(uniqueString)>();
+				auto loadBuiltinData = [&](const std::string _path) -> core::smart_refctd_ptr<const nbl::system::IFile>
+				{
+					nbl::system::ISystem::future_t<core::smart_refctd_ptr<nbl::system::IFile>> future;
+					system->createFile(future, system::path(_path), core::bitflag(nbl::system::IFileBase::ECF_READ) | nbl::system::IFileBase::ECF_MAPPABLE);
+					if (future.wait())
+						return future.copy();
+					return nullptr;
+				};
+
+				auto glslFile = loadBuiltinData(uniqueString);
 				core::smart_refctd_ptr<asset::ICPUBuffer> glsl;
 				{
 					glsl = core::make_smart_refctd_ptr<asset::ICPUBuffer>(glslFile->getSize());
@@ -36,9 +45,9 @@ class ISkinInstanceCacheManager : public virtual core::IReferenceCounted
 				return device->createSpecializedShader(shader.get(),{nullptr,nullptr,"main"});
 			};
 
-			auto updateSpec = createShader(NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("nbl/builtin/glsl/skinning/cache_update.comp")());
-			auto debugDrawVertexSpec = createShader(NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("nbl/builtin/glsl/skinning/debug.vert")(),asset::IShader::ESS_VERTEX);
-			auto debugDrawFragmentSpec = createShader(NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("nbl/builtin/material/debug/vertex_normal/specialized_shader.frag")(),asset::IShader::ESS_FRAGMENT);
+			auto updateSpec = createShader("nbl/builtin/glsl/skinning/cache_update.comp");
+			auto debugDrawVertexSpec = createShader("nbl/builtin/glsl/skinning/debug.vert",asset::IShader::ESS_VERTEX);
+			auto debugDrawFragmentSpec = createShader("nbl/builtin/material/debug/vertex_normal/specialized_shader.frag",asset::IShader::ESS_FRAGMENT);
 			if (!updateSpec || !debugDrawVertexSpec || !debugDrawFragmentSpec)
 				return nullptr;
 

include/nbl/scene/ITransformTreeManager.h

@@ -108,7 +108,16 @@ class ITransformTreeManager : public virtual core::IReferenceCounted
 			auto system = device->getPhysicalDevice()->getSystem();
 			auto createShader = [&system,&device]<core::StringLiteral Path>(asset::IShader::E_SHADER_STAGE type=asset::IShader::ESS_COMPUTE) -> core::smart_refctd_ptr<video::IGPUSpecializedShader>
 			{
-				auto glslFile = system->loadBuiltinData<Path>();
+				auto loadBuiltinData = [&](const std::string _path) -> core::smart_refctd_ptr<const nbl::system::IFile>
+				{
+					nbl::system::ISystem::future_t<core::smart_refctd_ptr<nbl::system::IFile>> future;
+					system->createFile(future, system::path(_path), core::bitflag(nbl::system::IFileBase::ECF_READ) | nbl::system::IFileBase::ECF_MAPPABLE);
+					if (future.wait())
+						return future.copy();
+					return nullptr;
+				};
+
+				auto glslFile = loadBuiltinData(Path.value);
 				core::smart_refctd_ptr<asset::ICPUBuffer> glsl;
 				{
 					glsl = core::make_smart_refctd_ptr<asset::ICPUBuffer>(glslFile->getSize());

include/nbl/system/CFileViewVirtualAllocatorWin32.h

@@ -4,7 +4,7 @@
 namespace nbl::system 
 {
 #ifdef _NBL_PLATFORM_WINDOWS_
-class CFileViewVirtualAllocatorWin32 : public IFileViewAllocator
+class NBL_API2 CFileViewVirtualAllocatorWin32 : public IFileViewAllocator
 {
 	public:
 		using IFileViewAllocator::IFileViewAllocator;

include/nbl/system/IFileArchive.h

@@ -21,7 +21,7 @@ namespace nbl::system
 class IFile;
 
 //! The FileArchive manages archives and provides access to files inside them.
-class IFileArchive : public core::IReferenceCounted
+class NBL_API2 IFileArchive : public core::IReferenceCounted
 {
 	public:
 		enum E_ALLOCATOR_TYPE
@@ -64,10 +64,10 @@ class IFileArchive : public core::IReferenceCounted
 		};
 
 		//
-		core::SRange<const SListEntry> listAssets() const {return {m_items.data(),m_items.data()+m_items.size()};}
+		virtual core::SRange<const SListEntry> listAssets() const {return {m_items.data(),m_items.data()+m_items.size()};}
 
 		// List all files and directories in a specific dir of the archive
-		core::SRange<const SListEntry> listAssets(const path& asset_path) const;
+		virtual core::SRange<const SListEntry> listAssets(const path& asset_path) const;
 
 		//
 		virtual core::smart_refctd_ptr<IFile> getFile(const path& pathRelativeToArchive, const std::string_view& password) = 0;
@@ -88,10 +88,10 @@ class IFileArchive : public core::IReferenceCounted
 			return &(*found);
 		}
 
-		std::mutex itemMutex; // TODO: update to readers writer lock
+		mutable std::mutex itemMutex; // TODO: update to readers writer lock
 		path m_defaultAbsolutePath;
 		// files and directories
-		core::vector<SListEntry> m_items;
+		mutable core::vector<SListEntry> m_items;
 		//
 		system::logger_opt_smart_ptr m_logger;
 };

include/nbl/system/ISystem.h

@@ -5,13 +5,14 @@
 #include "nbl/core/declarations.h"
 #include "nbl/core/util/bitflag.h"
 
-#include "nbl/builtin/common.h"
-
 #include <variant>
 
 #include "nbl/system/IFileArchive.h"
 #include "nbl/system/IAsyncQueueDispatcher.h"
-//#include "nbl/builtin/builtinResources.h"
+
+#ifdef _NBL_EMBED_BUILTIN_RESOURCES_
+#include "nbl/builtin/builtinResources.h"
+#endif
 
 namespace nbl::system
 {
@@ -23,6 +24,7 @@ class NBL_API2 ISystem : public core::IReferenceCounted
 {
     public:
         inline static constexpr uint32_t MAX_FILENAME_LENGTH = 4096;
+
         //! We overrride the future a little bit, to allow to put a result in it right away without asynchronocity
         template <typename T>
         struct future_t final : public impl::IAsyncQueueDispatcherBase::cancellable_future_t<T>
@@ -49,21 +51,14 @@ class NBL_API2 ISystem : public core::IReferenceCounted
                     future.set_result(value);
                 }
         };
-
-        //! Compile time resource ID
-        template<nbl::core::StringLiteral Path>
-        inline core::smart_refctd_ptr<const IFile> loadBuiltinData()
+
+		#ifndef _NBL_EMBED_BUILTIN_RESOURCES_
+        constexpr std::string_view getBuiltinResourcesDirectoryPath()
         {
-        #ifdef _NBL_EMBED_BUILTIN_RESOURCES_
-            return impl_loadEmbeddedBuiltinData(Path.value,nbl::builtin::get_resource<Path>());
-        #else
-            future_t<core::smart_refctd_ptr<IFile>> future;
-            createFile(future,system::path(Path.value),core::bitflag(IFileBase::ECF_READ)|IFileBase::ECF_MAPPABLE);
-            if (future.wait())
-                return future.copy();
-            return nullptr;
-        #endif
+            std::string_view retval = NBL_BUILTIN_RESOURCES_DIRECTORY_PATH;
+            return retval;
         }
+		#endif
 
         //
         inline void addArchiveLoader(core::smart_refctd_ptr<IArchiveLoader>&& loader)
@@ -198,9 +193,6 @@ class NBL_API2 ISystem : public core::IReferenceCounted
         explicit ISystem(core::smart_refctd_ptr<ICaller>&& caller);
         virtual ~ISystem() {}
 
-        //
-        core::smart_refctd_ptr<const IFile> impl_loadEmbeddedBuiltinData(const std::string& builtinPath, const std::pair<const uint8_t*,size_t>& found) const;
-
         // given an `absolutePath` find the archive it belongs to
         struct FoundArchiveFile
         {