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

@@ -1,8 +1,7 @@
 # Copyright (C) 2018-2020 - DevSH Graphics Programming Sp. z O.O.
 # 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 +55,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/CFileArchive.h

@@ -76,8 +76,6 @@ class CFileArchive : public IFileArchive
 	public:
 		inline core::smart_refctd_ptr<IFile> getFile(const path& pathRelativeToArchive, const std::string_view& password) override
 		{
-			std::unique_lock lock(itemMutex);
-
 			const auto* item = getItemFromPath(pathRelativeToArchive);
 			if (!item)
 				return nullptr;
@@ -107,13 +105,13 @@ class CFileArchive : public IFileArchive
 		}
 
 	protected:
-		CFileArchive(path&& _defaultAbsolutePath, system::logger_opt_smart_ptr&& logger, core::vector<SListEntry> _items) :
+		CFileArchive(path&& _defaultAbsolutePath, system::logger_opt_smart_ptr&& logger, std::shared_ptr<core::vector<SFileList::SEntry>> _items) :
 			IFileArchive(std::move(_defaultAbsolutePath),std::move(logger))
 		{
-			m_items = std::move(_items);
-			std::sort(m_items.begin(),m_items.end());
+			std::sort(_items->begin(), _items->end());
+			m_items.store(_items);
 
-			const auto fileCount = m_items.size();
+			const auto fileCount = _items->size();
 			m_filesBuffer = (std::byte*)_NBL_ALIGNED_MALLOC(fileCount*SIZEOF_INNER_ARCHIVE_FILE, ALIGNOF_INNER_ARCHIVE_FILE);
 			m_fileFlags = (std::atomic_flag*)_NBL_ALIGNED_MALLOC(fileCount*sizeof(std::atomic_flag), alignof(std::atomic_flag));
 			for (size_t i=0u; i<fileCount; i++)
@@ -127,7 +125,7 @@ class CFileArchive : public IFileArchive
 		}
 
 		template<class Allocator>
-		inline core::smart_refctd_ptr<CInnerArchiveFile<Allocator>> getFile_impl(const IFileArchive::SListEntry* item)
+		inline core::smart_refctd_ptr<CInnerArchiveFile<Allocator>> getFile_impl(const IFileArchive::SFileList::SEntry* item)
 		{
 			auto* file = reinterpret_cast<CInnerArchiveFile<Allocator>*>(m_filesBuffer+item->ID*SIZEOF_INNER_ARCHIVE_FILE);
 			// NOTE: Intentionally calling grab() on maybe-not-existing object!
@@ -160,7 +158,7 @@ class CFileArchive : public IFileArchive
 			size_t size;
 			void* allocatorState;
 		};
-		virtual file_buffer_t getFileBuffer(const IFileArchive::SListEntry* item) = 0;
+		virtual file_buffer_t getFileBuffer(const IFileArchive::SFileList::SEntry* item) = 0;
 
 		std::atomic_flag* m_fileFlags = nullptr;
 		std::byte* m_filesBuffer = nullptr;

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/CMountDirectoryArchive.h

@@ -0,0 +1,63 @@
+#ifndef _NBL_SYSTEM_C_MOUNT_DIRECTORY_ARCHIVE_H_INCLUDED_
+#define _NBL_SYSTEM_C_MOUNT_DIRECTORY_ARCHIVE_H_INCLUDED_
+
+#include "nbl/system/IFileArchive.h"
+
+#include "nbl/system/IFile.h"
+
+namespace nbl::system {
+
+
+
+class CMountDirectoryArchive : public IFileArchive
+{
+    ISystem* m_system;
+
+public:
+    inline CMountDirectoryArchive(path&& _defaultAbsolutePath, system::logger_opt_smart_ptr&& logger, ISystem* system) :
+        IFileArchive(std::move(_defaultAbsolutePath), std::move(logger))
+    {
+        m_system = system;
+    }
+
+    core::smart_refctd_ptr<IFile> getFile(const path& pathRelativeToArchive, const std::string_view& password) override
+    {
+        {
+            //std::unique_lock(itemMutex); already inside `getItemFromPath`
+            if (!getItemFromPath(pathRelativeToArchive))
+                return nullptr;
+        }
+        system::ISystem::future_t<core::smart_refctd_ptr<system::IFile>> future;
+        m_system->createFile(future, m_defaultAbsolutePath / pathRelativeToArchive, system::IFile::ECF_READ);
+        if (auto file = future.acquire())
+            return *file;
+    }
+
+    SFileList listAssets(const path& asset_path) const override
+    {
+        populateItemList(asset_path);
+        return IFileArchive::listAssets(asset_path);
+    }
+    SFileList listAssets() const override {
+        populateItemList(path());
+        return IFileArchive::listAssets();
+    }
+
+    void populateItemList(const path& p) const {
+        auto items = m_system->listItemsInDirectory(m_defaultAbsolutePath/p);
+        auto new_entries = std::make_shared<core::vector<SFileList::SEntry>>();
+        for (auto item : items)
+        {
+            if (item.has_extension())
+            {
+                auto relpath = item.lexically_relative(m_defaultAbsolutePath);
+                auto entry = SFileList::SEntry{ relpath, 0xdeadbeefu, 0xdeadbeefu, 0xdeadbeefu, EAT_NONE };
+                new_entries->push_back(entry);
+            }
+        }
+        m_items.store({new_entries});
+    }
+};
+
+} //namespace nbl::system
+#endif