vertver / NRI

NVIDIA Render Interface (NRI)

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:

• NRI samples
• NRD Sample

Build instructions

• 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

Note: Xlib and Wayland can be both enabled.

CMake options

• NRI_DISABLE_XLIB_SUPPORT=ON - disable Xlib support
• NRI_DISABLE_WAYLAND_SUPPORT=ON - disable Wayland support
• NRI_STATIC_LIBRARY=ON - build NRI as a static library

Samples overview

In order of complexity:

• 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

Licence

This project includes NVAPI software. All uses of NVAPI software are governed by the license terms specified here: https://github.com/NVIDIA/nvapi/blob/main/License.txt.