Streamline SDK 2.8.0 Release

Author: gw280

CMakeLists.txt

@@ -20,14 +20,40 @@
 # SOFTWARE.
 #
 
+# We've got platform arch in some of our paths.  CMAKE_GENERATOR_PLATFORM/CMAKE_VS_PLATFORM_NAME contain a useful 
+# value when using Visual Studio generator (cmake -G), but not when using e.g. ninja
+if(STREAMLINE_TARGET_ARCH)
+    set(STREAMLINE_TARGET_ARCH "${STREAMLINE_TARGET_ARCH}")
+elseif(CMAKE_GENERATOR_PLATFORM)
+    set(STREAMLINE_TARGET_ARCH "${CMAKE_GENERATOR_PLATFORM}")
+else()
+    set(STREAMLINE_TARGET_ARCH "x64")
+    message(WARNING "STREAMLINE_TARGET_ARCH defaulting to ${STREAMLINE_TARGET_ARCH}")
+endif()
+
 # Variables
 set(STREAMLINE_SDK_ROOT "${CMAKE_CURRENT_SOURCE_DIR}" CACHE STRING "SL SDK Root Directory")
+set(STREAMLINE_SDK_BIN "${STREAMLINE_SDK_ROOT}/bin/${STREAMLINE_TARGET_ARCH}")
+set(STREAMLINE_SDK_LIB "${STREAMLINE_SDK_ROOT}/lib/${STREAMLINE_TARGET_ARCH}")
 find_path(STREAMLINE_INCLUDE_DIR sl.h HINTS "${STREAMLINE_SDK_ROOT}/include" NO_CACHE)
-find_path(STREAMLINE_PLUGIN_DLL_DIR sl.interposer.dll HINTS "${STREAMLINE_SDK_ROOT}/bin/${CMAKE_VS_PLATFORM_NAME}" "${STREAMLINE_SDK_ROOT}/bin/${CMAKE_VS_PLATFORM_NAME}/development" NO_CACHE)
-find_path(STREAMLINE_PLUGIN_JSON_DIR sl.interposer.json HINTS "${STREAMLINE_SDK_ROOT}/scripts" "${STREAMLINE_SDK_ROOT}/bin/${CMAKE_VS_PLATFORM_NAME}" NO_CACHE)
-find_path(STREAMLINE_SUPPORT_DLL_DIR nvngx_dlss.dll HINTS "${STREAMLINE_SDK_ROOT}/bin/${CMAKE_VS_PLATFORM_NAME}" NO_CACHE)
-find_library(STREAMLINE_INTERPOSER_LIB sl.interposer HINTS "${STREAMLINE_SDK_ROOT}/lib/${CMAKE_VS_PLATFORM_NAME}" NO_CACHE)
-find_file(STREAMLINE_INTERPOSER_DLL sl.interposer.dll HINTS "${STREAMLINE_SDK_ROOT}/bin/${CMAKE_VS_PLATFORM_NAME}" "${STREAMLINE_SDK_ROOT}/bin/${CMAKE_VS_PLATFORM_NAME}/development" NO_CACHE)
+find_path(STREAMLINE_PLUGIN_DLL_DIR sl.interposer.dll HINTS
+    "${STREAMLINE_SDK_BIN}"
+    "${STREAMLINE_SDK_BIN}/development"
+    NO_CACHE)
+find_path(STREAMLINE_PLUGIN_JSON_DIR sl.interposer.json HINTS
+    "${STREAMLINE_SDK_ROOT}/scripts"
+    "${STREAMLINE_SDK_BIN}"
+    NO_CACHE)
+find_path(STREAMLINE_SUPPORT_DLL_DIR nvngx_dlss.dll HINTS
+    "${STREAMLINE_SDK_BIN}"
+    NO_CACHE)
+find_library(STREAMLINE_INTERPOSER_LIB sl.interposer HINTS
+    "${STREAMLINE_SDK_LIB}"
+    NO_CACHE)
+find_file(STREAMLINE_INTERPOSER_DLL sl.interposer.dll HINTS
+    "${STREAMLINE_SDK_BIN}"
+    "${STREAMLINE_SDK_BIN}/development"
+    NO_CACHE)
 set(STREAMLINE_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}" CACHE STRING "Streamline Install Dir")
 
 # Sort Features

