[general] Updated README

Documented HUD options.
This commit is contained in:
Philip Rebohle 2018-04-03 16:03:15 +02:00
parent 9ef4168867
commit 1c22ae9796
1 changed files with 12 additions and 4 deletions

View File

@ -45,11 +45,19 @@ Before reporting an issue, please check the [Wiki](https://github.com/doitsujin/
### Online multi-player games
Manipulation of Direct3D libraries in multi-player games may be considered cheating and can get your account **banned**. This may also apply to single-player games with an embedded or dedicated multiplayer portion. **Use at your own risk.**
### Environment variables
The behaviour of DXVK can be modified with environment variables.
- `DXVK_HUD=1` Enables the HUD (FPS, driver info)
### HUD
The `DXVK_HUD` environment variable controls a HUD which can display the framerate and some stat counters. It accepts a comma-separated list of the following options:
- `devinfo`: Displays the name of the GPU and the driver version.
- `fps`: Shows the current frame rate.
- `submissions`: Shows the number of command buffers submitted per frame.
- `drawcalls`: Shows the number of draw calls and render passes per frame.
- `pipelines`: Shows the total number of graphics and compute pipelines.
- `memory`: Shows the amount of device memory allocated and used.
The following options can be used for **debugging** purposes. Do not use these for playing games.
Additionally, `DXVK_HUD=1` has the same effect as `DXVK_HUD=devinfo,fps`.
### Environment variables
The following environment variables can be used for **debugging** purposes.
- `DXVK_DEBUG_LAYERS=1` Enables Vulkan debug layers. Highly recommended for troubleshooting and debugging purposes. Requires the Vulkan SDK to be installed and set up within the wine prefix.
- `DXVK_CUSTOM_VENDOR_ID=<ID>` Specifces a custom PCI vendor identifier (Vendor ID)
- `DXVK_CUSTOM_DEVICE_ID=<ID>` Specifces a custom PCI device identifier (Device ID)