3 Instructions for building this repository on Linux, Windows, Android, and MacOS.
7 1. [Contributing](#contributing-to-the-repository)
8 2. [Repository Set-Up](#repository-set-up)
9 3. [Windows Build](#building-on-windows)
10 4. [Linux Build](#building-on-linux)
11 5. [Android Build](#building-on-android)
12 6. [MacOS build](#building-on-macos)
14 ## Contributing to the Repository
16 If you intend to contribute, the preferred work flow is for you to develop
17 your contribution in a fork of this repository in your GitHub account and
18 then submit a pull request.
19 Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details.
25 This repository does not contain a Vulkan-capable driver.
26 Before proceeding, it is strongly recommended that you obtain a Vulkan driver from your
27 graphics hardware vendor and install it properly.
29 ### Download the Repository
31 To create your local git repository:
33 git clone https://github.com/KhronosGroup/Vulkan-Tools
35 ## Building On Windows
37 ### Windows Build Requirements
39 Windows 7+ with the following software packages:
41 - Microsoft Visual Studio 2013 Update 4 Professional, VS2015 (any version), or VS2017 (any version).
42 - [CMake](http://www.cmake.org/download/)
43 - Tell the installer to "Add CMake to the system PATH" environment variable.
44 - [Python 3](https://www.python.org/downloads)
45 - Select to install the optional sub-package to add Python to the system PATH
47 - Ensure the `pip` module is installed (it should be by default)
48 - Python3.3 or later is necessary for the Windows py.exe launcher that is used to select python3
49 rather than python2 if both are installed
50 - [Git](http://git-scm.com/download/win)
51 - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
52 - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
53 - Install both the 32-bit and 64-bit versions, as the 64-bit installer does not install the
54 32-bit libraries and tools.
55 - Vulkan Loader Library
56 - Building the cube and vulkaninfo applications require linking to the Vulkan Loader Library (vulkan-1.dll).
57 Locating the library for this repo can be done in two different ways:
58 - The Vulkan SDK can be installed. In this case, cmake should be able to locate the loader repo through the VulkanSDK
60 - The library can be built from the [Vulkan-Loader](https://github.com/KhronosGroup/Vulkan-Loader.git) repository.
61 In this case, the following option should be used on the cmake command line:
62 LOADER_REPO_ROOT=c:\absolute_path_to\Vulkan-Loader
63 and use absolute (not relative) paths, like so:
64 cmake -DLOADER_REPO_ROOT=c:\absolute_path_to\Vulkan-Loader ....
65 Currently, the build directory *must* be named either 'build' or 'build32'.
66 - [glslang](https://github.com/KhronosGroup/glslang)
67 - By default, the build scripts will attempt to download the necessary components from the glslang repo.
68 However, if a specific version of this file is required, please see the [Custom glslang Version](#custom-glslang-version) section below.
70 ### Windows Build - Microsoft Visual Studio
72 1. Open a Developer Command Prompt for VS201x
73 2. Change directory to `Vulkan-Tools` -- the root of the cloned git repository
74 3. Run 'git submodule update --init --recursive' -- this will download in-tree external dependencies
75 4. Create a `build` directory, change into that directory, and run cmake
77 For example, assuming an SDK is installed, for VS2017 (generators for other versions are [specified here](#cmake-visual-studio-generators)):
79 cmake "Visual Studio 15 2017 Win64" ..
81 If a specific version of the Loader is requred, specify the root of the loader repository, like so:
83 cmake -DLOADER_REPO_ROOT=c:/absolute_path_to/Vulkan-Loader -G "Visual Studio 15 2017 Win64" ..
85 This will create a Windows solution file named `Vulkan-Tools.sln` in the build directory.
87 Launch Visual Studio and open the "Vulkan-Tools.sln" solution file in the build folder.
88 You may select "Debug" or "Release" from the Solution Configurations drop-down list.
89 Start a build by selecting the Build->Build Solution menu item.
90 This solution copies the loader it built to each program's build directory
91 to ensure that the program uses the loader built from this solution.
95 #### CMake Visual Studio Generators
97 The above example used Visual Studio 2017, and specified its generator as "Visual Studio 15 2017 Win64".
98 The chosen generator should match your Visual Studio version. Appropriate Visual Studio generators include:
100 | Build Platform | 64-bit Generator | 32-bit Generator |
101 |------------------------------|-------------------------------|-------------------------|
102 | Microsoft Visual Studio 2013 | "Visual Studio 12 2013 Win64" | "Visual Studio 12 2013" |
103 | Microsoft Visual Studio 2015 | "Visual Studio 14 2015 Win64" | "Visual Studio 14 2015" |
104 | Microsoft Visual Studio 2017 | "Visual Studio 15 2017 Win64" | "Visual Studio 15 2017" |
108 ### Linux Build Requirements
110 This repository has been built and tested on the two most recent Ubuntu LTS versions.
111 Currently, the oldest supported version is Ubuntu 14.04, meaning that the minimum supported compiler versions are GCC 4.8.2 and Clang 3.4, although earlier versions may work.
112 It should be straightforward to adapt this repository to other Linux distributions.
114 **Required Package List:**
116 sudo apt-get install git cmake build-essential libx11-xcb-dev libxkbcommon-dev libmirclient-dev libwayland-dev libxrandr-dev
118 - [glslang](https://github.com/KhronosGroup/glslang)
119 - By default, the build scripts will attempt to download the necessary components from the glslang repo.
120 However, if a specific version of this file is required, please see the [Custom glslang Version](#custom-glslang-version) section below.
122 Vulkan Loader Library
123 - Building the cube and vulkaninfo applications require linking to the Vulkan Loader Library (libvulkan.so.1).
124 - The following option should be used on the cmake command line to specify a vulkan loader library:
125 LOADER_REPO_ROOT=/absolute_path_to/Vulkan-Loader
126 making sure to specify an absoute path, like so:
127 cmake -DLOADER_REPO_ROOT=/absolute_path_to/Vulkan-Loader ....
128 Currently, the build directory *must* be named either 'build' or 'build32'.
134 See **Loader and Validation Layer Dependencies** for more information and other options:
136 1. In a Linux terminal, `cd Vulkan-Tools` -- the root of the cloned git repository
137 2. Execute 'git submodule update --init --recursive' -- this will download in-tree external components
138 3. Create a `build` directory, change into that directory, and run cmake:
142 # If an SDK is installed and the setup-env.sh script has been run,
143 cmake -DCMAKE_BUILD_TYPE=Debug ..
144 # Else if a specific version of the loader is desired, indicate the root of the loader repository like so:
145 cmake -DLOADER_REPO_ROOT=/absolute_path_to/Vulkan-Loader -DCMAKE_BUILD_TYPE=Debug ..
147 4. Run `make -j8` to begin the build
149 If your build system supports ccache, you can enable that via CMake option `-DUSE_CCACHE=On`
151 ### WSI Support Build Options
153 By default, the Vulkan Tools cube and cubepp are built with support for all 4 Vulkan-defined WSI display servers: Xcb, Xlib, Wayland, and Mir.
154 It is recommended to build the repository components with support for these display servers to maximize their usability across Linux platforms.
155 If it is necessary to build these modules without support for one of the display servers, the appropriate CMake option of the form `BUILD_WSI_xxx_SUPPORT` can be set to `OFF`.
156 See the CMakeLists.txt file in `Vulkan-Tools/cube` for more info.
158 Note vulkaninfo currently only supports Xcb and Xlib WSI display servers. See the CMakeLists.txt file in `Vulkan-Tools/vulkaninfo` for more info.
160 ### Linux Install to System Directories
162 Installing the files resulting from your build to the systems directories is optional since environment variables can usually be used instead to locate the binaries.
163 There are also risks with interfering with binaries installed by packages.
164 If you are certain that you would like to install your binaries to system directories, you can proceed with these instructions.
166 Assuming that you have built the code as described above and the current directory is still `build`, you can execute:
170 This command installs files to:
172 - `/usr/local/lib`: Vulkan Tools shared objects (e.g., Mock ICD shared library)
173 - `/usr/local/bin`: vulkaninfo application
174 - `/usr/local/share/vulkan/icd.d`: Mock ICD JSON file
176 You may need to run `ldconfig` in order to refresh the system loader search cache on some Linux systems.
178 Note: The Mock ICD is not installed by default since it is a "null" driver that does not render anything
179 and is used for testing purposes.
180 Installing it to system directories may cause some applications to discover and use
181 this driver instead of other full drivers installed on the system.
182 If you really want to install this null driver, use:
186 You can further customize the installation location by setting additional CMake variables to override their defaults.
187 For example, if you would like to install to `/tmp/build` instead of `/usr/local`, on your CMake command line specify:
189 -DCMAKE_INSTALL_PREFIX=/tmp/build
190 -DDEST_DIR=/tmp/build
192 Then run `make install` as before. The install step places the files in `/tmp/build`.
194 You can further customize the installation directories by using the CMake variables
195 `CMAKE_INSTALL_SYSCONFDIR` to rename the `etc` directory and `CMAKE_INSTALL_DATADIR`
196 to rename the `share` directory.
198 See the CMake documentation for more details on using these variables
199 to further customize your installation.
203 To uninstall the files from the system directories, you can execute:
205 sudo make uninstall-Vulkan-Tools
209 After making any changes to the repository, you should perform some quick sanity tests, such as
210 running the cube demo with validation enabled.
212 To run the **Cube application** with validation, in a terminal change to the `build/cube`
215 VK_LAYER_PATH=../path/to/validation/layers ./cube --validate
217 You can select which WSI subsystem is used to build the cube applications using a CMake option
218 called DEMOS_WSI_SELECTION.
219 Supported options are XCB (default), XLIB, WAYLAND, and MIR.
220 Note that you must build using the corresponding BUILD_WSI_*_SUPPORT enabled at the
221 base repository level (all SUPPORT options are ON by default).
222 For instance, creating a build that will use Xlib to build the demos,
223 your CMake command line might look like:
225 cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug -DDEMOS_WSI_SELECTION=XLIB
229 #### Linux 32-bit support
231 Usage of the contents of this repository in 32-bit Linux environments is not officially supported.
232 However, since this repository is supported on 32-bit Windows,
233 these modules should generally work on 32-bit Linux.
235 Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference" platform:
237 If not already installed, install the following 32-bit development libraries:
239 `gcc-multilib g++-multilib libx11-dev:i386`
241 This list may vary depending on your distribution and which windowing systems you are building for.
243 Set up your environment for building 32-bit targets:
248 export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
250 Again, your PKG_CONFIG configuration may be different, depending on your distribution.
252 Finally, rebuild the repository using `cmake` and `make`, as explained above.
254 ## Building On Android
256 Install the required tools for Linux and Windows covered above, then add the following.
258 ### Android Build Requirements
260 - Install [Android Studio 2.3](https://developer.android.com/studio/index.html) or later.
261 - From the "Welcome to Android Studio" splash screen, add the following components using
262 Configure > SDK Manager:
263 - SDK Platforms > Android 6.0 and newer
264 - SDK Tools > Android SDK Build-Tools
265 - SDK Tools > Android SDK Platform-Tools
266 - SDK Tools > Android SDK Tools
269 #### Add Android specifics to environment
271 For each of the below, you may need to specify a different build-tools version, as Android Studio will roll it forward fairly regularly.
275 export ANDROID_SDK_HOME=$HOME/Android/sdk
276 export ANDROID_NDK_HOME=$HOME/Android/sdk/ndk-bundle
277 export PATH=$ANDROID_SDK_HOME:$PATH
278 export PATH=$ANDROID_NDK_HOME:$PATH
279 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
283 set ANDROID_SDK_HOME=%LOCALAPPDATA%\Android\sdk
284 set ANDROID_NDK_HOME=%LOCALAPPDATA%\Android\sdk\ndk-bundle
285 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
289 export ANDROID_SDK_HOME=$HOME/Library/Android/sdk
290 export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk-bundle
291 export PATH=$ANDROID_NDK_PATH:$PATH
292 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
294 Note: If `jarsigner` is missing from your platform, you can find it in the
295 Android Studio install or in your Java installation.
296 If you do not have Java, you can get it with something like the following:
298 sudo apt-get install openjdk-8-jdk
300 #### Additional OSX System Requirements
302 Tested on OSX version 10.13.3
304 Setup Homebrew and components
306 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
308 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
310 - Ensure Homebrew is at the beginning of your PATH:
312 export PATH=/usr/local/bin:$PATH
314 - Add packages with the following:
316 brew install cmake python
320 There are two options for building the Android tools.
321 Either using the SPIRV tools provided as part of the Android NDK, or using upstream sources.
322 To build with SPIRV tools from the NDK, remove the build-android/third_party directory created by
323 running update_external_sources_android.sh, (or avoid running update_external_sources_android.sh).
324 Use the following script to build everything in the repository for Android, including validation
325 layers, tests, demos, and APK packaging: This script does retrieve and use the upstream SPRIV tools.
330 Test and application APKs can be installed on production devices with:
332 ./install_all.sh [-s <serial number>]
334 Note that there are no equivalent scripts on Windows yet, that work needs to be completed.
335 The following per platform commands can be used for layer only builds:
339 Follow the setup steps for Linux or OSX above, then from your terminal:
342 ./update_external_sources_android.sh --no-build
343 ./android-generate.sh
348 Follow the setup steps for Windows above, then from Developer Command Prompt for VS2013:
351 update_external_sources_android.bat
355 ### Android Tests and Demos
357 After making any changes to the repository you should perform some quick sanity tests,
358 including the layer validation tests and the cube and smoke demos with validation enabled.
360 #### Run Layer Validation Tests
362 Use the following steps to build, install, and run the layer validation tests for Android:
366 adb install -r bin/VulkanLayerValidationTests.apk
367 adb shell am start com.example.VulkanLayerValidationTests/android.app.NativeActivity
369 Alternatively, you can use the test_APK script to install and run the layer validation tests:
371 test_APK.sh -s <serial number> -p <plaform name> -f <gtest_filter>
373 #### Run Cube with Validation
375 TODO: This must be reworked to pull in layers from the ValidationLayers repo
377 Use the following steps to build, install, and run Cube for Android:
381 adb install -r ../demos/android/cube/bin/cube.apk
382 adb shell am start com.example.Cube/android.app.NativeActivity
384 To build, install, and run Cube with validation layers,
385 first build layers using steps above, then run:
389 adb install -r ../demos/android/cube-with-layers/bin/cube-with-layers.apk
391 ##### Run without validation enabled
393 adb shell am start com.example.CubeWithLayers/android.app.NativeActivity
395 ##### Run with validation enabled
397 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
401 ### MacOS Build Requirements
403 Tested on OSX version 10.12.6
405 Setup Homebrew and components
407 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
409 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
411 - Ensure Homebrew is at the beginning of your PATH:
413 export PATH=/usr/local/bin:$PATH
415 - Add packages with the following (may need refinement)
417 brew install cmake python python3 git
419 - [glslang](https://github.com/KhronosGroup/glslang)
420 - By default, the build scripts will attempt to download the necessary components from the glslang repo.
421 However, if a specific version of this file is required, please see the [Custom glslang Version](#custom-glslang-version) section below.
423 ### Clone the Repository
425 Clone the Vulkan-LoaderAndValidationLayers repository:
427 git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers.git
429 ### Get the External Libraries
431 [MoltenVK](https://github.com/KhronosGroup/MoltenVK) Library
433 - Building the cube and vulkaninfo applications require linking to the MoltenVK Library (libMoltenVK.dylib)
434 - The following option should be used on the cmake command line to specify a vulkan loader library:
435 MOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK making sure to specify an absolute path, like so:
436 cmake -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK ....
438 Vulkan Loader Library
440 - Building the cube and vulkaninfo applications require linking to the Vulkan Loader Library (libvulkan.1.dylib)
441 - The following option should be used on the cmake command line to specify a vulkan loader library:
442 LOADER_REPO_ROOT=/absolute_path_to/Vulkan-Loader making sure to specify an absolute path, like so:
443 cmake -DLOADER_REPO_ROOT=/absolute_path_to/Vulkan-Loader ....
447 #### CMake Generators
449 This repository uses CMake to generate build or project files that are
450 then used to build the repository.
451 The CMake generators explicitly supported in this repository are:
456 #### Building with the Unix Makefiles Generator
458 This generator is the default generator, so all that is needed for a debug
463 cmake -DCMAKE_BUILD_TYPE=Debug -DLOADER_REPO_ROOT=/absolute_path_to/Vulkan-Loader -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK ..
466 To speed up the build on a multi-core machine, use the `-j` option for `make`
467 to specify the number of cores to use for the build.
472 You can now run the demo applications from the command line:
476 open vulkaninfo/vulkaninfo.app
478 Or you can locate them from `Finder` and launch them from there.
480 ##### The Install Target and RPATH
482 The applications you just built are "bundled applications", but the executables
483 are using the `RPATH` mechanism to locate runtime dependencies that are still
486 To see this, run this command from your `build` directory:
488 otool -l cube/cube.app/Contents/MacOS/cube
490 and note that the `cube` executable contains loader commands:
492 - `LC_LOAD_DYLIB` to load `libvulkan.1.dylib` via an `@rpath`
493 - `LC_RPATH` that contains an absolute path to the build location of the Vulkan loader
495 This makes the bundled application "non-transportable", meaning that it won't run
496 unless the Vulkan loader is on that specific absolute path.
497 This is useful for debugging the loader or other components built in this repository,
498 but not if you want to move the application to another machine or remove your build tree.
500 To address this problem, run:
504 This step "cleans up" the `RPATH` to remove any external references
505 and performs other bundle fix-ups.
506 After running `make install`, re-run the `otool` command again and note:
508 - `LC_LOAD_DYLIB` is now `@executable_path/../MacOS/libvulkan.1.dylib`
509 - `LC_RPATH` is no longer present
511 The "bundle fix-up" operation also puts a copy of the Vulkan loader into the bundle,
512 making the bundle completely self-contained and self-referencing.
514 Note that the "install" target has a very different meaning compared to the Linux
515 "make install" target.
516 The Linux "install" copies the targets to system directories.
517 In MacOS, "install" means fixing up application bundles.
518 In both cases, the "install" target operations clean up the `RPATH`.
520 ##### The Non-bundled vulkaninfo Application
522 There is also a non-bundled version of the `vulkaninfo` application that you can
523 run from the command line:
525 vulkaninfo/vulkaninfo
527 If you run this before you run "make install", vulkaninfo's RPATH is already set
528 to point to the Vulkan loader in the build tree, so it has no trouble finding it.
529 But the loader will not find the MoltenVK driver and you'll see a message about an
530 incompatible driver. To remedy this:
532 VK_ICD_FILENAMES=<path-to>/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json demos/vulkaninfo
534 If you run `vulkaninfo` after doing a "make install", the `RPATH` in the `vulkaninfo` application
535 got removed and the OS needs extra help to locate the Vulkan loader:
537 DYLD_LIBRARY_PATH=<path-to>/Vulkan-Loader/loader VK_ICD_FILENAMES=<path-to>/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json demos/vulkaninfo
539 #### Building with the Xcode Generator
541 To create and open an Xcode project:
545 cmake -DLOADER_REPO_ROOT=/absolute_path_to/Vulkan-Loader -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK -GXcode ..
546 open VULKAN.xcodeproj
548 Within Xcode, you can select Debug or Release builds in the project's Build Settings.
549 You can also select individual schemes for working with specific applications like `cube`.
551 ## Ninja Builds - All Platforms
553 The [Qt Creator IDE](https://qt.io/download-open-source/#section-2) can open a root CMakeList.txt
554 as a project directly, and it provides tools within Creator to configure and generate Vulkan SDK
555 build files for one to many targets concurrently.
556 Alternatively, when invoking CMake, use the `-G "Codeblocks - Ninja"` option to generate Ninja build
557 files to be used as project files for QtCreator
559 - Open, configure, and build the Vulkan-Tools CMakeList.txt file
560 - In order to debug with QtCreator, a
561 [Microsoft WDK: eg WDK 10](http://go.microsoft.com/fwlink/p/?LinkId=526733) is required.
563 Note that installing the WDK breaks the MSVC vcvarsall.bat build scripts provided by MSVC,
564 requiring that the LIB, INCLUDE, and PATHenv variables be set to the WDK paths by some other means
566 ## Custom glslang version
568 The Glslang repository is not a git sub-module of Vulkan-Tools, but glslang components are required to build
569 the cube and cubepp applications. By default, the cmake scripts will download the required
570 components into the repo 'glslang' directory.
572 If a *specific* version of the glslang components is desired, perform the following steps:
574 1) clone the glslang repository:
576 `git clone https://github.com/KhronosGroup/glslang.git`
578 2) Configure the glslang source tree with CMake and build it with your IDE of choice, following the instructions
579 in the glslang BUILD.md document including using the INSTALL_PREFIX and 'make install'. Note the install directory.
581 3) Pass the location of the glslang install directory using an absolute path via your cmake command like so:
583 cmake -DGLSLANG_INSTALL_DIR=c:\absolute_path_to\glslang\build\install
585 ## Optional software packages
587 - [Cygwin for windows](https://www.cygwin.com/)
588 - Cygwin provides some Linux-like tools, which can be valuable for working with the repository,
589 such as the BASH shell and git packages
590 - With appropriate adjustments, it is possible to use other shells and environments as well
592 - [Ninja on all platforms](https://github.com/ninja-build/ninja/releases)
593 - [The Ninja-build project](https://ninja-build.org)
594 - [Ninja Users Manual](https://ninja-build.org/manual.html)
596 - [QtCreator as IDE for CMake builds on all platforms](https://qt.io/download-open-source/#section-2)