AMD FidelityFX SDK 1.1.1

Author: kurbeco

.gitignore

@@ -361,3 +361,15 @@ MigrationBackup/
 # Folders created by the media delivery tool
 /media/
 /media-cache/
+
+sdk/src/components/frameinterpolation/FrameInterpolation_GDK/Gaming.Xbox.Scarlett.x64/
+
+sdk/src/components/fsr1/FSR1_GDK/Gaming.Xbox.Scarlett.x64/
+
+sdk/src/components/fsr2/FSR2_GDK/Gaming.Xbox.Scarlett.x64/
+
+sdk/src/components/fsr3/FSR3_GDK/Gaming.Xbox.Scarlett.x64/
+
+sdk/src/components/fsr3upscaler/FSR3Upscaler_GDK/Gaming.Xbox.Scarlett.x64/
+
+sdk/src/components/opticalflow/OpticalFlow_GDK/Gaming.Xbox.Scarlett.x64/

.gitlab-ci.yml

@@ -221,7 +221,7 @@ package_release_samples_pc:
   - echo "Packaging FidelityFX SDK Samples"
   - 'copy %VULKAN_SDK%\Bin\glslc.exe .\bin'
   artifacts:
-    name: "FIDELITYFX-SDK-SAMPLES-%CI_COMMIT_TAG%-%CI_COMMIT_REF_NAME%-%CI_COMMIT_SHORT_SHA%"
+    name: "FIDELITYFX-SDK-SAMPLES-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
     paths:
     - ./bin
     - ./docs
@@ -235,4 +235,4 @@ package_release_samples_pc:
     - ./common.cmake
     - ./LICENSE.txt
     - ./readme.md
-    - ./sample.cmake
+    - ./sample.cmake

BuildCauldronSolution.bat

@@ -0,0 +1,62 @@
+:: This file is part of the FidelityFX SDK.
+::
+:: Copyright (C) 2024 Advanced Micro Devices, Inc.
+:: 
+:: Permission is hereby granted, free of charge, to any person obtaining a copy
+:: of this software and associated documentation files(the "Software"), to deal
+:: in the Software without restriction, including without limitation the rights
+:: to use, copy, modify, merge, publish, distribute, sublicense, and /or sell
+:: copies of the Software, and to permit persons to whom the Software is
+:: furnished to do so, subject to the following conditions :
+::
+:: The above copyright notice and this permission notice shall be included in
+:: all copies or substantial portions of the Software.
+::
+:: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+:: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+:: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+:: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+:: LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+:: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+:: THE SOFTWARE.
+
+@echo off
+
+echo ===============================================================
+echo.
+echo  FidelityFX Build System
+echo.
+echo ===============================================================
+echo Checking pre-requisites... 
+
+:: Check if cmake is installed
+cmake --version > nul 2>&1
+if %errorlevel% NEQ 0 (
+    echo Cannot find path to CMake. Is CMake installed? Exiting...
+    exit /b -1
+) else (
+    echo CMake Ready.
+)
+
+echo.
+echo Building Cauldron (dev) solution
+echo.
+
+:: Check directories exist and create if not
+if not exist build\ (
+	mkdir build 
+)
+
+cd build
+:: Clear out CMakeCache
+if exist CMakeFiles\ (
+	rmdir /S /Q CMakeFiles
+)
+if exist CMakeCache.txt (
+	del /S /Q CMakeCache.txt
+)
+cmake .. -D BUILD_TYPE=CAULDRON
+
+:: Come back to root level
+cd ..
+pause

BuildSamplesSolutionDX12.bat

@@ -1,7 +1,7 @@
 :: This file is part of the FidelityFX SDK.
 ::
 :: Copyright (C) 2024 Advanced Micro Devices, Inc.
-:: 
+::
 :: Permission is hereby granted, free of charge, to any person obtaining a copy
 :: of this software and associated documentation files(the "Software"), to deal
 :: in the Software without restriction, including without limitation the rights
