Alternative NVAPI implementation on top of DXVK.
This repository provides an alternative implementation of NVIDIA's NVAPI/NVOFAPI library for usage with DXVK and VKD3D-Proton. Its way of working is similar to DXVK-AGS, but adjusted and enhanced for NVAPI.
This implementation currently offers entry points for supporting the following features in applications:
SetDepthBoundsTest and UAVOverlap, by forwarding the relevant calls into DXVK.See the DLSS / Smooth Motion / Reflex section in the NVIDIA Driver Installation Guide for a high level guide for NVIDIA gaming technology on Linux.
Note that DXVK-NVAPI does not implement DLSS, Reflex or PhysX. It mostly forwards the relevant calls.
While originally being developed for usage with Unreal Engine 4, most notably for Assetto Corsa Competizione, more entry points have been added over time for enabling other NVIDIA related technologies. DXVK-NVAPI does not and will never cover the complete surface of NVIDIA's NVAPI. It is not meant as a full replacement, but rather as an addition to DXVK and VKD3D-Proton to enable several GPU features.
This implementation is supposed to be used on Linux using Wine or derivatives like Proton. Usage on Windows is discouraged. Please do not replace nvapi.dll/nvapi64.dll/nvofapi64.dll on Windows from NVIDIA's driver package with this version. DXVK-NVAPI uses several DXVK and VKD3D-Proton extension points, thus using DXVK (D3D11 and DXGI) is a requirement. Using Wine's D3D11 or DXGI implementation will fail. Usage of DXVK-NVAPI is not restricted to NVIDIA GPUs, though the default behavior is to skip GPUs not running the NVIDIA proprietary driver or Mesa NVK. Some entry points offer no functionality or make no sense when a different GPU vendor is detected. DLSS requires an NVIDIA GPU, Turing or newer, running the proprietary driver.
In order to support Vulkan flavor of NVIDIA Reflex, one of two backing implementations can be used:
VK_NV_low_latency device extension and winevulkan 1.4.357 or newer. This relies on the application enabling this extension on its own, which notably prevents Red Dead Redemption 2 from working using this method out of the box. Going forward, this will be the preferred choice.VK_NV_low_latency2 device extension. This layer will replace requests to enable VK_NV_low_latency with itself.When available, DXVK-NVAPI uses NVIDIA's NVML management library to query temperature, utilization and others for NVIDIA GPUs. See wine-nvml how to add NVML support to Wine/Proton.
Like DXVK, this library is being built as a Windows DLL using MinGW. DXVK-NVAPI requires MinGW-w64 compiler and headers version 9 or newer, the Meson build system at least version 0.58 and Python 3 (needed for a prebuild validation script). This project uses git submodules. Ensure to fetch the submodules while or after cloning the repository, e.g. with git clone --recurse-submodules [email protected]:jp7677/dxvk-nvapi.git.
The Vulkan Reflex layer has higher requirements: Meson 1.0 and a C++ compiler that supports C++20 standard. It is recommended (and assumed) that the layer is built as Linux-side library, and as such this compiler should target Linux and not be a cross-compiler like MinGW.
Run:
./package-release.sh master /your/path [--disable-layer] [--enable-tests]Alternatively DXVK-Docker provides a way for a build setup using docker/podman. Prebuilt binaries of release versions are available at . GitHub Actions is set up for building development snapshots.
Support for DXVK-NVAPI has been added to popular game launchers. See their respective documentation for usage and updates of DXVK-NVAPI.
Proton 9.0 or newer includes DXVK-NVAPI and enables it by default for all titles with a few exceptions. Proton can force-enable DXVK-NVAPI for titles that have DXVK-NVAPI disabled by default and also for non-NVIDIA GPUs when setting PROTON_FORCE_NVAPI=1. Contrary, PROTON_DISABLE_NVAPI disables DXVK-NVAPI.
nvapi.dll/nvapi64.dll/nvofapi64.dll into the files/lib/wine/nvapi/i386-windows/files/lib/wine/nvapi/x86_64-windows folder of your Proton installation, e.g. in ~/.steam/steam/steamapps/common/Proton 11.0/ for manually updating the included version.Proton Experimental Bleeding Edge additionally always contains the latest DXVK-NVAPI development (master) version.
Wine does not includes DXVK-NVAPI.
nvapi.dll/nvapi64.dll/nvofapi64.dll into the syswow64/system32 folder of your x86/x64 Wine prefix.nvapi/nvapi64, e.g. with WINEDLLOVERRIDES=nvapi,nvapi64=n. This applies only to Wine versions that ship their own NVAPI implementation, e.g. Wine-Staging older than 7.22. Generally this is no longer needed nowadays.nvngx.dll and _nvngx.dll are present in the system32 directory of the Wine prefix for DLSS SR. See wiki.dxgi.dll, e.g. with WINEDLLOVERRIDES=dxgi=n.DXVK_ENABLE_NVAPI=1 to disable DXVK's nvapiHack in DXVK.Using DXVK-NVAPI with other GPU vendors / drivers has very limited use. Outside of testing, only HDR entry points provide benefits. This requires DXVK to see the GPU as an NVIDIA GPU. Use DXVK_CONFIG="dxgi.hideAmdGpu = True" to spoof an AMD GPU as NVIDIA GPU. Use DXVK_CONFIG="dxgi.customVendorId = 10de" for generally spoofing an NVIDIA GPU.
Setting DXVK_NVAPI_ALLOW_OTHER_DRIVERS=1 is needed for successful DXVK-NVAPI initialization when using a driver other than the NVIDIA proprietary driver or Mesa NVK. The reported driver version on drivers other than the NVIDIA proprietary driver will be 999.99. Overriding the reported driver version is still recommended. The reported GPU architecture for other vendors is, unless overriden, always Pascal to prevent attempts to initialize DLSS.
The Vulkan Reflex layer, when built as a Linux-side layer, is not installed into a Wine prefix. Instead it's installed like any other Vulkan implicit layer. It is distributed as a pair of files:
VkLayer_DXVK_NVAPI_reflex.json (the layer manifest)libdxvk_nvapi_vkreflex_layer.so (the layer library)To make it discoverable by your Vulkan loader:
VK_ADD_IMPLICIT_LAYER_PATH environment variable (e.g. VK_ADD_IMPLICIT_LAYER_PATH="${HOME}/dxvk-nvapi/layer")VK_ADD_IMPLICIT_LAYER_PATH works only with Vulkan loader v1.3.296 or newerVK_ADD_IMPLICIT_LAYER_PATH set and pointing to a directory with some other implicit layer manifest, it is possible to pass multiple paths by separating them with :${XDG_DATA_HOME}/vulkan/implicit_layer.d where Steam usually installs its layers)library_path points to the layer library./libdxvk_nvapi_vkreflex_layer.so../../../lib/libdxvk_nvapi_vkreflex_layer.so)/home/user/dxvk-nvapi/layer/libdxvk_nvapi_vkreflex_layer.so)/usr/lib, this depends on the distro), it's possible to set the library path to just the name of the layer library: "library_path": "libdxvk_nvapi_vkreflex_layer.so"Because the layer could interfere with other Vulkan applications that don't use Reflex, it is currently disabled by default even when installed. To enable it, export DXVK_NVAPI_VKREFLEX=1 as environment variable. When an application attempts to use Vulkan Reflex and the layer isn't installed and enabled, Reflex API calls will return fake successes (falling back to immediate semaphore signalling via vkSignalSemaphore) to workaround issues like pink tint in DOOM: The Dark Ages. In this case, Reflex appears to be working for the application, but it is not actually functional and latency will not be reduced. A message will be logged (on info log level) explaining this and suggesting to install the layer.
Running env DXVK_NVAPI_VKREFLEX=1 vulkaninfo can serve as a quick setup check to verify that both files are in correct locations. If the layer manifest was found, there will be an entry like VK_LAYER_DXVK_NVAPI_reflex (DXVK-NVAPI Vulkan Reflex compatibility layer) on the list of discovered Vulkan layers. Additionally, if the layer manifest was found but the layer library couldn't be loaded (perhaps due to incorrect library_path in the manifest), an error similar to ERROR: [Loader Message] Code 0 : /home/user/.local/share/vulkan/implicit_layer.d/./libdxvk_nvapi_vkreflex_layer.so: cannot open shared object file: No such file or directory will be logged on stderr before any standard output.
Like any other (glibc-based) Linux shared library, layer compiled on a system with newer version of glibc will not run on systems with older version of glibc. If you are running a distro with older glibc than the ones prebuilt binaries are distributed for, it is likely that building your own library from source will be required.
See the DXVK-NVAPI Wiki for common issues and workarounds.
The following environment variables tweak DXVK-NVAPI's runtime behavior:
DXVK_NVAPI_DRIVER_VERSION lets you override the reported driver version. Valid values are numbers between 100 and 99999. Use e.g. DXVK_NVAPI_DRIVER_VERSION=47141 to report driver version 471.41.DXVK_NVAPI_ALLOW_OTHER_DRIVERS, when set to 1, allows DXVK-NVAPI to initialize for a non-NVIDIA GPU.No open issues yet, or sync has not completed.