Fstrugar/1.5.0 staging (#32)

Update to 1.5.0; major refactor and upgrades

Author: fstrugar-nv

.gitignore

@@ -1,9 +1,10 @@
 bin/
 build*/
 .vs
-nrd.cfg
-omm.cfg
+Nrd.cfg
+Omm.cfg
 tests/output/*
+.vscode/
 
 # local project files for shader development outside of VS
 *.sublime-*

.gitlab-ci.yml

@@ -1,30 +1,30 @@
-[submodule "external/RayTracingDenoiser"]
-	path = external/RayTracingDenoiser
+[submodule "External/RayTracingDenoiser"]
+	path = External/Nrd
 	url = https://github.com/NVIDIA-RTX/NRD
-[submodule "external/Opacity-MicroMap-SDK"]
-	path = external/Opacity-MicroMap-SDK
-	url = https://github.com/NVIDIA-RTX/OMM
+[submodule "External/Opacity-MicroMap-SDK"]
+	path = External/Omm
+	url = https://github.com/NVIDIA-RTX/OMM.git
 	branch = main-minimal
-[submodule "donut/nvrhi"]
-	path = donut/nvrhi
-	url = https://github.com/NVIDIA-RTX/NVRHI
-[submodule "external/RTXDI"]
-	path = external/RTXDI
-	url = https://github.com/NVIDIAGameWorks/RTXDI
-	branch = sdk-only
-[submodule "media"]
-	path = media
-	url = https://github.com/NVIDIAGameWorks/Path-Tracing-SDK-Media
-[submodule "external/Streamline"]
-	path = external/Streamline
-	url = https://github.com/NVIDIAGameWorks/Streamline.git
-[submodule "external/NVAPI"]
-	path = external/NVAPI
+[submodule "External/NVAPI"]
+	path = External/NVAPI
 	url = https://github.com/NVIDIA/nvapi.git
 	branch = 530
-[submodule "external/cxxopts"]
-	path = external/cxxopts
+[submodule "External/cxxopts"]
+	path = External/cxxopts
 	url = https://github.com/jarro2783/cxxopts.git
-[submodule "donut/ShaderMake"]
-	path = donut/ShaderMake
-	url = https://github.com/NVIDIA-RTX/ShaderMake
+[submodule "External/rtxdi-runtime"]
+	path = External/Rtxdi
+	url = https://github.com/NVIDIA-RTX/RTXDI-Library.git
+[submodule "External/donut"]
+	path = External/Donut
+	url = https://github.com/NVIDIA-RTX/Donut
+	branch = main
+[submodule "Assets"]
+	path = Assets
+	url = https://github.com/NVIDIA-RTX/RTXPT-Assets.git
+[submodule "External/Streamline"]
+	path = External/Streamline
+	url = https://github.com/NVIDIAGameWorks/Streamline.git
+[submodule "External/Rtxtf"]
+	path = External/Rtxtf
+	url = https://github.com/NVIDIA-RTX/RTXTF-Library

.gitmodules

@@ -1,59 +1,114 @@
 #
 # Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
-# 
+#
 # NVIDIA CORPORATION and its licensors retain all intellectual property
 # and proprietary rights in and to this software, related documentation
 # and any modifications thereto. Any use, reproduction, disclosure or
 # distribution of this software and related documentation without an express
 # license agreement from NVIDIA CORPORATION is strictly prohibited.
 
-cmake_minimum_required(VERSION 3.10)
+cmake_minimum_required(VERSION 3.18)
+set(CMAKE_WARN_DEPRECATED OFF CACHE BOOL "" FORCE)
+set(CMAKE_POLICY_DEFAULT_CMP0077 NEW)
+set(CMAKE_POLICY_DEFAULT_CMP0091 NEW)
+set(CMAKE_POLICY_DEFAULT_CMP0175 OLD) # streamline error
 
 project(RTXPathTracing)
 
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS ON)
 
+set(CMAKE_COMPILE_WARNING_AS_ERROR ON)
+
+if (MSVC)
+	set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
+
+	# Workaround for a Microsoft "fix" to std::mutex that happened in VS2022 v17.10.
+	# Using std::mutex with a DLL version of MSVCRT that is older than that VS version will lead to a crash.
+	# See https://developercommunity.visualstudio.com/t/Access-violation-with-std::mutex::lock-a/10664660
+	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /D_DISABLE_CONSTEXPR_MUTEX_CONSTRUCTOR")
+
+	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /MP")
+
+    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /D_ITERATOR_DEBUG_LEVEL=1")
+endif()
+
+# we can't run with DX11
+option(DONUT_WITH_DX11 OFF)
+
+# default VULKAN to OFF
+option(DONUT_WITH_VULKAN OFF "Enable the Vulkan version of Donut")
+
+# we want shader PDBs always embedded
+option(DONUT_EMBED_SHADER_PDBS "" ON)
+
 set (CMAKE_CONFIGURATION_TYPES "Debug;Release" CACHE STRING "" FORCE)
 
 set(RTXPT_LOCAL_CONFIG_ID "NONAME" CACHE STRING "Local user initials for user-specific settings")
 add_definitions( -DRTXPT_LOCAL_CONFIG_ID_STRING=std::string\(\"${RTXPT_LOCAL_CONFIG_ID}\"\) )
 
-#if (NOT EXISTS "${CMAKE_SOURCE_DIR}/external/NVAPI" OR NOT EXISTS "${CMAKE_SOURCE_DIR}/media")
-#    message(FATAL_ERROR "${CMAKE_SOURCE_DIR}/external/NVAPI and/or ${CMAKE_SOURCE_DIR}/media folders not present: \n!!!! please run update_dependencies.bat first !!!! ")
-#endif()
+#----------------------------------------------------------------------------------------------------------------------
+# Streamline config
+#set(FETCHCONTENT_QUIET OFF) <- use for a lot more detailed info from FetchContent
+option(DONUT_WITH_STREAMLINE "Enable streamline, separate package required" ON)
+set(STREAMLINE_DOWNLOAD_PATH "${CMAKE_SOURCE_DIR}/External/Streamline")
+
+# Use this to optionally download Streamline (and not as a submodule)
+#set(DONUT_STREAMLINE_FETCH_URL "https://github.com/NVIDIAGameWorks/Streamline.git" CACHE STRING "")
+#set(DONUT_STREAMLINE_FETCH_TAG "v2.7.2" CACHE STRING "")
+#set(DONUT_STREAMLINE_FETCH_DIR ${STREAMLINE_DOWNLOAD_PATH} CACHE STRING "Directory to fetch streamline to, empty uses build directory default")
+set(DONUT_STREAMLINE_SEARCH_PATHS ${STREAMLINE_DOWNLOAD_PATH} CACHE STRING "Search paths for streamline package")
+
+option(STREAMLINE_FEATURE_DLSS_SR   "Include DLSS-SR dll"           ON  )
+option(STREAMLINE_FEATURE_DLSS_RR   "Include DLSS-RR dll"           ON  )
+option(STREAMLINE_FEATURE_NRD       "Include NRD dll"               OFF )
+option(STREAMLINE_FEATURE_IMGUI     "Include Imgui dll"             ON  )
+option(STREAMLINE_FEATURE_NVPERF    "Include NSight Perf SDK dll"   OFF )
+option(STREAMLINE_FEATURE_REFLEX    "Include Reflex dll"            ON  )
+option(STREAMLINE_FEATURE_NIS       "Include NIS dll"               OFF )
+option(STREAMLINE_FEATURE_DLSS_FG   "Include DLSS-FG dll"           ON  )
+option(STREAMLINE_FEATURE_DEEPDVC   "Include DEEPDVC dll"           OFF )
+option(STREAMLINE_FEATURE_DIRECTSR  "Include DirectSR dll"          OFF )
+#----------------------------------------------------------------------------------------------------------------------
 
-option(STREAMLINE_INTEGRATION "Enable Streamline integration (Required for DLSS3.0 and etc.)" ON)
 
 option(NVRHI_WITH_NVAPI "Include NVAPI support (requires NVAPI SDK)" ON)
-set(NVAPI_INCLUDE_DIR "${CMAKE_SOURCE_DIR}/external/nvapi/" CACHE STRING "Path to NVAPI include headers/shaders" )
-set(NVAPI_LIBRARY "${CMAKE_SOURCE_DIR}/external/nvapi/amd64/nvapi64.lib" CACHE STRING "Path to NVAPI .lib file")
+set(NVAPI_INCLUDE_DIR "${CMAKE_SOURCE_DIR}/External/nvapi/" CACHE STRING "Path to NVAPI include headers/shaders" )
+set(NVAPI_LIBRARY "${CMAKE_SOURCE_DIR}/External/nvapi/amd64/nvapi64.lib" CACHE STRING "Path to NVAPI .lib file")
 
-set(DXC_CUSTOM_PATH "${CMAKE_SOURCE_DIR}/external/dxc/bin/x64/" CACHE STRING "Path to embedded dxc")
+set(DXC_CUSTOM_PATH "${CMAKE_SOURCE_DIR}/External/dxc/bin/x64/" CACHE STRING "Path to embedded dxc")
 set(DXC_PATH "${DXC_CUSTOM_PATH}/dxc.exe" CACHE STRING "Path to embedded dxc file for DX12")
 set(DXC_DXIL_EXECUTABLE "${DXC_CUSTOM_PATH}/dxc.exe" CACHE STRING "Path to embedded dxc file for DX12")
 #set(DXC_SPIRV_EXECUTABLE "${DXC_CUSTOM_PATH}/dxc.exe" CACHE STRING "Path to embedded dxc file for SPIRV") # default to using dxc from the Vulkan SDK; remove this to use embedded .dxc
 
-if (MSVC)
-    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /D_ITERATOR_DEBUG_LEVEL=1")
-endif()
+option (SHADERMAKE_FIND_DXC_SPIRV "Toggles whether to search for DXC for SPIR-V" ON)
 
 # option(USE_RAY_TRACING_DENOISER "Include NRD as part of the sample." ON)
-option(DONUT_WITH_ASSIMP "" OFF)
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/bin")
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}")
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_MINSIZEREL "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}")
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}")
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELWITHDEBINFO "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}")
 set(DONUT_SHADERS_OUTPUT_DIR "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/shaders/framework")
+option(DONUT_WITH_LZ4 "Include LZ4" OFF)
 
-add_subdirectory(donut)
+add_subdirectory("External")
 
 if (NVRHI_WITH_VULKAN OR NVRHI_WITH_DX12)
-	add_subdirectory(RTXPT)
-	set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT RTXPT)
+	add_subdirectory(Rtxpt)
+	set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT rtxpt)
 endif()
 
-add_subdirectory("external")
+
+#----------------------------------------------------------------------------------------------------------------------
+# Alternative way of obtaining assets (we're currently relying on git submodule but this is an option as well)
+#include(FetchContent)
+#set(RTXPT_ASSETS_FETCH_URL "https://gitlab-master.nvidia.com/rtx/path-tracing-sdk-assets")
+#set(RTXPT_ASSETS_FETCH_TAG "main")
+#set(RTXPT_ASSETS_FETCH_DIR "${CMAKE_SOURCE_DIR}/Assets")
+#message(STATUS "Updating assets from " ${RTXPT_ASSETS_FETCH_URL} ", tag " ${RTXPT_ASSETS_FETCH_TAG} ", into folder " ${RTXPT_ASSETS_FETCH_DIR} )
+#FetchContent_Declare(assets_download  GIT_REPOSITORY ${RTXPT_ASSETS_FETCH_URL}  GIT_TAG ${RTXPT_ASSETS_FETCH_TAG}  SOURCE_DIR ${RTXPT_ASSETS_FETCH_DIR}  GIT_PROGRESS TRUE)
+#FetchContent_MakeAvailable(assets_download)
+#----------------------------------------------------------------------------------------------------------------------

Assets

@@ -0,0 +1,136 @@
+#
+# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
+# 
+# NVIDIA CORPORATION and its licensors retain all intellectual property
+# and proprietary rights in and to this software, related documentation
+# and any modifications thereto. Any use, reproduction, disclosure or
+# distribution of this software and related documentation without an express
+# license agreement from NVIDIA CORPORATION is strictly prohibited.
+
+##########################################################################
+################################ Donut ####################################
+##########################################################################
+
+include(Donut/compileshaders.cmake)
+add_subdirectory(Donut)
+
+##########################################################################
+################################ UTIL ####################################
+##########################################################################
+function(util_get_shader_profile_from_name FILE_NAME DXC_PROFILE)
+    get_filename_component(EXTENSION ${FILE_NAME} EXT)
+    if ("${EXTENSION}" STREQUAL ".cs.hlsl")
+        set(DXC_PROFILE "cs" PARENT_SCOPE)
+    endif()
+    if ("${EXTENSION}" STREQUAL ".vs.hlsl")
+        set(DXC_PROFILE "vs" PARENT_SCOPE)
+    endif()
+    if ("${EXTENSION}" STREQUAL ".gs.hlsl")
+        set(DXC_PROFILE "gs" PARENT_SCOPE)
+    endif()
+    if ("${EXTENSION}" STREQUAL ".ps.hlsl")
+        set(DXC_PROFILE "ps" PARENT_SCOPE)
+    endif()
+endfunction()
+
+function(util_generate_shader_config_file OUT_FILE_NAME DIR DEFINES)
+    file(GLOB_RECURSE HLSL_FILES "${CMAKE_CURRENT_SOURCE_DIR}/${DIR}/*.hlsl")
+
+    set(out_content "")
+    foreach(FILE_NAME ${HLSL_FILES})
+        get_filename_component(NAME_ONLY ${FILE_NAME} NAME)
+        set(DXC_PROFILE "")
+        util_get_shader_profile_from_name(${FILE_NAME} DXC_PROFILE)
+        set(out_content "${out_content}${DIR}/${NAME_ONLY} -T ${DXC_PROFILE} -E main ${DEFINES}\n")
+    endforeach()
+
+    file(WRITE ${OUT_FILE_NAME} ${out_content})
+endfunction()
+
+##########################################################################
+########################### Nrd ###########################
+##########################################################################
+
+# see https://github.com/NVIDIA-RTX/NRD?tab=readme-ov-file#how-to-build
+# set(NRD_DXC_CUSTOM_PATH ${DXC_CUSTOM_PATH})
+set(NRD_DXC_PATH "${DXC_DXIL_EXECUTABLE}" CACHE STRING "DXC shader compiler path for NRD")
+set(NRD_SHADER_OUTPUT_PATH "${SHADER_OUTPUT_PATH}" CACHE STRING "")
+set(NRD_PROJECT_FOLDER "External/Nrd")
+set(NRD_NORMAL_ENCODING "2" CACHE STRING "Normal encoding variant (0-4, matches nrd::NormalEncoding)")
+set(NRD_ROUGHNESS_ENCODING "1" CACHE STRING "Roughness encoding variant (0-2, matches nrd::RoughnessEncoding)")
+set(NRD_IS_SUBMODULE ON)
+# NRD uses a custom output path for some reason
+set(GLOBAL_BIN_OUTPUT_PATH ${CMAKE_BINARY_DIR} CACHE STRING "")
+set(NRD_SHADERS_PATH "${CMAKE_BINARY_DIR}/NRDShaders" CACHE STRING "")
+option(NRD_EMBEDS_SPIRV_SHADERS "NRD embeds SPIRV shaders" OFF)
+option(NRD_EMBEDS_DXIL_SHADERS "NRD embeds DXIL shaders" OFF)
+option(NRD_EMBEDS_DXBC_SHADERS "NRD embeds DXBC shaders" OFF)
+option(NRD_DISABLE_SHADER_COMPILATION "" ON)
+option(NRD_USE_PRECOMPILED_SHADERS "" OFF)
+
+add_subdirectory("Nrd")
+
+# Let CMake generate the nrd_shaders.cfg file 
+util_generate_shader_config_file(
+    "Nrd.cfg" 
+    "Nrd/Shaders/Source"
+    "-D NRD_COMPILER_DXC=1 -D NRD_NORMAL_ENCODING=${NRD_NORMAL_ENCODING} -D NRD_ROUGHNESS_ENCODING=${NRD_ROUGHNESS_ENCODING}"
+)
+
+# Compile all shaders in nrd_shaders.cfg 
+donut_compile_shaders(
+    TARGET nrd_shaders
+    CONFIG ${CMAKE_CURRENT_SOURCE_DIR}/Nrd.cfg
+    SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/Nrd/Shaders/Include
+    FOLDER "NRD"
+    DXIL ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/shaders/nrd/dxil
+    SPIRV_DXC ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/shaders/nrd/spirv
+    CFLAGS "-WX -O3 -enable-16bit-types -all_resources_bound"
+    INCLUDES ${CMAKE_BINARY_DIR}/_deps/mathlib-src ${CMAKE_CURRENT_SOURCE_DIR}/Nrd/Shaders/Include ${CMAKE_CURRENT_SOURCE_DIR}/Nrd/Shaders/Resources
+)
+
+##########################################################################
+########################### Opacity Micro-Map SDK ########################
+##########################################################################
+
+option(OMM_INTEGRATION_LAYER_NVRHI "" ON)
+option(OMM_ENABLE_PRECOMPILED_SHADERS_DXIL "" OFF)
+option(OMM_ENABLE_PRECOMPILED_SHADERS_SPIRV "" OFF)
+option(OMM_ENABLE_BENCHMARK "" OFF)
+option(OMM_ENABLE_TESTS "" OFF)
+
+set(OMM_PROJECT_FOLDER "Omm")
+add_subdirectory("Omm")
+
+# Let CMake generate the omm_shaders.cfg file 
+util_generate_shader_config_file(
+    "Omm.cfg" 
+    "Omm/libraries/omm-lib/shaders"
+    "-D COMPILER_DXC=1"
+)
+
+# Compile all shaders in omm.cfg 
+donut_compile_shaders(
+    TARGET omm_shaders
+    CONFIG ${CMAKE_CURRENT_SOURCE_DIR}/Omm.cfg
+    SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/Omm/libraries/omm-lib/include
+    FOLDER "Opacity Micro-Map SDK"
+    DXIL ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/shaders/omm/dxil
+    SPIRV_DXC ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/shaders/omm/spirv
+)
+
+##########################################################################
+################################ RTXDI SDK ###############################
+##########################################################################
+
+set(RTXDI_SKIP_SHADER_VALIDATION ON CACHE STRING "Skip RTXDI shader validation")
+
+add_subdirectory("Rtxdi")
+
+##########################################################################
+################################ cxxopts ###############################
+##########################################################################
+
+if (NOT TARGET cxxopts)
+    add_subdirectory("cxxopts")
+endif()