Skip to content

Commit d2f6419

Browse files
committed
Set BUILD_RENDERER_VULKAN default to OFF
The Vulkan renderer currently only builds and works on Linux. It has not been tested on macOS, Windows, OpenBSD, or Emscripten. Setting the default to OFF prevents CI failures on unsupported platforms.
1 parent 8a819b2 commit d2f6419

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ option(BUILD_SERVER "Build dedicated server" ON)
1515
option(BUILD_CLIENT "Build client" ON)
1616
option(BUILD_RENDERER_GL1 "Build GL1 renderer" ON)
1717
option(BUILD_RENDERER_GL2 "Build GL2 renderer" ON)
18-
option(BUILD_RENDERER_VULKAN "Build Vulkan renderer" ON)
18+
option(BUILD_RENDERER_VULKAN "Build Vulkan renderer" OFF)
1919
option(BUILD_GAME_LIBRARIES "Build game module libraries" ON)
2020
option(BUILD_GAME_QVMS "Build game module qvms" ON)
2121
option(BUILD_STANDALONE "Build binaries for standalone games" OFF)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The following CMake variables may be set, using `-D` on the command line.
163163
BUILD_CLIENT - build the 'ioquake3' client binary
164164
BUILD_RENDERER_OPENGL1 - build the opengl1 client / renderer library
165165
BUILD_RENDERER_OPENGL2 - build the opengl2 client / renderer library
166-
BUILD_RENDERER_VULKAN - build the vulkan client / renderer library
166+
BUILD_RENDERER_VULKAN - build the vulkan client / renderer library (default OFF)
167167
BUILD_GAME_LIBRARIES - build the game shared libraries
168168
BUILD_GAME_QVMS - build the game qvms
169169
BUILD_STANDALONE - build binaries suited for stand-alone games

docs/vulkan-readme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ graphics API path while maintaining compatibility with existing Quake 3 content.
2828
BUILDING
2929
-------------------------------------------------------------------------------
3030

31-
The Vulkan renderer is enabled by default. To disable it, pass
32-
`-DBUILD_RENDERER_VULKAN=OFF` to CMake.
31+
The Vulkan renderer is not built by default. To enable it, pass
32+
`-DBUILD_RENDERER_VULKAN=ON` to CMake.
3333

3434
mkdir build && cd build
35-
cmake .. -DCMAKE_BUILD_TYPE=Release
35+
cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_RENDERER_VULKAN=ON
3636
make renderer_vulkan
3737

3838
This produces `renderer_vulkan_<arch>.so` (Linux), `renderer_vulkan_<arch>.dll`

0 commit comments

Comments
 (0)