NRI is a low-level abstract render interface which currently supports three backends: D3D11, D3D12 and Vulkan. NRI has been designed to support all (at least major) low level features of D3D12 and Vulkan APIs, but at the same time to simplify usage and reduce the amount of code needed (especially compared with Vulkan). NRI is written in C++, but supports both C++ and C interfaces.
Key features:
- C++ and C compatible interfaces
- common denominator for D3D11, D3D12 and Vulkan APIs
- low overhead
- ray tracing support
- API-provided and/or integrated validation layer
- default D3D11 behavior is changed to match D3D12/VK where applicable using NVAPI or AMD AGS libraries
NRI is used in:
- Install Cmake 3.15+
- Install on
- Windows: latest WindowsSDK and VulkanSDK
- Linux (x86-64): latest VulkanSDK and optional libx11-dev and libwayland-dev
- Linux (aarch64): optional libx11-dev and libwayland-dev
- Build (variant 1) - using Git and CMake explicitly
- Clone project and init submodules
- Generate and build the project using CMake
- Build (variant 2) - by running scripts:
- Run
1-Deploy - Run
2-Build
- Run
Notes:
- Xlib and Wayland can be both enabled
- Minimal supported client is Windows 8.1+. Windows 7 support requires minimal effort and can be added by request
NRI_STATIC_LIBRARY- build NRI as a static library (offby default)NRI_BACKEND_VK- enable VULKAN backend (onby default)NRI_BACKEND_D3D11- enable D3D11 backend (onby default on Windows)NRI_BACKEND_D3D12- enable D3D12 backend (onby default on Windows)
Vulkan only:
NRI_ENABLE_XLIB_SUPPORT- disable Xlib support (onby default)NRI_ENABLE_WAYLAND_SUPPORT- disable Wayland support (onby default)
D3D12 only:
NRI_ENABLE_AGILITY_SDK_SUPPORT- enable Agility SDK (offby default)NRI_AGILITY_SDK_PATH- path to a directory containing Agility SDK: contents of.nupkg/build/native/(C:/AgilitySDKby default)NRI_AGILITY_SDK_VERSION- Agility SDK version (711by default, can be newer)NRI_AGILITY_SDK_DIR- directory where Agility SDK binaries will be copied to relative toCMAKE_RUNTIME_OUTPUT_DIRECTORY(AgilitySDKby default)
IMPORTANT: NRI features requiring Agility SDK are marked as // TODO: D3D12 requires Agility SDK with version specification.
Overview and Download sections can be found here.
D3D12 backend uses Agility SDK to get access to most recent D3D12 features. As soon as these features become available in the OS, installation of Agility SDK will be deprecated.
Installation steps:
- download Agility SDK package
previewversions require enabling Developer Mode in Windows
- rename
.nupkginto.zip - extract contents of
.nupkg/build/nativeintoNRI_AGILITY_SDK_PATHfolder- can be located anywhere
- set
NRI_AGILITY_SDK_DIRto a path, wherebinfolder needs to be copied- most likely closer to the executable
- set
NRI_AGILITY_SDK_VERSIONto the version of the package - enable
NRI_ENABLE_AGILITY_SDK_SUPPORT - re-deploy project
- include auto-generated
NRIAgilitySDK.hheader in the code of your executable, using NRI
NRI samples can be found here.
Samples:
- DeviceInfo - queries and prints out information about device groups in the system
- Clear - minimal example of rendering using framebuffer clears only
- CTest - very simple example of C interface usage
- Triangle - simple textured triangle rendering
- SceneViewer - loading & rendering of meshes with materials
- Readback - getting data from the GPU back to the CPU
- AsyncCompute - demonstrates parallel execution of graphic and compute workloads
- MultiThreading - shows advantages of multi-threaded command buffer recording
- MultiGPU - multi GPU example
- RayTracingTriangle - simple triangle rendeing through ray tracing
- RayTracingBoxes - a more advanced ray tracing example with many BLASes in TLAS
- Wrapper - shows how to wrap native D3D11/D3D12/VK objects into NRI entities
- Resize - demonstrates window resize
NRI is licensed under the MIT License. This project includes NVAPI software. All uses of NVAPI software are governed by the license terms specified here.