create INTERFACE_TO_BUILTINS, add NblExtExamplesAPIBuiltinsSPIRV target created with NBL_REGISTER_SPIRV_SHADERS utility, update CSimpleDebugRenderer.hpp, change location of unified.hlsl

Author: AnastaZIuk

CMakeLists.txt

@@ -97,6 +97,7 @@ if(NBL_BUILD_EXAMPLES)
 		target_precompile_headers(${T} REUSE_FROM "${NBL_EXAMPLES_API_TARGET}")
 		LINK_BUILTIN_RESOURCES_TO_TARGET(${T} NblExtExamplesAPIBuiltinsSource)
 		LINK_BUILTIN_RESOURCES_TO_TARGET(${T} NblExtExamplesAPIBuiltinsInclude)
+		LINK_BUILTIN_RESOURCES_TO_TARGET(${T} NblExtExamplesAPIBuiltinsSPIRV)
     endforeach()
 
 	NBL_ADJUST_FOLDERS(examples)

common/CMakeLists.txt

@@ -13,6 +13,20 @@ nbl_create_ext_library_project(ExamplesAPI "" "${CMAKE_CURRENT_SOURCE_DIR}/src/n
 set_target_properties(${LIB_NAME} PROPERTIES DISABLE_PRECOMPILE_HEADERS OFF)
 target_precompile_headers(${LIB_NAME} PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/include/nbl/examples/PCH.hpp")
 
+set(COMMON_INCLUDE_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/include")
+
+function(INTERFACE_TO_BUILTINS TARGET)
+    #[[
+        even though builtin target is static library its still valid to reuse 
+        common PCH to boost its build speed to not preprocess entire Nabla again
+    ]]
+    set_target_properties(${TARGET} PROPERTIES DISABLE_PRECOMPILE_HEADERS OFF)
+    target_precompile_headers(${TARGET} REUSE_FROM "${LIB_NAME}")
+
+    target_include_directories(${TARGET} PUBLIC "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/include")
+    target_link_libraries(${TARGET} INTERFACE ${LIB_NAME})
+endfunction()
+
 function(REGISTER_COMMON_BUILTINS)
 	cmake_parse_arguments(EX "" "TARGET;ARCHIVE_ABS_ENTRY;ARCHIVE_NAMESPACE" "GLOB_RGX" ${ARGN})
 
@@ -36,13 +50,7 @@ function(REGISTER_COMMON_BUILTINS)
 	endforeach()
 
     ADD_CUSTOM_BUILTIN_RESOURCES(${EX_TARGET} EXAMPLES_RESOURCES_TO_EMBED "${INPUT_DIRECTORY}" "${EX_ARCHIVE_ABS_ENTRY}" "${EX_ARCHIVE_NAMESPACE}" "${OUTPUT_INCLUDE}" "${OUTPUT_SRC}")
-
-    # even though builtin target is static library its still valid to reuse common PCH to boost its build speed to not preprocess entire Nabla again
-    set_target_properties(${EX_TARGET} PROPERTIES DISABLE_PRECOMPILE_HEADERS OFF)
-    target_precompile_headers(${EX_TARGET} REUSE_FROM "${LIB_NAME}")
-
-    target_include_directories(${EX_TARGET} PUBLIC "${INPUT_DIRECTORY}/include")
-    target_link_libraries(${EX_TARGET} INTERFACE ${LIB_NAME})
+    INTERFACE_TO_BUILTINS(${EX_TARGET})
 endfunction()
 
 #! common example API builtins as static library targets linked to each example

common/include/nbl/examples/common/BuiltinResourcesApplication.hpp

@@ -4,20 +4,25 @@
 #ifndef _NBL_EXAMPLES_BUILTIN_RESOURCE_APPLICATION_HPP_INCLUDED_
 #define _NBL_EXAMPLES_BUILTIN_RESOURCE_APPLICATION_HPP_INCLUDED_
 
-
 // we need a system, logger and an asset manager
 #include "nbl/application_templates/MonoAssetManagerApplication.hpp"
 
 #ifdef NBL_EMBED_BUILTIN_RESOURCES
 	#include "nbl/builtin/examples/include/CArchive.h"
 	#include "nbl/builtin/examples/src/CArchive.h"
-	// TODO: the build `nbl/examples` archive
-#if __has_include("nbl/this_example/builtin/CArchive.h")
-	#include "nbl/this_example/builtin/CArchive.h"
-#endif
+	#include "nbl/builtin/examples/build/spirv/CArchive.h"
+	#if __has_include("nbl/this_example/builtin/CArchive.h")
+		#include "nbl/this_example/builtin/CArchive.h"
+	#endif
+	// TODO: (**) there should be also 5th arch "nbl/this_example/builtin/build/spirv/CArchive.h"
+	/*
+		#if __has_include("nbl/this_example/builtin/build/spirv/CArchive.h")
+		#include "nbl/this_example/builtin/build/spirv/CArchive.h"
+		#endif
+	*/
+	//! this ain't meant to be the same as this_example ordinary archive
 #endif
 
-
 namespace nbl::examples
 {
 
@@ -40,32 +45,35 @@ class BuiltinResourcesApplication : public virtual application_templates::MonoAs
 
 			using namespace core;
 
-			smart_refctd_ptr<system::IFileArchive> examplesHeaderArch,examplesSourceArch,examplesBuildArch,thisExampleArch;
-		#ifdef NBL_EMBED_BUILTIN_RESOURCES
+			smart_refctd_ptr<system::IFileArchive> examplesHeaderArch,examplesSourceArch,examplesBuildSpirvArch,thisExampleArch;
+			#ifdef NBL_EMBED_BUILTIN_RESOURCES
 			examplesHeaderArch = core::make_smart_refctd_ptr<nbl::builtin::examples::include::CArchive>(smart_refctd_ptr(m_logger));
 			examplesSourceArch = core::make_smart_refctd_ptr<nbl::builtin::examples::src::CArchive>(smart_refctd_ptr(m_logger));
-			// TODO: the build archive
+			examplesBuildSpirvArch = core::make_smart_refctd_ptr<nbl::builtin::examples::build::spirv::CArchive>(smart_refctd_ptr(m_logger));
 
 			#ifdef _NBL_THIS_EXAMPLE_BUILTIN_C_ARCHIVE_H_
 				thisExampleArch = make_smart_refctd_ptr<nbl::this_example::builtin::CArchive>(smart_refctd_ptr(m_logger));
 			#endif
-		#else
+			// TODO: (**)
+			#else
 			examplesHeaderArch = make_smart_refctd_ptr<system::CMountDirectoryArchive>(localInputCWD/"../common/include/nbl/examples",smart_refctd_ptr(m_logger),m_system.get());
 			examplesSourceArch = make_smart_refctd_ptr<system::CMountDirectoryArchive>(localInputCWD/"../common/src/nbl/examples",smart_refctd_ptr(m_logger),m_system.get());
-// TODO: examplesBuildArch =
+			examplesBuildSpirvArch = make_smart_refctd_ptr<system::CMountDirectoryArchive>(NBL_EXAMPLES_BUILD_SPIRV_MOUNT_POINT, smart_refctd_ptr(m_logger), m_system.get());
 			thisExampleArch = make_smart_refctd_ptr<system::CMountDirectoryArchive>(localInputCWD/"app_resources",smart_refctd_ptr(m_logger),m_system.get());
-		#endif
+			// TODO: (**)
+			#endif
 			// yes all 3 aliases are meant to be the same
 			m_system->mount(std::move(examplesHeaderArch),"nbl/examples");
 			m_system->mount(std::move(examplesSourceArch),"nbl/examples");
-//			m_system->mount(std::move(examplesBuildArch),"nbl/examples");
+			m_system->mount(std::move(examplesBuildSpirvArch),"nbl/examples");
 			if (thisExampleArch)
 				m_system->mount(std::move(thisExampleArch),"app_resources");
+			// TODO: (**)
 
 			return true;
 		}
 };
 
 }
 
