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-ValidationLayers
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 ....
66 ### Windows Build - Microsoft Visual Studio
68 1. Open a Developer Command Prompt for VS201x
69 2. Change directory to `Vulkan-LoaderAndValidationLayers` -- the root of the cloned git repository
70 3. Run 'git submodule update --init --recursive' -- this will download in-tree external dependencies
71 4. Create a `build` directory, change into that directory, and run cmake
73 For example, for VS2017 (generators for other versions are [specified here](#cmake-visual-studio-generators)):
75 cmake -DLOADER_REPO_ROOT=c:/absolute_path_to/Vulkan-Loader -G "Visual Studio 15 2017 Win64" ..
77 This will create a Windows solution file named `VULKAN.sln` in the build directory.
79 Launch Visual Studio and open the "VULKAN.sln" solution file in the build folder.
80 You may select "Debug" or "Release" from the Solution Configurations drop-down list.
81 Start a build by selecting the Build->Build Solution menu item.
82 This solution copies the loader it built to each program's build directory
83 to ensure that the program uses the loader built from this solution.
85 ### Windows Tests and Demos
87 After making any changes to the repository, you should perform some quick sanity tests,
88 including the run_all_tests Powershell script and the cube demo with validation enabled.
90 To run the validation test script, open a Powershell Console,
91 change to the build/tests directory, and run:
99 .\run_all_tests.ps1 -Debug
101 This script will run the following tests:
103 - `vk_loader_validation_tests`:
104 Vulkan loader handle wrapping, allocation callback, and loader/layer interface tests
105 - `vk_layer_validation_tests`:
106 Test Vulkan validation layers
107 - `vkvalidatelayerdoc`:
108 Tests that validation database is up-to-date and is synchronized with the validation source code
110 To run the Cube demo with validation in a Debug build configuration:
112 - In the MSVC solution explorer, right-click on the `cube` project and select
113 `Set As Startup Project`
114 - Right click on cube again, select properties->Debugging->Command Arguments, change to
115 `--validate`, and save
116 - From the main menu, select Debug->Start Debugging, or from the toolbar click
117 `Local Windows Debugger`
119 Other applications that can be found in the Vulkan-Tools repository are:
121 - `vulkaninfo`: Report GPU properties
125 #### CMake Visual Studio Generators
127 The above example used Visual Studio 2017, and specified its generator as "Visual Studio 15 2017 Win64".
128 The chosen generator should match your Visual Studio version. Appropriate Visual Studio generators include:
130 | Build Platform | 64-bit Generator | 32-bit Generator |
131 |------------------------------|-------------------------------|-------------------------|
132 | Microsoft Visual Studio 2013 | "Visual Studio 12 2013 Win64" | "Visual Studio 12 2013" |
133 | Microsoft Visual Studio 2015 | "Visual Studio 14 2015 Win64" | "Visual Studio 14 2015" |
134 | Microsoft Visual Studio 2017 | "Visual Studio 15 2017 Win64" | "Visual Studio 15 2017" |
138 ### Linux Build Requirements
140 This repository has been built and tested on the two most recent Ubuntu LTS versions.
141 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.
142 It should be straightforward to adapt this repository to other Linux distributions.
144 **Required Package List:**
146 sudo apt-get install git cmake build-essential libx11-xcb-dev libxkbcommon-dev libmirclient-dev libwayland-dev libxrandr-dev
148 Vulkan Loader Library
149 - Building the cube and vulkaninfo applications require linking to the Vulkan Loader Library (libvulkan-1.so).
150 - The following option should be used on the cmake command line to specify a vulkan loader library:
151 LOADER_REPO_ROOT=c:\absolute_path_to\Vulkan-Loader
152 makeing sure to specify an absoute path, like so:
153 cmake -DLOADER_REPO_ROOT=c:\absolute_path_to\Vulkan-Loader ....
159 See **Loader and Validation Layer Dependencies** for more information and other options:
161 1. In a Linux terminal, `cd Vulkan-Tools` -- the root of the cloned git repository
162 2. Execute 'git submodule update --init --recursive' -- this will download in-tree external components
163 3. Create a `build` directory, change into that directory, and run cmake:
167 cmake -DLOADER_REPO_ROOT=/absolute_path_to/Vulkan-Loader -DCMAKE_BUILD_TYPE=Debug ..
169 4. Run `make -j8` to begin the build
171 If your build system supports ccache, you can enable that via CMake option `-DUSE_CCACHE=On`
173 ### WSI Support Build Options
175 By default, the Vulkan Tools are built with support for all 4 Vulkan-defined WSI display servers: Xcb, Xlib, Wayland, and Mir.
176 It is recommended to build the repository components with support for these display servers to maximize their usability across Linux platforms.
177 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`.
178 See the top-level CMakeLists.txt file for more info.
180 ### Linux Install to System Directories
182 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.
183 There are also risks with interfering with binaries installed by packages.
184 If you are certain that you would like to install your binaries to system directories, you can proceed with these instructions.
186 Assuming that you have built the code as described above and the current directory is still `build`, you can execute:
190 This command installs files to:
192 - `/usr/local/include/vulkan`: Vulkan include files
193 - `/usr/local/lib`: Vulkan Tools shared objects
194 - `/usr/local/bin`: vulkaninfo application
195 - `/usr/local/bin`: cube application
196 - `/usr/local/bin`: cubepp application
198 You may need to run `ldconfig` in order to refresh the system loader search cache on some Linux systems.
200 You can further customize the installation location by setting additional CMake variables to override their defaults.
201 For example, if you would like to install to `/tmp/build` instead of `/usr/local`, on your CMake command line specify:
203 -DCMAKE_INSTALL_PREFIX=/tmp/build
204 -DDEST_DIR=/tmp/build
206 Then run `make install` as before. The install step places the files in `/tmp/build`.
208 You can further customize the installation directories by using the CMake variables
209 `CMAKE_INSTALL_SYSCONFDIR` to rename the `etc` directory and `CMAKE_INSTALL_DATADIR`
210 to rename the `share` directory.
212 See the CMake documentation for more details on using these variables
213 to further customize your installation.
217 To uninstall the files from the system directories, you can execute:
223 After making any changes to the repository, you should perform some quick sanity tests, such as
224 running the cube demo with validation enabled.
226 To run the **Cube application** with validation, in a terminal change to the `build/cube`
229 VK_LAYER_PATH=../path/to/validation/layers ./cube --validate
231 You can select which WSI subsystem is used to build the cube applications using a CMake option
232 called DEMOS_WSI_SELECTION.
233 Supported options are XCB (default), XLIB, WAYLAND, and MIR.
234 Note that you must build using the corresponding BUILD_WSI_*_SUPPORT enabled at the
235 base repository level (all SUPPORT options are ON by default).
236 For instance, creating a build that will use Xlib to build the demos,
237 your CMake command line might look like:
239 cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug -DDEMOS_WSI_SELECTION=XLIB
243 #### Linux 32-bit support
245 Usage of the contents of this repository in 32-bit Linux environments is not officially supported.
246 However, since this repository is supported on 32-bit Windows,
247 these modules should generally work on 32-bit Linux.
249 Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference" platform:
251 If not already installed, install the following 32-bit development libraries:
253 `gcc-multilib g++-multilib libx11-dev:i386`
255 This list may vary depending on your distribution and which windowing systems you are building for.
257 Set up your environment for building 32-bit targets:
262 export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
264 Again, your PKG_CONFIG configuration may be different, depending on your distribution.
266 Finally, rebuild the repository using `cmake` and `make`, as explained above.
268 ## Building On Android
270 Install the required tools for Linux and Windows covered above, then add the following.
272 ### Android Build Requirements
274 - Install [Android Studio 2.3](https://developer.android.com/studio/index.html) or later.
275 - From the "Welcome to Android Studio" splash screen, add the following components using
276 Configure > SDK Manager:
277 - SDK Platforms > Android 6.0 and newer
278 - SDK Tools > Android SDK Build-Tools
279 - SDK Tools > Android SDK Platform-Tools
280 - SDK Tools > Android SDK Tools
283 #### Add Android specifics to environment
285 For each of the below, you may need to specify a different build-tools version, as Android Studio will roll it forward fairly regularly.
289 export ANDROID_SDK_HOME=$HOME/Android/sdk
290 export ANDROID_NDK_HOME=$HOME/Android/sdk/ndk-bundle
291 export PATH=$ANDROID_SDK_HOME:$PATH
292 export PATH=$ANDROID_NDK_HOME:$PATH
293 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
297 set ANDROID_SDK_HOME=%LOCALAPPDATA%\Android\sdk
298 set ANDROID_NDK_HOME=%LOCALAPPDATA%\Android\sdk\ndk-bundle
299 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
303 export ANDROID_SDK_HOME=$HOME/Library/Android/sdk
304 export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk-bundle
305 export PATH=$ANDROID_NDK_PATH:$PATH
306 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
308 Note: If `jarsigner` is missing from your platform, you can find it in the
309 Android Studio install or in your Java installation.
310 If you do not have Java, you can get it with something like the following:
312 sudo apt-get install openjdk-8-jdk
314 #### Additional OSX System Requirements
316 Tested on OSX version 10.13.3
318 Setup Homebrew and components
320 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
322 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
324 - Ensure Homebrew is at the beginning of your PATH:
326 export PATH=/usr/local/bin:$PATH
328 - Add packages with the following:
330 brew install cmake python
334 There are two options for building the Android tools.
335 Either using the SPIRV tools provided as part of the Android NDK, or using upstream sources.
336 To build with SPIRV tools from the NDK, remove the build-android/third_party directory created by
337 running update_external_sources_android.sh, (or avoid running update_external_sources_android.sh).
338 Use the following script to build everything in the repository for Android, including validation
339 layers, tests, demos, and APK packaging: This script does retrieve and use the upstream SPRIV tools.
344 Test and application APKs can be installed on production devices with:
346 ./install_all.sh [-s <serial number>]
348 Note that there are no equivalent scripts on Windows yet, that work needs to be completed.
349 The following per platform commands can be used for layer only builds:
353 Follow the setup steps for Linux or OSX above, then from your terminal:
356 ./update_external_sources_android.sh --no-build
357 ./android-generate.sh
362 Follow the setup steps for Windows above, then from Developer Command Prompt for VS2013:
365 update_external_sources_android.bat
369 ### Android Tests and Demos
371 After making any changes to the repository you should perform some quick sanity tests,
372 including the layer validation tests and the cube and smoke demos with validation enabled.
374 #### Run Layer Validation Tests
376 Use the following steps to build, install, and run the layer validation tests for Android:
380 adb install -r bin/VulkanLayerValidationTests.apk
381 adb shell am start com.example.VulkanLayerValidationTests/android.app.NativeActivity
383 Alternatively, you can use the test_APK script to install and run the layer validation tests:
385 test_APK.sh -s <serial number> -p <plaform name> -f <gtest_filter>
387 #### Run Cube with Validation
389 TODO: This must be reworked to pull in layers from the ValidationLayers repo
391 Use the following steps to build, install, and run Cube for Android:
395 adb install -r ../demos/android/cube/bin/cube.apk
396 adb shell am start com.example.Cube/android.app.NativeActivity
398 To build, install, and run Cube with validation layers,
399 first build layers using steps above, then run:
403 adb install -r ../demos/android/cube-with-layers/bin/cube-with-layers.apk
405 ##### Run without validation enabled
407 adb shell am start com.example.CubeWithLayers/android.app.NativeActivity
409 ##### Run with validation enabled
411 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
415 ### MacOS Build Requirements
417 Tested on OSX version 10.12.6
419 Setup Homebrew and components
421 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
423 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
425 - Ensure Homebrew is at the beginning of your PATH:
427 export PATH=/usr/local/bin:$PATH
429 - Add packages with the following (may need refinement)
431 brew install cmake python python3 git
433 ### Clone the Repository
435 Clone the Vulkan-LoaderAndValidationLayers repository:
437 git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers.git
439 ### Get the External Libraries
441 TODO: Update with macOS procedure for satisfying external dependencies
445 #### CMake Generators
447 This repository uses CMake to generate build or project files that are
448 then used to build the repository.
449 The CMake generators explicitly supported in this repository are:
454 #### Building with the Unix Makefiles Generator
456 This generator is the default generator, so all that is needed for a debug
461 cmake -DCMAKE_BUILD_TYPE=Debug ..
464 To speed up the build on a multi-core machine, use the `-j` option for `make`
465 to specify the number of cores to use for the build.
470 You can now run the demo applications from the command line:
473 open demos/cubepp.app
474 open demos/vulkaninfo.app
476 Or you can locate them from `Finder` and launch them from there.
478 ##### The Install Target and RPATH
480 The applications you just built are "bundled applications", but the executables
481 are using the `RPATH` mechanism to locate runtime dependencies that are still
484 To see this, run this command from your `build` directory:
486 otool -l demos/cube.app/Contents/MacOS/cube
488 and note that the `cube` executable contains loader commands:
490 - `LC_LOAD_DYLIB` to load `libvulkan.1.dylib` via an `@rpath`
491 - `LC_RPATH` that contains an absolute path to the build location of the Vulkan loader
493 This makes the bundled application "non-transportable", meaning that it won't run
494 unless the Vulkan loader is on that specific absolute path.
495 This is useful for debugging the loader or other components built in this repository,
496 but not if you want to move the application to another machine or remove your build tree.
498 To address this problem, run:
502 This step "cleans up" the `RPATH` to remove any external references
503 and performs other bundle fix-ups.
504 After running `make install`, re-run the `otool` command again and note:
506 - `LC_LOAD_DYLIB` is now `@executable_path/../MacOS/libvulkan.1.dylib`
507 - `LC_RPATH` is no longer present
509 The "bundle fix-up" operation also puts a copy of the Vulkan loader into the bundle,
510 making the bundle completely self-contained and self-referencing.
512 Note that the "install" target has a very different meaning compared to the Linux
513 "make install" target.
514 The Linux "install" copies the targets to system directories.
515 In MacOS, "install" means fixing up application bundles.
516 In both cases, the "install" target operations clean up the `RPATH`.
518 ##### The Non-bundled vulkaninfo Application
520 There is also a non-bundled version of the `vulkaninfo` application that you can
521 run from the command line:
525 If you run this before you run "make install", vulkaninfo's RPATH is already set
526 to point to the Vulkan loader in the build tree, so it has no trouble finding it.
527 But the loader will not find the MoltenVK driver and you'll see a message about an
528 incompatible driver. To remedy this:
530 VK_ICD_FILENAMES=../external/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json demos/vulkaninfo
532 If you run `vulkaninfo` after doing a "make install", the `RPATH` in the `vulkaninfo` application
533 got removed and the OS needs extra help to locate the Vulkan loader:
535 DYLD_LIBRARY_PATH=loader VK_ICD_FILENAMES=../external/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json demos/vulkaninfo
537 #### Building with the Xcode Generator
539 To create and open an Xcode project:
544 open VULKAN.xcodeproj
546 Within Xcode, you can select Debug or Release builds in the project's Build Settings.
547 You can also select individual schemes for working with specific applications like `cube`.
549 ## Ninja Builds - All Platforms
551 The [Qt Creator IDE](https://qt.io/download-open-source/#section-2) can open a root CMakeList.txt
552 as a project directly, and it provides tools within Creator to configure and generate Vulkan SDK
553 build files for one to many targets concurrently.
554 Alternatively, when invoking CMake, use the `-G "Codeblocks - Ninja"` option to generate Ninja build
555 files to be used as project files for QtCreator
557 - Open, configure, and build the glslang CMakeList.txt files. Note that building the glslang
558 project will provide access to spirv-tools and spirv-headers
559 - Then do the same with the Vulkan-LoaderAndValidationLayers 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 ## Vulkan-Tools Dependencies
568 The glslang repository is required to build and run Vulkan Tools components.
569 It is not a git sub-module of Vulkan-Tools, but glslang components are required to build
570 the cube and vulkaninfo applications.
572 If an existing glslang repository installation is unavailable, do the following steps:
574 1) clone the 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
580 3) Pass the location of the glslang repository using an absolute path via your cmake command like so:
582 cmake -DGLSLANG_REPO_ROOT=c:\absolute_path_to\glslang
584 4) If building on Windows with MSVC, set `DISABLE_BUILDTGT_DIR_DECORATION` to _On_.
585 If building on Windows, but without MSVC set `DISABLE_BUILD_PATH_DECORATION` to _On_
587 ## Optional software packages
589 - [Cygwin for windows](https://www.cygwin.com/)
590 - Cygwin provides some Linux-like tools, which can be valuable for working with the repository,
591 such as the BASH shell and git packages
592 - With appropriate adjustments, it is possible to use other shells and environments as well
594 - [Ninja on all platforms](https://github.com/ninja-build/ninja/releases)
595 - [The Ninja-build project](https://ninja-build.org)
596 - [Ninja Users Manual](https://ninja-build.org/manual.html)
598 - [QtCreator as IDE for CMake builds on all platforms](https://qt.io/download-open-source/#section-2)