Streamline SDK 2.10.0 Release

Author: liam-middlebrook

README.md

@@ -1,4 +1,4 @@
-# Streamline (SL) - Version 2.9.0
+# Streamline (SL) - Version 2.10.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.
 

changelog.txt

@@ -1,3 +1,58 @@
+======== Release 2.10.0 Entries ========
+
+    * Added support for two additional DLSS Super Resolution Transformer
+      Models:
+      - `sl::DLSSPreset::ePresetL`
+      - `sl::DLSSPreset::ePresetM`
+
+    * Updated `sl.dlss_g` to reduce latency on high refresh rate displays
+      when Vertical Sync is enabled in the NVIDIA Control Panel.
+
+    * Updated `sl.interposer` to only load plugins from the OTA cache when
+      updated versions of all requested plugins are available.
+
+    * Fixed a memory leak in `slGetFeatureRequirements()`.
+
+    * Fixed a bug in `slIsFeatureSupported` for `sl::kFeatureDLSS_G` where
+      `sl::Result::eErrorOSDisabledHWS` was not returned when GPU-Accelerated
+      Hardware Scheduling was disabled.
+
+    * Fixed a bug in `sl.common` where stale registry key information could
+      cause NGX initialization to fail.
+
+    * Fixed a bug in `sl.interposer` where stale registry key information
+      could prevent OTA Updates from downloading.
+
+    * Fixed a memory leak in `sl.nis` when `slFreeResources()` was called.
+      Reported on GitHub by @CCPNobody as issue #85
+
+    * Fixed a bug in `sl.reflex` where the `VK_NV_low_latency` extension was
+      required on unsupported hardware.
+
+    * Fixed a bug in DLSS-SR which could cause NvApp In-Game Overlay to
+      incorrectly report DLSS-SR Override as "Inactive".
+
+    * Improved logging and documentation around presentation hooking. See
+      section 2.2.2.3 "MEMORY MANAGEMENT" in `ProgrammingGuide.md` and
+      section 2.0 "MANUAL HOOKING API" in `ProgrammingGuideManualHooking.md`
+      for more information.
+
+    * Reduced verbosity of log messages for `slSetTagForFrame()`.
+      Reported on GitHub by @simco50 as issue #80
+
+    * Added an `eAll` value to the following enumerations:
+      - `sl::DirectSRVariantFlags`
+      - `sl::DLSSGFlags`
+      - `sl::DLSSGStatus`
+      - `sl::FeatureRequirementFlags`
+      - `sl::PreferenceFlags`
+
+    * Added an `eCount` value to the following enumerations:
+      - `sl::DirectSROptimizationType`
+      - `sl::DLSSDNormalRoughnessMode`
+      - `sl::NvPerfMode`
+
+
 ======== Release 2.9.0 Entries ========
 
     * Removed support for the following `sl::DLSSPreset` values:

docs/DLSS Programming Guide.pdf

@@ -2,7 +2,7 @@
 Streamline - SL
 =======================
 
-Version 2.9.0
+Version 2.10.0
 =======
 
 1 SETTING UP
@@ -372,6 +372,19 @@ using PFun_ResourceReleaseCallback = void(Resource* resource, void* device);
 > **NOTE:**
 > Memory management done by the host is an optional feature and it is NOT required for the SL to work properly. If used, proper care needs to be taken to avoid releasing resources which are still used by the GPU.
 
+> **IMPORTANT:**
+> Streamline defers destruction of internal GPU resources by a few frames for safety. These resources are actually released when Streamline performs garbage collection each frame.
+>
+> - In the default integration path, Streamline’s common plugin calls `presentCommon()` once per frame (and also collects from internal pools). If `presentCommon()` is not invoked, garbage collection will not run and memory can grow across events such as swapchain resize.
+> - If you use manual hooking or otherwise bypass the default interposer, you must ensure the common plugin’s `presentCommon()` function is called every frame. This is required for internal bookkeeping and garbage collection.
+> - Debug tip: set a breakpoint in the common plugin’s `presentCommon()` function. Verify it is hit each frame during normal rendering and around swapchain resize.
+
+> **If `presentCommon()` is not called:**
+> - Ensure Streamline is initialized early in process startup and not disabled by configuration.
+> - If you are using manual hooking or a custom integration, wire your frame presentation path so that Streamline’s common plugin executes `presentCommon()` exactly once per rendered frame (typically at the end of the frame). The recommended way is to upgrade your frame presentation interface using `slUpgradeInterface` immediately after creation (e.g., the swapchain on DirectX), as described in the Manual Hooking guide, so Streamline can invoke `presentCommon()`.
+> - If your engine has multiple presentation paths (e.g., different backends or windowing modes), make sure all active paths invoke `presentCommon()`.
+> - After changes, re-run with a breakpoint in `presentCommon()` to confirm it executes every frame and around window resizes.
+
 #### 2.2.3 INITIALIZATION
 
 To initialize an SDK instance, simply call the following method:

docs/DLSS-FG Programming Guide.pdf