-#endif // _CAMERA_IMPL_
+#endif // _NBL_EXAMPLES_BUILTIN_RESOURCE_APPLICATION_HPP_INCLUDED_

common/include/nbl/examples/geometry/CSimpleDebugRenderer.hpp

@@ -97,14 +97,26 @@ class CSimpleDebugRenderer final : public core::IReferenceCounted
 			// load shader
 			smart_refctd_ptr<IShader> shader;
 			{
-				const auto bundle = assMan->getAsset("nbl/examples/geometry/shaders/unified.hlsl",{});
-// TODO: Arek
-				//const auto bundle = assMan->getAsset("nbl/examples/geometry/shaders/unified.spv",{});
+				// TODO & NOTE: tmp, maybe I will turn it into CMake option
+				#define NBL_USE_PRECOMPILED_SPIRV
+
+				#ifdef NBL_USE_PRECOMPILED_SPIRV
+				constexpr std::string_view key = "nbl/examples/shaders/geometry/unified.hlsl.spv";
+				#else
+				constexpr std::string_view key = "nbl/examples/shaders/geometry/unified.hlsl";
+				#endif // NBL_USE_PRECOMPILED_SPIRV
+
+				const auto bundle = assMan->getAsset(key.data(), {});
+
+				//const auto bundle = assMan->getAsset("nbl/examples/shaders/geometry/unified.hlsl.spv",{});
 				const auto contents = bundle.getContents();
 				if (contents.empty() || bundle.getAssetType()!=IAsset::ET_SHADER)
 					return nullptr;
 				shader = IAsset::castDown<IShader>(contents[0]);
-				shader = device->compileShader({.source=shader.get()});
+				
+				#ifndef NBL_USE_PRECOMPILED_SPIRV
+				shader = device->compileShader({ .source = shader.get() });
+				#endif // NBL_USE_PRECOMPILED_SPIRV
 				if (!shader)
 					return nullptr;
 			}

common/src/nbl/examples/CMakeLists.txt

@@ -1,4 +1,21 @@
-# TODO builtin SPIR-V shaders
-# add_subdirectory(geometry EXCLUDE_FROM_ALL)
+set(SPIRV_TARGET_V 6_8)
 
-# TODO: make docs once I get n4ce embed SPIRV tool to build system and then use the tool with Matts new shader
+set(COMMON_OPTIONS
+	-I "${COMMON_INCLUDE_DIRECTORY}"
+)
+
+NBL_REGISTER_SPIRV_SHADERS(
+	MOUNT_POINT_DEFINE
+		NBL_EXAMPLES_BUILD_SPIRV_MOUNT_POINT
+
+    ARCHIVE
+        TARGET NblExtExamplesAPIBuiltinsSPIRV
+        INPUT_DIRECTORY .
+        NAMESPACE nbl::builtin::examples::build::spirv
+
+	INPUTS
+		KEY shaders/geometry/unified.hlsl COMPILE_OPTIONS ${COMMON_OPTIONS} -T lib_${SPIRV_TARGET_V}
+		# KEY <xyz> COMPILE_OPTIONS ${COMMON_OPTIONS} -T <target>_${SPIRV_TARGET_V}
+)
+
+INTERFACE_TO_BUILTINS(NblExtExamplesAPIBuiltinsSPIRV)