Home

Awesome

SL Version 2.4.10

StreamlineSample

This project combines Streamline (https://github.com/NVIDIAGameWorks/Streamline) and Donut (https://github.com/NVIDIAGameWorks/donut) to create a sample app demonstrating a Streamline integration.

Prerequisites

To get this project setup:

  1. Ensure you have CMake 3.20+ and the vulkan sdk (https://vulkan.lunarg.com) on your system.
  2. Ensure that a VK-compatible dxc.exe is available in your system PATH. The best way to do this is to install a recent (1.2.198.1 or newer) Vulkan SDK from https://www.vulkan.org/ and ensure that its bin directory is in the build machine's system PATH.
  3. Clone this repository, then run in the commandline: git submodule update --init --recursive
  4. Copy your streamline SDK contents (bin, lib, include and, optionally, scripts) into the streamline folder
  5. Use Cmake to make the project solution (or use make.bat). Cmake will attempt to locate plugins by searching first the streamline/bin/x64 and then the streamline/bin/x64/development folders for sl.interposer.dll. If found, it will load all SL plugin DLLs from the folder where sl.interposer.dll was located.
  6. Open the solution and build (or use build.bat)
  7. Run the executable (or use run.bat)

Integration notes

Useful commandLine arguments:

ArgumentsEffect
-vkRun with Vulkan
-d3d11Run with D3D11
-d3d12Run with D3D12
-height 1080Sets height
-fullscreenSets fullscreen (by default game runs in windowed)
-verboseAllows vebose info level logging logging
-logToFileLogs to file
-debugEnables NVRHI and Graphics API validation Layer
-noSigCheckDoes not do streamline dll signiture check
-vsyncEnables Vsync
-sllogEnables streamline logging
-scene "/myscene.fbx"Loads a custom scene
-maxFrames 100Sets number of frames to render before the app shuts down
-Reflex_mode 1Sets Reflex mode: 1:On 2:Boost
-Reflex_fpsCap 60Sets Refex FPS cap to a given number
-DLSS_mode 1Sets the DLSS mode startup: 0:Off 1:MaxPerf 2:Balanced 3:MaxQual 4:UtraPerf 5:DLAA
-viewportSpecifies backbuffer viewport extent in the format: (offsetLeft,offsetTop,widthxheight) e.g. (320,180,1280x720)