@@ -33,13 +33,15 @@ set samples_build_options=-DRUNTIME_SHADER_RECOMPILE=0
 set sdk_build_options=-DFFX_AUTO_COMPILE_SHADERS=1
 
 set build_as_dll=
-set /P build_as_dll=Build the SDK as DLL [y/n]? 
+set /P build_as_dll=Build the SDK as DLL [y/n]?
 
 if /i "%build_as_dll%" == "Y" (
     set sdk_build_options=-DFFX_AUTO_COMPILE_SHADERS=1 -DFFX_BUILD_AS_DLL=1
     set samples_build_options=-DFFX_BUILD_AS_DLL=1
 )
 
+:select_component
+
 ECHO 1. ALL
 ECHO 2. BLUR
 ECHO 3. BREADCRUMBS
@@ -58,7 +60,7 @@ ECHO 15. SSSR
 ECHO 16. VRS
 ECHO.
 
-set /P samples=Enter numbers of which samples to build [space delimitted]: 
+set /P samples=Enter numbers of which samples to build [space delimitted]:
 :loop
 for /f "tokens=1*" %%a in ("%samples%") do (
    if %%a == 1 (
@@ -91,7 +93,6 @@ for /f "tokens=1*" %%a in ("%samples%") do (
    )
    if %%a == 8 (
     set samples_build_options=-DFFX_FSR=ON %samples_build_options%
-	:: Only need to build FSR1 which is brought in via lib import, ffx api has FSR2/3 built into dll
     set sdk_build_options=-DFFX_FSR1=ON %sdk_build_options%
    )
    if %%a == 9 (
@@ -130,18 +131,31 @@ for /f "tokens=1*" %%a in ("%samples%") do (
 )
 if defined samples goto :loop
 
+:: determine architecture
+if /i "%PROCESSOR_ARCHITECTURE%" == "ARM64" (
+    set arch=ARM64
+    set samples_build_options=-AARM64 -DCMAKE_GENERATOR_PLATFORM=ARM64 %samples_build_options%
+    set sdk_build_options=-AARM64 -DCMAKE_GENERATOR_PLATFORM=ARM64 %sdk_build_options%
+) else (
+    set arch=X64
+    set samples_build_options=-Ax64 -DCMAKE_GENERATOR_PLATFORM=x64 %samples_build_options%
+    set sdk_build_options=-Ax64 -DCMAKE_GENERATOR_PLATFORM=x64 %sdk_build_options%
+)
+echo architecture %arch% detected
+echo.
+
 set build_type=-DBUILD_TYPE=SAMPLES_DX12
-set sdk_build_options=-DFFX_API_BACKEND=DX12_X64 %sdk_build_options%
+set sdk_build_options=-DFFX_API_BACKEND=DX12_%arch% %sdk_build_options%
 
 :: Start by building the backend SDK
-echo Building native x64 backends: %sdk_build_options%
+echo Building native %arch% backends: %sdk_build_options%
 cd sdk
 call BuildFidelityFXSDK.bat %sdk_build_options%
 cd ..
 
 :: Check directories exist and create if not
 if not exist build\ (
-    mkdir build 
+    mkdir build
 )
 
 cd build
@@ -154,10 +168,10 @@ if exist CMakeCache.txt (
 )
 
 echo.
-echo Building SDK sample solutions %samples_build_options% 
+echo Building SDK sample solutions %samples_build_options%
 echo.
 
-cmake -A x64 .. %build_type% %samples_build_options% 
+cmake .. %build_type% %samples_build_options%
 
 :: Come back to root level
 cd ..

BuildSamplesSolutionVK.bat

@@ -40,6 +40,8 @@ if /i "%build_as_dll%" == "Y" (
     set samples_build_options=-DFFX_BUILD_AS_DLL=1
 )
 
+:select_component
+
 ECHO 1. ALL
 ECHO 2. BLUR
 ECHO 3. BREADCRUMBS
@@ -91,7 +93,6 @@ for /f "tokens=1*" %%a in ("%samples%") do (
    )
    if %%a == 8 (
     set samples_build_options=-DFFX_FSR=ON %samples_build_options%
-    :: Only need to build FSR1 which is brought in via lib import, ffx api has FSR2/3 built into dll
     set sdk_build_options=-DFFX_FSR1=ON %sdk_build_options%
    )
    if %%a == 9 (

CMakeLists.txt

@@ -1,17 +1,17 @@
 # This file is part of the FidelityFX SDK.
-# 
+#
 # Copyright (C) 2024 Advanced Micro Devices, Inc.
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files(the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
 # to use, copy, modify, merge, publish, distribute, sublicense, and /or sell
 # copies of the Software, and to permit persons to whom the Software is
 # furnished to do so, subject to the following conditions :
-# 
+#
 # The above copyright notice and this permission notice shall be included in
 # all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -50,9 +50,9 @@ include(common)
 include(sample)
 
 # Configuration setup
-set(CMAKE_GENERATOR_PLATFORM x64)
-
-if (CMAKE_GENERATOR_PLATFORM STREQUAL x64)
+if (CMAKE_GENERATOR_PLATFORM STREQUAL x64 OR
+	CMAKE_GENERATOR_PLATFORM STREQUAL ARM64 OR
+	CMAKE_GENERATOR_PLATFORM STREQUAL ARM64EC)
     message(STATUS "Creating sample configs ...")
 	set(CMAKE_CONFIGURATION_TYPES "")
 	if (CAULDRON_DX12)
@@ -61,14 +61,14 @@ if (CMAKE_GENERATOR_PLATFORM STREQUAL x64)
 		createConfig(DX12 ReleaseDX12 RELEASE)
 		list(APPEND CMAKE_CONFIGURATION_TYPES "DebugDX12;RelWithDebInfoDX12;ReleaseDX12;")
 	endif()
-	
+
 	if (CAULDRON_VK)
 		createConfig(VK DebugVK DEBUG)
 		createConfig(VK RelWithDebInfoVK RELWITHDEBINFO)
 		createConfig(VK ReleaseVK RELEASE)
 		list(APPEND CMAKE_CONFIGURATION_TYPES "DebugVK;RelWithDebInfoVK;ReleaseVK;")
 	endif()
-    
+
     message(STATUS "Generated with config types: ${CMAKE_CONFIGURATION_TYPES}")
 
     # Set compile definitions as well
@@ -83,7 +83,7 @@ if (CMAKE_GENERATOR_PLATFORM STREQUAL x64)
     )
 
 else()
-    message(FATAL_ERROR "Requested architecture not yet supported!)")
+    message(FATAL_ERROR "Requested architecture ${CMAKE_GENERATOR_PLATFORM} not yet supported!)")
 endif()
 
 # Ouput exe to bin directory
@@ -102,12 +102,12 @@ endif()
 add_library(ffx_backend_native STATIC IMPORTED)
 set_target_properties(ffx_backend_native PROPERTIES
 					  IMPORTED_CONFIGURATIONS "DebugDX12;DebugVK;RelWithDebInfoDX12;RelWithDebInfoVK;ReleaseDX12;ReleaseVK"
-					  IMPORTED_LOCATION_DEBUGDX12 "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_dx12_x64d.lib"
-					  IMPORTED_LOCATION_RELEASEDX12 "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_dx12_x64.lib"
-					  IMPORTED_LOCATION_RELWITHDEBINFODX12 "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_dx12_x64drel.lib"
-					  IMPORTED_LOCATION_DEBUGVK "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_vk_x64d.lib"
-					  IMPORTED_LOCATION_RELEASEVK "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_vk_x64.lib"
-					  IMPORTED_LOCATION_RELWITHDEBINFOVK "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_vk_x64drel.lib")
+					  IMPORTED_LOCATION_DEBUGDX12 "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_dx12_${CMAKE_GENERATOR_PLATFORM}d.lib"
+					  IMPORTED_LOCATION_RELEASEDX12 "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_dx12_${CMAKE_GENERATOR_PLATFORM}.lib"
+					  IMPORTED_LOCATION_RELWITHDEBINFODX12 "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_dx12_${CMAKE_GENERATOR_PLATFORM}drel.lib"
+					  IMPORTED_LOCATION_DEBUGVK "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_vk_${CMAKE_GENERATOR_PLATFORM}d.lib"
+					  IMPORTED_LOCATION_RELEASEVK "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_vk_${CMAKE_GENERATOR_PLATFORM}.lib"
+					  IMPORTED_LOCATION_RELWITHDEBINFOVK "${SDK_ROOT}/bin/ffx_sdk/ffx_backend_vk_${CMAKE_GENERATOR_PLATFORM}drel.lib")
 
 if (FFX_BUILD_AS_DLL)
     file(GLOB SDK_DLLS "${SDK_ROOT}/bin/ffx_sdk/*.dll")

ClearMediaCache.bat

@@ -22,7 +22,7 @@
 
 @echo off
 
-SET ffx_sdk_root=%~dp0
+SET ffx_sdk_root="%~dp0"
 
 echo Clearing media delivery cache for SDK root: %ffx_sdk_root%
 

PrebuiltSignedDLL/amd_fidelityfx_dx12.dll

@@ -25,7 +25,7 @@
 :: Known bundle SHA256 hash to attempt to download
 SET default_bundle_sha256=7c82a9704f11c082ad12115eadb944e7884a73cb678bb51e8c7486a3190c7f98
 
-SET ffx_sdk_root=%~dp0
+SET ffx_sdk_root="%~dp0"
 
 SET ARG=%1
 IF DEFINED ARG (

PrebuiltSignedDLL/amd_fidelityfx_vk.dll

@@ -1,17 +1,17 @@
 # This file is part of the FidelityFX SDK.
-# 
+#
 # Copyright (C) 2024 Advanced Micro Devices, Inc.
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files(the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
 # to use, copy, modify, merge, publish, distribute, sublicense, and /or sell
 # copies of the Software, and to permit persons to whom the Software is
 # furnished to do so, subject to the following conditions :
-# 
+#
 # The above copyright notice and this permission notice shall be included in
 # all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -63,6 +63,25 @@ set(FFX_COMPONENTS_PATH ${SDK_ROOT}/src/components)
 set(FFX_HOST_BACKENDS_PATH ${FFX_HOST_PATH}/backends)
 set(FFX_SRC_BACKENDS_PATH ${SDK_ROOT}/src/backends)
 
+#Setup pathing to FFX_API objects
+if (FFX_DEV_API)
+	set(FFX_API_ROOTPATH ${API_ROOT}/bin)
+	set(FFX_API_PATHNAME_DX12D 		${FFX_API_ROOTPATH}/amd_fidelityfx_dx12d)
+	set(FFX_API_PATHNAME_DX12DREL 	${FFX_API_ROOTPATH}/amd_fidelityfx_dx12drel)
+	set(FFX_API_PATHNAME_DX12 		${FFX_API_ROOTPATH}/amd_fidelityfx_dx12)
+	set(FFX_API_PATHNAME_VKD 		${FFX_API_ROOTPATH}/amd_fidelityfx_vkd)
+	set(FFX_API_PATHNAME_VKDREL 	${FFX_API_ROOTPATH}/amd_fidelityfx_vkdrel)
+	set(FFX_API_PATHNAME_VK 		${FFX_API_ROOTPATH}/amd_fidelityfx_vk)
+else()
+	set(FFX_API_ROOTPATH ${PREBUILT_SIGNED_DLL_ROOT})
+	set(FFX_API_PATHNAME_DX12D 		${FFX_API_ROOTPATH}/amd_fidelityfx_dx12)
+	set(FFX_API_PATHNAME_DX12DREL 	${FFX_API_ROOTPATH}/amd_fidelityfx_dx12)
+	set(FFX_API_PATHNAME_DX12 		${FFX_API_ROOTPATH}/amd_fidelityfx_dx12)
+	set(FFX_API_PATHNAME_VKD 		${FFX_API_ROOTPATH}/amd_fidelityfx_vk)
+	set(FFX_API_PATHNAME_VKDREL 	${FFX_API_ROOTPATH}/amd_fidelityfx_vk)
+	set(FFX_API_PATHNAME_VK 		${FFX_API_ROOTPATH}/amd_fidelityfx_vk)
+endif()
+
 # Set top level includes (all projects will need these to some extent)
 include_directories(${CAULDRON_ROOT}/framework/inc)
 include_directories(${CAULDRON_ROOT}/framework/libs)
@@ -73,7 +92,9 @@ include_directories(${SAMPLE_ROOT})
 include_directories(${SDK_ROOT}/include)
 
 
-if (CMAKE_GENERATOR_PLATFORM STREQUAL x64)
+if (CMAKE_GENERATOR_PLATFORM STREQUAL x64 OR
+    CMAKE_GENERATOR_PLATFORM STREQUAL ARM64 OR
+    CMAKE_GENERATOR_PLATFORM STREQUAL ARM64EC)
 	#Set so taken by default when creating custom configs
 	set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /MD")
 	set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} /MD")

UpdateMedia.bat

@@ -1,8 +1,8 @@
 <!-- @page page_ffx-api Introduction to FidelityFX API -->
 
-<h1>Introduction to the FidelityFX API</h1>
+<h1>Introduction to FidelityFX API</h1>
 
-The FidelityFX API is a simple API for FidelityFX techniques, created with a small ABI surface and forwards-compatibility. It is delivered in Dynamic Link Library form and consists of 5 functions, declared in [`ffx_api.h`](/ffx-api/include/ffx_api/ffx_api.h):
+The FidelityFX API is a simple API created for small ABI surface and forwards-compatibility. It is delivered in Dynamic Link Library form and consists of 5 functions, declared in [`ffx_api.h`](../../ffx-api/include/ffx_api/ffx_api.h):
 
 * `ffxCreateContext`
 * `ffxDestroyContext`
@@ -14,7 +14,8 @@ Arguments are provided in a linked list of structs, each having a header with a
 
 An application using the FidelityFX API must use one of the provided signed DLLs. This can be loaded at runtime with `LoadLibrary` and `GetProcAddress` (this is recommended) or at application startup using the dynamic linker via the .lib file.
 
-Backend-specific functionality (for DirectX 12 or Vulkan) is only supported with the respective DLL. Linking to both within the same application is not possible due to name resolution conflicts.
+Backend-specific functionality (for DirectX 12 or Vulkan) is only supported with the respective DLL.
+Linking to both within the same application is not possible due to name resolution conflicts.
 
 For convenience in C++ applications, helpers for initializing struct types correctly and linking headers are provided. Simply use the `.hpp` version of each header and replace the `ffx` prefix with the `ffx::` namespace.
 Note that the helper functions wrapping API functions only work when linking using the .lib file. Using them with runtime loading will result in linker errors.
@@ -32,7 +33,6 @@ typedef struct ffxApiHeader
 ```
 
 Each descriptor has an associated struct type, usually defined directly before the struct declaration in the header.
-
 The `type` field in the header must be set to that struct type. Failing to do this is undefined behavior and will likely result in crashes. The C++ headers (with extension `.hpp`) expose helpers for automatic initialization.
 
 The `pNext` field is used to specify additional parameters and extensions in a linked list (or "chain"). Some calls require chaining certain other structs.

common.cmake

@@ -54,3 +54,4 @@ If you find an issue, or have a request for the SDK, please consider opening an
 <!-- - @subpage page_running-samples_index "Running the samples for the SDK" -->
 <!-- - @subpage page_getting-started_naming-guidelines "FidelityFX naming guidelines for game applications" -->
 <!-- - @subpage page_ffx-api "Introduction to FidelityFX API" -->
+<!-- - @subpage page_migration "Migrating from FSR 3.0 to FSR 3.1" -->