README.md

@@ -1,15 +1,13 @@
-# Streamline (SL) - Version 2.7.32
+# Streamline (SL) - Version 2.8.0
 
-Streamline is an open-sourced cross-IHV solution that simplifies integration of the latest NVIDIA and other independent hardware vendors’ super resolution technologies into applications and games. This framework allows developers to easily implement one single integration and enable multiple super-resolution technologies and other graphics effects supported by the hardware vendor.
+Streamline is an open-sourced cross-IHV solution that simplifies integration of the latest NVIDIA and other independent hardware vendors' super resolution technologies into applications and games. This framework allows developers to easily implement one single integration and enable multiple super-resolution technologies and other graphics effects supported by the hardware vendor.
 
 This repo contains the SDK for integrating Streamline into your application.
 
 For a high level overview, see the [NVIDIA Developer Streamline page](https://developer.nvidia.com/rtx/streamline)
 
 As of SL 2.0.0, it is now possible to recompile all of SL from source, with the exception of the DLSS-G plugin.  The DLSS-G plugin is provided as prebuilt DLLs only.  We also provide prebuilt DLLs (signed) for all other plugins that have source.  Most application developers will never need to rebuild SL themselves, especially for shipping; all of the pieces needed to develop, debug and ship an application that integrates SL and its features are provided in the pre-existing directories `bin/`, `include/`, and `lib/`.  Compiling from source is purely optional and likely of interest to a subset of SL application developers. For developers wishing to build SL from source, see the following sections.
 
-As of SL 2.7.32, binary artifacts (DLSS feature DLLs and Streamline DLLs) are not in the GitHub repository. In order to obtain these artifacts, please download the appropriate release zip from the [GitHub releases page](https://github.com/NVIDIA-RTX/Streamline/releases).
-
 ------
 
 ## Prerequisites
@@ -22,7 +20,8 @@ As of SL 2.7.32, binary artifacts (DLSS feature DLLs and Streamline DLLs) are no
 
 - Win10 20H1 (version 2004 - 10.0.19041) or newer
 - Install latest graphics driver (**if using NVIDIA GPU it MUST be 512.15 or newer**)
-- Install VS Code or VS2017/VS2019 with [SDK 10.0.19041+](https://go.microsoft.com/fwlink/?linkid=2120843)
+- Install VS Code or VS2017/VS2019/VS2022 with [SDK 10.0.19041+](https://go.microsoft.com/fwlink/?linkid=2120843)
+    - NOTE: VS2017 support is deprecated and will be removed in SL 2.9
 - Install "git".
 - Clone your fork to a local hard drive, make sure to use a NTFS drive on Windows (SL uses symbolic links)
 
@@ -129,5 +128,4 @@ A sample Streamline plugin source code is located [here](source/plugins/sl.templ
 
 ## Sample App and Source
 
-A sample application using Streamline may be found in [this git repo](https://github.com/NVIDIAGameWorks/Streamline_Sample)
-
+A sample application using Streamline may be found in [this git repo](https://github.com/NVIDIA-RTX/Streamline_Sample)

build.bat

@@ -103,5 +103,6 @@ if exist .\_project\vs2022\streamline.sln (
 ) else if exist .\_project\vs2019\streamline.sln (
     msbuild .\_project\vs2019\streamline.sln /m /t:%bld% /property:Configuration=%cfg% /property:Platform=x64
 ) else (
+    echo WARNING vs2017 is deprecated and will be removed in SL 2.9
     msbuild .\_project\vs2017\streamline.sln /m /t:%bld% /property:Configuration=%cfg% /property:Platform=x64
 )

changelog.txt

@@ -1,3 +1,46 @@
+======== Release 2.8.0 Entries ========
+
+    * Deprecated support for the following `sl::DLSSPreset` values:
+      - `sl::DLSSPreset::ePresetA`
+      - `sl::DLSSPreset::ePresetB`
+      - `sl::DLSSPreset::ePresetC`
+      - `sl::DLSSPreset::ePresetD`
+      - `sl::DLSSPreset::ePresetE`
+
+    * Deprecated support for building with Visual Studio 2017.
+
+    * Fixed a bug in `sl.dlss_g` which allowed applications to pass in an
+      invalid `sl::DLSSGOptions::numFramesToGenerate` value of zero, resulting
+      in the presentation of stale frame data when DLSS-FG was enabled.
+
+    * Fixed a bug in `sl.common` which could lead to graphical corruption and
+      instability in when used across different threads.
+
+    * Disabled loading of plugins via OTA Updates on non-production builds.
+
+    * Improved performance of the following functions:
+      - `slAllocateResources()`
+      - `slEvaluateFeature()`
+      - `slFreeResources()`
+      - `slGetFeatureFunction()`
+      - `slIsFeatureLoaded()`
+      - `slSetConstants()`
+      - `slSetTag()`
+      - `slSetTagForFrame()`
+
+    * Added debug event markers for the following APIs:
+      - `slEvaluateFeature()`
+      - `slSetTag()`
+      - `slSetTagForFrame()`
+
+    * Enabled debug names in all build configurations.
+
+    * Updated the FrameView SDK installer bundled with Streamline.
+
+    * Added documentation for frame pacing behavior. See section 14.1
+      "UNDERSTANDING FRAME PACING BEHAVIOR" in `ProgrammingGuideDLSS_G.md` for
+      more information.
+
 ======== Release 2.7.32 Entries ========
 
     * Removed the following directories from the repository. Release packages

docs/APIChangesAndImprovements.md

@@ -118,4 +118,3 @@ Streamline 2.0 **includes all the above mentioned v1.5 changes with the followin
 
 * Removed `slGetHook*` API
 * New API `slGetNativeInterface` in combination with `slUpgradeIntercace` is now used to significantly simplify manual hooking.
-

docs/DLSS Programming Guide.pdf

@@ -161,4 +161,3 @@ Place the `sl.dlss_g.json` file (located in `./scripts/`) in the game's working
 	"showDebugText" : true
 }
 ```
-

docs/DLSS-RR Integration Guide.pdf

@@ -72,4 +72,3 @@ if (ui)
 }
 #endif
 ```
-

docs/Debugging - JSON Configs (Plugin Configs).md

@@ -2,7 +2,7 @@
 Streamline - SL
 =======================
 
-Version 2.7.32
+Version 2.8.0
 =======
 
 1 SETTING UP
@@ -133,7 +133,7 @@ Here is the typical lifecycle for SL features:
 * After device creation, any calls to SL will succeed only if the feature is FULLY functional on that device
   * This means that the set of features that return true from `slIsFeatureSupported` AFTER device creation can be smaller (but not larger) than the set that returned true from `slIsFeatureSupported` after slInit, but before device creation
   * And thus, at this point, any SL method can be used safely since all required and supported features are initialized
-  * In addition, at this point it is possible to [explicitly allocate/free resources used by feature(s)](#27-explicit-resource-allocation-and-de-allocation)
+  * In addition, at this point it is possible to [explicitly allocate/free resources used by feature(s)](#28-explicit-resource-allocation-and-de-allocation)
 
 > **IMPORTANT:**
 > `slInit` must NOT be called within DLLMain entry point in your application because that can cause a deadlock.
@@ -1541,4 +1541,3 @@ If an exception is thrown while executing SL code mini-dump will be written to `
 ------------------------------------------------
 
 For any SL related questions, please email StreamlineSupport@nvidia.com.
-