Streamline SDK 2.9.0 Release

Author: liam-middlebrook

.gitattributes

@@ -1,6 +1,7 @@
-*.dll filter=lfs diff=lfs merge=lfs -text
-*.png filter=lfs diff=lfs merge=lfs -text
-*.pdb filter=lfs diff=lfs merge=lfs -text
-*.pdf filter=lfs diff=lfs merge=lfs -text
-*.lib filter=lfs diff=lfs merge=lfs -text
-*.exe filter=lfs diff=lfs merge=lfs -text
+*.dll filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.pdb filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text
+*.lib filter=lfs diff=lfs merge=lfs -text
+*.exe filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -1,11 +1,11 @@
-_project/
-_artifacts/
-_sdk/
-_public/
-docs/pages/*
-copy.bat
-mr.bat
-fb.bat
-.vs/
-**/*.aps
+_project/
+_artifacts/
+_sdk/
+_public/
+docs/pages/*
+copy.bat
+mr.bat
+fb.bat
+.vs/
+**/*.aps
 tools/premake5/**

README.md

@@ -1,4 +1,4 @@
-# Streamline (SL) - Version 2.8.0
+# Streamline (SL) - Version 2.9.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.
 
@@ -8,6 +8,8 @@ For a high level overview, see the [NVIDIA Developer Streamline page](https://de
 
 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
@@ -20,8 +22,7 @@ As of SL 2.0.0, it is now possible to recompile all of SL from source, with the
 
 - 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/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 VS Code or VS2019+ with [SDK 10.0.19041+](https://go.microsoft.com/fwlink/?linkid=2120843)
 - Install "git".
 - Clone your fork to a local hard drive, make sure to use a NTFS drive on Windows (SL uses symbolic links)
 
@@ -42,9 +43,9 @@ To configure a new SL tree to build, there is a script called `setup.bat`.  Note
 Running the `setup.bat` script will cause two things to be done:
 
 1. Use the NVIDIA tool `packman` to pull all build dependencies to the local machine and cache them in a shared directory.  Links are created from `external` in the SL tree to this shared cache for external build dependencies.
-2. Run `premake` to generate the project build files in `_project\vs2017` (for Windows)
+2. Run `premake` to generate the project build files in `_project\vs2019` (for Windows)
 
-To build the project, simply open `_project\vs2017\streamline.sln` in Visual Studio, select the desired build configuration and build, or else use the provided build script:
+To build the project, simply open `_project\vs2019\streamline.sln` in Visual Studio, select the desired build configuration and build, or else use the provided build script:
 
 `./build.bat` with `-{debug|develop|production}` (`debug` is default) or use VS IDE and load solution from the `_project` directory
 

build.bat

@@ -103,6 +103,5 @@ 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
+    goto :ErrorExit
 )

changelog.txt

@@ -1,3 +1,64 @@
+======== Release 2.9.0 Entries ========
+
+    * Removed support for the following `sl::DLSSPreset` values:
+      - `sl::DLSSPreset::ePresetA`
+      - `sl::DLSSPreset::ePresetB`
+      - `sl::DLSSPreset::ePresetC`
+      - `sl::DLSSPreset::ePresetD`
+      - `sl::DLSSPreset::ePresetE`
+
+    * Removed support for the following `sl::DLSSDPreset` values:
+      - `sl::DLSSDPreset::ePresetA`
+      - `sl::DLSSDPreset::ePresetB`
+      - `sl::DLSSDPreset::ePresetC`
+
+    * Removed support for building with Visual Studio 2017.
+
+    * Updated the `sl::PreferenceFlags::eLoadDownloadedPlugins` flag to control
+      the loading of Optional OTA Updates. The loading of Mandatory OTA Updates
+      is not impacted by this flag.
+
+    * Added `slFreeResources` function to `sl.nis`. See Section 3.0 "TAG ALL
+      REQUIRED RESOURCES" in `ProgrammingGuideNIS.md` for more information.
+
+    * Fixed a bug in `sl.common` where the NGX allocation callbacks where
+      failure to allocate resources would not be properly reported back to the
+      caller.
+
+    * Fixed a bug in `sl.dlss` and `sl.dlss_d` where feature NGX failures during
+      `slEvaluate()` and `slGetData()` were not properly communicated to the
+      application.
+
+    * Fixed a bug in `sl.dlss` and `sl.dlss_d` which could lead to crash if the
+      feature was re-created while GPU work was still in-flight.
+
+    * Fixed a bug in `sl.dlss_g` where references to tagged resources would be
+      kept for 32 frames after their last usage.
+      Reported on GitHub by @simco50 as issue #66
+
+    * Fixed a bug in `sl.dlss_g` which could lead to crashes when feature
+      creation failed. This was most commonly found in scenarios where the
+      swapchain resolution was not supported.
+
+    * Fixed a bug in `sl.dlss_g` which could lead to simultaneous access of
+      swapchain buffers as a result of a GPU timeout during frame presentation.
+
+    * Fixed a bug in `sl.dlss_g` which resulted in high latency when Vertical
+      sync was enabled in the NVIDIA Control Panel.
+
+    * Fixed a bug where `sl.interposer` would incorrectly state that a
+      `sl::Preferences::applicationId` was required despite the application
+      passing in `sl::Preferences::projectId`.
+
+    * Fixed a bug in `sl.deepdvc` where `sl::FeatureVersion::versionNGX` was not set.
+
+    * Fixed a bug in `sl.imgui` where resources would be leaked on `slShutdown()`.
+      Reported on GitHub by @simco50 as issue #59
+
+    * Fixed a bug in `sl_core_types.h` which resulted in compilation failures on clang.
+      Reported on GitHub by @clshortfuse as issue #71
+
+
 ======== Release 2.8.0 Entries ========
 
     * Deprecated support for the following `sl::DLSSPreset` values:
@@ -61,10 +122,10 @@
 
     * Added support for `slSetTagForFrame()` which allows for frame-based
       tagging of resources.
-      See section 2.9 of `ProgrammingGuide.md` "TAGGING RESOURCES" for more inforamtion.
+      See section 2.9 of `ProgrammingGuide.md` "TAGGING RESOURCES" for more information.
 
     * Deprecated support for `slSetTag()`. Use `slSetTagForFrame()` instead.
-      See section 2.9 of `ProgrammingGuide.md` "TAGGING RESOURCES" for more inforamtion.
+      See section 2.9 of `ProgrammingGuide.md` "TAGGING RESOURCES" for more information.
 
     * Added support for an additional DLSS Super Resolution Transformer Model (BETA)
       Available as `sl::DLSSPreset::ePresetK`.
@@ -127,7 +188,7 @@
       `ProgrammingGuideDLSS_G.md` for more information.
 
     * Added a new `sl::DLSSGOptions` field `queueParallelismMode`, see the above
-      changelog entry on `sl::DLSSGQueueParallelismMode for more information.
+      changelog entry on `sl::DLSSGQueueParallelismMode` for more information.
 
     * Added support for overriding Streamline's logging behavior via environment
       variables and Windows registry keys. See the "Logging" section in
@@ -265,7 +326,7 @@
 ======== Release 2.3.0 Entries ========
 
     * Added support for DeepDVC with a new plugin: `sl.deepdvc`.
-      See `ProgrammingGuideDeepDVC.md` for more information see.
+      See `ProgrammingGuideDeepDVC.md` for more information.
 
     * Added a new plugin `sl.pcl` for handling the IHV-agnostic functionality
       previously covered within `sl.reflex`. See `ProgrammingGuidePCL.md` and
@@ -340,7 +401,7 @@
     * Added a new `sl::Constants` field `minRelativeLinearDepthObjectSeparation`
       for describing the minimum depth difference between two objects in screen-space.
 
-    * Added a new structure `sl::PrecsisionInfo` for specifying floating-point
+    * Added a new structure `sl::PrecisionInfo` for specifying floating-point
       precision bias for a `sl::Resource`.
       See section 2.8 "TAGGING RESOURCES" in `ProgrammingGuide.md` for more
       information.

docs/DLSS Programming Guide.pdf

@@ -2,7 +2,7 @@
 Streamline - SL
 =======================
 
-Version 2.8.0
+Version 2.9.0
 =======
 
 1 SETTING UP

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.8.0
+Version 2.9.0
 =======
 
 ### 1.0 INITIALIZE AND SHUTDOWN
@@ -64,40 +64,40 @@ if(SL_FAILED(res, slSetD3DDevice(nativeD3DDevice)))
 As soon as SL is initialized, you can check if DLSS is available for the specific adapter you want to use:
 
 ```cpp
-Microsoft::WRL::ComPtr<IDXGIFactory> factory;
-if (SUCCEEDED(CreateDXGIFactory(__uuidof(IDXGIFactory), (void**)&factory)))
-{
-    Microsoft::WRL::ComPtr<IDXGIAdapter> adapter{};
-    uint32_t i = 0;
-    while (factory->EnumAdapters(i, &adapter) != DXGI_ERROR_NOT_FOUND)
-    {
-        DXGI_ADAPTER_DESC desc{};
-        if (SUCCEEDED(adapter->GetDesc(&desc)))
-        {
-            sl::AdapterInfo adapterInfo{};
-            adapterInfo.deviceLUID = (uint8_t*)&desc.AdapterLuid;
-            adapterInfo.deviceLUIDSizeInBytes = sizeof(LUID);
-            if (SL_FAILED(result, slIsFeatureSupported(sl::kFeatureDLSS, adapterInfo)))
-            {
-                // Requested feature is not supported on the system, fallback to the default method
-                switch (result)
-                {
-                    case sl::Result::eErrorOSOutOfDate:             // inform user to update OS
-                    case sl::Result::eErrorDriverOutOfDate:         // inform user to update driver
-                    case sl::Result::eErrorNoSupportedAdapterFound: // cannot use this adapter (older or non-NVDA
-                                                                    // GPU etc)
-                        break;
-                        // and so on ...
-                };
-            }
-            else
-            {
-                // Feature is supported on this adapter!
-            }
-        }
-        i++;
-    }
-}
+Microsoft::WRL::ComPtr<IDXGIFactory> factory;
+if (SUCCEEDED(CreateDXGIFactory(__uuidof(IDXGIFactory), (void**)&factory)))
+{
+    Microsoft::WRL::ComPtr<IDXGIAdapter> adapter{};
+    uint32_t i = 0;
+    while (factory->EnumAdapters(i, &adapter) != DXGI_ERROR_NOT_FOUND)
+    {
+        DXGI_ADAPTER_DESC desc{};
+        if (SUCCEEDED(adapter->GetDesc(&desc)))
+        {
+            sl::AdapterInfo adapterInfo{};
+            adapterInfo.deviceLUID = (uint8_t*)&desc.AdapterLuid;
+            adapterInfo.deviceLUIDSizeInBytes = sizeof(LUID);
+            if (SL_FAILED(result, slIsFeatureSupported(sl::kFeatureDLSS, adapterInfo)))
+            {
+                // Requested feature is not supported on the system, fallback to the default method
+                switch (result)
+                {
+                    case sl::Result::eErrorOSOutOfDate:             // inform user to update OS
+                    case sl::Result::eErrorDriverOutOfDate:         // inform user to update driver
+                    case sl::Result::eErrorNoSupportedAdapterFound: // cannot use this adapter (older or non-NVDA
+                                                                    // GPU etc)
+                        break;
+                        // and so on ...
+                };
+            }
+            else
+            {
+                // Feature is supported on this adapter!
+            }
+        }
+        i++;
+    }
+}
 ```
 
 ### 3.0 CHECK DLSS SETTINGS AND SETUP VIEWPORT RENDERING SIZE