quick/Quake-III-Arena-VS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DX12 backend is turned off by default. Can be enabled with ENABLE_DX12.

Browse Source
This commit is contained in:
Artem Kharytoniuk
2018-01-13 13:19:17 +01:00
parent e86e65f173
commit f38011533d
6 changed files with 28 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -8,22 +8,24 @@ This repository contains updated version of the original Q3 codebase with reorga
* Build `visual-studio/quake3.sln` solution.
* Copy `quake3-ke.exe` to your local Quake-III-Arena installation folder.
## Vulkan and DX12 support
## Vulkan support
Vulkan backend provides the same graphics features as original OpenGL-based one including customization via r_xxx cvars and debug visualization.
Initially DirectX 12 backend was an exercise to learn this graphics API. It turned out the implementation is quite concise, so it was merged into the main branch. There is an option to compile the project without DX12 backend. For this, uncomment DISABLE_DX12 macro in dx.h header.
## DX12 support
DirectX 12 backend implementation is provided mostly for educational purposes and is not included in the prebuild binaries. It can be enabled by uncommenting ENABLED_DX12 in dx.h header and recompiling the project.
#### New cvars:
* **r_renderAPI** - 3D API to use: 0 - OpenGL, 1 - Vulkan, 2 - DX12. Requires vid_restart.
* **r_renderAPI** - 3D API to use. Requires vid_restart.
* 0 - OpenGL
* 1 - Vulkan
* 2 - DX12 (if enabled, see above).
* **r_twinMode** - Debug feature to compare rendering output between OpenGL/Vulkan/DX12 APIs. Requires vid_restart.
* r_twinMode=1 : one additional window is created. If the main window uses graphics API defined by `r_renderAPI` then the additional window will use graphics API with index `(r_renderAPI+1)%3`
* r_twinMode=2 : two additional windows are created and all 3 graphics APIs are active simultaneously.
#### Additional information:
* Q: How to start game with vulkan support? A: `quake3-ke.exe +set r_renderAPI 1`.
* Q: How to enable vulkan support from Q3 console? A: `\r_renderAPI 1` then `\vid_restart`.
* Q: How to enable twin mode from Q3 console? A: `\r_twinMode 1` or `\r_twinMode 2` then `\vid_restart`.
* Q: How to enable twin mode from Q3 console? A: `\r_twinMode 1` or `\r_twinMode 1` then `\vid_restart`.
* Q: How to check that Vulkan backend is really active? A: `gfxinfo` console command reports information about active rendering backend.
## Visual Studio