@@ -6,7 +6,7 @@ Streamline - DLSS
 >The focus of this guide is on using Streamline to integrate DLSS into an application.  For more information about DLSS itself, please visit the [NVIDIA Developer DLSS Page](https://developer.nvidia.com/rtx/dlss)
 >For information on user interface considerations when using the DLSS plugin, please see the ["RTX UI Developer Guidelines.pdf"](<RTX UI Developer Guidelines.pdf>) document included with this SDK.
 
-Version 2.9.0
+Version 2.10.0
 =======
 
 ### 1.0 INITIALIZE AND SHUTDOWN
@@ -187,7 +187,7 @@ if(SL_FAILED(result, slDLSSSetOptions(viewport, dlssOptions)))
 ```
 
 > **NOTE:**
-> `sl::DLSSPreset::ePresetA` to `sl::DLSSPreset::ePresetE` are deprecated and should not be used. They will no longer be available in subsequent SDKs. `sl::DLSSPreset::ePresetG` to `sl::DLSSPreset::ePresetI` are reserved and should also not be used.
+> `sl::DLSSPreset::ePresetA` to `sl::DLSSPreset::ePresetE` are no longer available. `sl::DLSSPreset::ePresetG` to `sl::DLSSPreset::ePresetI` are reserved and should also not be used.
 
 > **NOTE:**
 > To turn off DLSS set `sl::DLSSOptions.mode` to `sl::DLSSMode::eOff`, note that this does NOT release any resources, for that please use `slFreeResources`

docs/DLSS-RR Integration Guide.pdf

@@ -5,7 +5,7 @@ Streamline - DLSS-G
 
 NVIDIA DLSS Frame Generation (“DLSS-FG” or “DLSS-G”) is an AI based technology that infers frames based on rendered frames coming from a game engine or rendering pipeline. This document explains how to integrate DLSS-G into a renderer.
 
-Version 2.9.0
+Version 2.10.0
 =======
 
 ### 0.0 Integration checklist
@@ -30,6 +30,7 @@ In-game UI for enabling/disabling DLSS-G is implemented | [RTX UI Guidelines](<R
 Only full production non-watermarked libraries are packaged in the release build | N/A |
 No errors or unexpected warnings in Streamline and DLSS-G log files while running the feature | N/A |
 Ensure extent resolution or resource size, whichever is in use, for `Hudless` and `UI Color and Alpha` buffers exactly match that of backbuffer. | N/A |
+Execute the DLSS-G In-Game Enhanced Debug Visualization Tests | [Section 23.0](#230-enhanced-in-game-debug-visualization) |
 
 ### 1.0 REQUIREMENTS
 
@@ -985,3 +986,7 @@ Dynamic Frame Generation leverages stochastic control to automatically trigger D
 Dynamic Frame Generation is enabled when DLSS-G is in auto mode. To activate Dynamic Frame Generation, set `mode` to `sl::DLSSGMode::eAuto`.
 
 When using non-production (development) builds of `sl.dlss_g.dll`, the status of Dynamic Frame Generation and the current state of DLSS-G is displayed on the DLSS-G status window.
+
+### 23.0 Enhanced In-Game Debug visualization
+
+The developer FG NGX feature contains an in-game debug visualization feature that can be used to accurately validate GPU and CPU input resources are correct. Consult the **Troubleshooting and Optional Features** section of the  [DLSS-FG Programming Guide.pdf](<DLSS-FG Programming Guide.pdf>) for more details.

docs/ProgrammingGuide.md

@@ -6,7 +6,7 @@ Streamline - DLSS-RR
 >The focus of this guide is on using Streamline to integrate DLSS Ray Reconstruction (DLSS-RR) into an application.  For more information about DLSS-RR itself, please visit the [NVIDIA Developer DLSS Page](https://developer.nvidia.com/rtx/dlss)
 >For information on user interface considerations when using the DLSS-RR plugin, please see the ["RTX UI Developer Guidelines.pdf"](<RTX UI Developer Guidelines.pdf>) document included in the DLSS SDK.
 
-Version 2.9.0
+Version 2.10.0
 =======
 
 ### 1.0 INITIALIZE AND SHUTDOWN
@@ -392,7 +392,7 @@ if(SL_FAILED(result, slDLSSDSetOptions(viewport, dlssOptions)))
 ```
 
 > **NOTE:**
-> `sl::DLSSDPreset::ePresetA` to `sl::DLSSDPreset::ePresetC` are deprecated and should not be used. They will no longer be available in subsequent SDKs.
+> `sl::DLSSDPreset::ePresetA` to `sl::DLSSDPreset::ePresetC` are no longer available.
 
 > **NOTE:**
 > To turn off DLSS-RR set `sl::DLSSDOptions.mode` to `sl::DLSSDMode::eOff`, note that this does NOT release any resources, for that please use `slFreeResources`

docs/ProgrammingGuideDLSS.md

@@ -13,7 +13,7 @@ The filter is controlled by two parameters:
 | Intensity | Controls how strong or subtle the filter effect will be on an image. | A low intensity will keep the images closer to the original, while a high intensity will make the filter effect more pronounced. A zero value will result in the original image. | [0, 1] |
 | Saturation Boost | Enhances the colors in your image, making them more vibrant and eye-catching. | This setting will only be active if you've turned up the Intensity. Once active, you'll see colors pop up more, making the image look more lively.  | [0, 1] |
 
-Version 2.9.0
+Version 2.10.0
 =======
 
 ### 1.0 CHECK IF DEEPDVC IS SUPPORTED