2 This document contains the instructions for building this repository on Linux and Windows.
4 This repository does not contain a Vulkan-capable driver.
5 Before proceeding, it is strongly recommended that you obtain a Vulkan driver from your graphics hardware vendor
10 If you intend to contribute, the preferred work flow is for you to develop your contribution
11 in a fork of this repo in your GitHub account and then submit a pull request.
12 Please see the [CONTRIBUTING](CONTRIBUTING.md) file in this repository for more details.
16 To create your local git repository:
18 git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers
23 The build process uses CMake to generate makefiles for this project.
24 The build generates the loader, layers, and tests.
26 This repo has been built and tested on the two most recent Ubuntu LTS versions. Currently, the oldest supported
27 version is Ubuntu 14.04, meaning that the minimum supported compiler versions are GCC 4.8.2 and Clang 3.4, although
28 earlier versions may work.
29 It should be straightforward to adapt this repository to other Linux distributions.
32 These packages are needed to build this repository:
34 sudo apt-get install git cmake build-essential bison libx11-xcb-dev libxkbcommon-dev libmirclient-dev libwayland-dev libxrandr-dev
37 Example debug build (Note that the update\_external\_sources script used below builds external tools into predefined locations. See **Loader and Validation Layer Dependencies** for more information and other options):
39 cd Vulkan-LoaderAndValidationLayers # cd to the root of the cloned git repository
40 ./update_external_sources.sh
41 cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug
46 If your build system supports ccache, you can enable that via cmake option `-DUSE_CCACHE=On`
48 If you have installed a Vulkan driver obtained from your graphics hardware vendor, the install process should
49 have configured the driver so that the Vulkan loader can find and load it.
51 If you want to use the loader and layers that you have just built:
53 export LD_LIBRARY_PATH=<path to your repository root>/dbuild/loader
54 export VK_LAYER_PATH=<path to your repository root>/dbuild/layers
56 You can run the `vulkaninfo` application to see which driver, loader and layers are being used.
58 The `LoaderAndLayerInterface` document in the `loader` folder in this repository is a specification that
59 describes both how ICDs and layers should be properly
60 packaged, and how developers can point to ICDs and layers within their builds.
62 ### WSI Support Build Options
63 By default, the Vulkan Loader and Validation Layers are built with support for all 4 Vulkan-defined WSI display systems, Xcb, Xlib, Wayland, and Mir. It is recommended to build these modules with support for these
64 display systems to maximize their usability across Linux platforms.
65 If it is necessary to build these modules without support for one of the display systems, the appropriate CMake option of the form BUILD_WSI_xxx_SUPPORT can be set to OFF. See the top-level CMakeLists.txt file for more info.
67 ### Linux Install to System Directories
69 Installing the files resulting from your build to the systems directories is optional since
70 environment variables can usually be used instead to locate the binaries.
71 There are also risks with interfering with binaries installed by packages.
72 If you are certain that you would like to install your binaries to system directories,
73 you can proceed with these instructions.
75 Assuming that you've built the code as described above and the current directory is still `dbuild`,
82 This command installs files to:
84 * `/usr/local/include/vulkan`: Vulkan include files
85 * `/usr/local/lib`: Vulkan loader and layers shared objects
86 * `/usr/local/bin`: vulkaninfo application
87 * `/usr/local/etc/vulkan/explicit_layer.d`: Layer JSON files
89 You may need to run `ldconfig` in order to refresh the system loader search cache on some Linux systems.
91 The list of installed files appears in the build directory in a file named `install_manifest.txt`.
92 You can easily remove the installed files with:
95 cat install_manifest.txt | sudo xargs rm
98 You can further customize the installation location by setting additional CMake variables
99 to override their defaults.
100 For example, if you would like to install to `/tmp/build` instead of `/usr/local`, specify:
103 -DCMAKE_INSTALL_PREFIX=/tmp/build
104 -DDEST_DIR=/tmp/build
107 on your CMake command line and run `make install` as before.
108 The install step places the files in `/tmp/build`.
110 Using the `CMAKE_INSTALL_PREFIX` to customize the install location also modifies the
111 loader search paths to include searching for layers in the specified install location.
112 In this example, setting `CMAKE_INSTALL_PREFIX` to `/tmp/build` causes the loader to
113 search `/tmp/build/etc/vulkan/explicit_layer.d` and `/tmp/build/share/vulkan/explicit_layer.d`
114 for the layer JSON files.
115 The loader also searches the "standard" system locations of `/etc/vulkan/explicit_layer.d`
116 and `/usr/share/vulkan/explicit_layer.d` after searching the two locations under `/tmp/build`.
118 You can further customize the installation directories by using the CMake variables
119 `CMAKE_INSTALL_SYSCONFDIR` to rename the `etc` directory and `CMAKE_INSTALL_DATADIR`
120 to rename the `share` directory.
122 See the CMake documentation for more details on using these variables
123 to further customize your installation.
125 Also see the `LoaderAndLayerInterface` document in the `loader` folder in this repository for more
126 information about loader operation.
128 Note that some executables in this repository (e.g., `cube`) use the "rpath" linker directive
129 to load the Vulkan loader from the build directory, `dbuild` in this example.
130 This means that even after installing the loader to the system directories, these executables
131 still use the loader from the build directory.
133 ### Linux 32-bit support
135 Usage of this repository's contents in 32-bit Linux environments is not officially supported.
136 However, since this repository is supported on 32-bit Windows, these modules should generally
137 work on 32-bit Linux.
139 Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference" platform:
141 If not already installed, install the following 32-bit development libraries:
143 `gcc-multilib g++-multilib libx11-dev:i386`
145 This list may vary depending on your distro and which windowing systems you are building for.
147 Set up your environment for building 32-bit targets:
153 export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
156 Again, your PKG_CONFIG configuration may be different, depending on your distro.
158 If the libraries in the `external` directory have already been built
160 delete or "clean" this directory and rebuild it with
161 the above settings using the `update_external_sources` shell script.
162 This is required because the libraries in `external` must be built for
163 32-bit in order to be usable by the rest of the components in the repository.
165 Finally, rebuild the repository using `cmake` and `make`, as explained above.
169 The test executables can be found in the dbuild/tests directory.
170 Some of the tests that are available:
171 - vk\_layer\_validation\_tests: Test Vulkan layers.
173 There are also a few shell and Python scripts that run test collections (eg,
178 Some demos that can be found in the dbuild/demos directory are:
179 - vulkaninfo: report GPU properties
180 - cube: a textured spinning cube
181 - smoke/smoke: A "smoke" test using a more complex Vulkan demo
183 You can select which WSI subsystem is used to build the demos using a cmake option called DEMOS_WSI_SELECTION.
184 Supported options are XCB (default), XLIB, WAYLAND, and MIR. Note that you must build using the corresponding BUILD_WSI_*_SUPPORT enabled at the base repo level (all SUPPORT options are ON by default).
185 For instance, creating a build that will use Xlib to build the demos, your cmake command line might look like:
187 cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug -DDEMOS_WSI_SELECTION=XLIB
189 ## Windows System Requirements
191 Windows 7+ with additional required software packages:
193 - Microsoft Visual Studio 2013 Professional. Note: it is possible that lesser/older versions may work, but that has not been tested.
194 - [CMake](http://www.cmake.org/download/). Notes:
195 - Tell the installer to "Add CMake to the system PATH" environment variable.
196 - [Python 3](https://www.python.org/downloads). Notes:
197 - Select to install the optional sub-package to add Python to the system PATH environment variable.
198 - Ensure the pip module is installed (it should be by default)
199 - Need python3.3 or later to get the Windows py.exe launcher that is used to get python3 rather than python2 if both are installed on Windows
200 - 32 bit python works
201 - [Git](http://git-scm.com/download/win).
202 - Note: If you use Cygwin, you can normally use Cygwin's "git.exe", and "update\_external\_sources.sh --no-build" does support Cygwin's git. However, in order to use the "update\_external\_sources.bat" script, you must have this version.
203 - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
204 - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
205 - Install each a 32-bit and a 64-bit version, as the 64-bit installer does not install the 32-bit libraries and tools.
206 - glslang is required for demos and tests.
207 - [You can download and configure it (in a peer directory) here](https://github.com/KhronosGroup/glslang/blob/master/README.md)
208 - A windows batch file has been included that will pull and build the correct version. Run it from Developer Command Prompt for VS2013 like so:
209 - update\_external\_sources.bat --build-glslang (Note: see **Loader and Validation Layer Dependencies** below for other options)
211 ## Windows Build - MSVC
213 Before building on Windows, you may want to modify the customize section in loader/loader.rc to so as to
214 set the version numbers and build description for your build. Doing so will set the information displayed
215 for the Properties->Details tab of the loader vulkan-1.dll file that is built.
217 Build all Windows targets after installing required software and cloning the Loader and Validation Layer repo as described above by completing the following steps in a "Developer Command Prompt for VS2013" window (Note that the update\_external\_sources script used below builds external tools into predefined locations. See **Loader and Validation Layer Dependencies** for more information and other options):
219 cd Vulkan-LoaderAndValidationLayers # cd to the root of the cloned git repository
220 update_external_sources.bat
221 build_windows_targets.bat
224 At this point, you can use Windows Explorer to launch Visual Studio by double-clicking on the "VULKAN.sln" file in the \build folder. Once Visual Studio comes up, you can select "Debug" or "Release" from a drop-down list. You can start a build with either the menu (Build->Build Solution), or a keyboard shortcut (Ctrl+Shift+B). As part of the build process, Python scripts will create additional Visual Studio files and projects, along with additional source files. All of these auto-generated files are under the "build" folder.
226 Vulkan programs must be able to find and use the vulkan-1.dll library. Make sure it is either installed in the C:\Windows\System32 folder, or the PATH environment variable includes the folder that it is located in.
228 To run Vulkan programs you must tell the icd loader where to find the libraries.
229 This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
230 This specification describes both how ICDs and layers should be properly
231 packaged, and how developers can point to ICDs and layers within their builds.
235 If you are using Cygwin git instead of win32-native git, you can use the *sh* script to sync using Cygwin's git (but not also build), then use the *bat* script to build (but not also sync).
237 In a cygwin shell do this:
239 ./update_external_sources.sh --no-build
242 Then in a Visual Studio Developer Command Prompt shell do this:
244 update_external_sources.bat --no-sync
248 Install the required tools for Linux and Windows covered above, then add the following.
250 - Install [Android Studio 2.3](https://developer.android.com/studio/index.html) or later.
251 - From the "Welcome to Android Studio" splash screen, add the following components using Configure > SDK Manager:
252 - SDK Platforms > Android 6.0 and newer
253 - SDK Tools > Android SDK Build-Tools
254 - SDK Tools > Android SDK Platform-Tools
255 - SDK Tools > Android SDK Tools
258 #### Add Android specifics to environment
259 For each of the below, you may need to specify a different build-tools version, as Android Studio will roll it forward fairly regularly.
263 export ANDROID_SDK_HOME=$HOME/Android/sdk
264 export ANDROID_NDK_HOME=$HOME/Android/sdk/ndk-bundle
265 export PATH=$ANDROID_SDK_HOME:$PATH
266 export PATH=$ANDROID_NDK_HOME:$PATH
267 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
271 set ANDROID_SDK_HOME=%LOCALAPPDATA%\Android\sdk
272 set ANDROID_NDK_HOME=%LOCALAPPDATA%\Android\sdk\ndk-bundle
273 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
277 export ANDROID_SDK_HOME=$HOME/Library/Android/sdk
278 export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk-bundle
279 export PATH=$ANDROID_NDK_PATH:$PATH
280 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
282 Note: If jarsigner is missing from your platform, you can find it in the Android Studio install or in your Java installation. If you do not have Java, you can get it with something like the following:
284 sudo apt-get install openjdk-8-jdk
287 ### Additional OSX System Requirements
288 Tested on OSX version 10.12.4
290 Setup Homebrew and components
291 - Follow instructions on [brew.sh](http://brew.sh) to get homebrew installed.
293 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
295 - Ensure Homebrew is at the beginning of your PATH:
297 export PATH=/usr/local/bin:$PATH
299 - Add packages with the following (may need refinement)
301 brew install cmake python python3 git
303 ### Build steps for Android
305 There are two options for building the Android layers. One using the SPIRV tools
306 provided as part of the Android NDK or build using upstream sources.
307 To build with SPIRV tools from the NDK, remove the build-android/third_party directory created
308 by running update_external_sources_android.sh, (or never run update_external_sources_android.sh).
309 Use the following script to build everything in the repo for Android, including validation layers, tests, demos, and APK packaging:
310 This script does retrieve and use the upstream SPRIV tools.
315 Resulting validation layer binaries will be in build-android/libs.
316 Test and demo APKs can be installed on production devices with:
318 ./install_all.sh [-s <serial number>]
320 Note that there are no equivalent scripts on Windows yet, that work needs to be completed.
321 The following per platform commands can be used for layer only builds:
323 Follow the setup steps for Linux or OSX above, then from your terminal:
326 ./update_external_sources_android.sh --no-build
327 ./android-generate.sh
328 ndk-build -j $(sysctl -n hw.ncpu)
331 Follow the setup steps for Windows above, then from Developer Command Prompt for VS2013:
334 update_external_sources_android.bat
339 Use the following steps to build, install, and run the layer validation tests for Android:
343 adb install -r bin/VulkanLayerValidationTests.apk
344 adb shell am start com.example.VulkanLayerValidationTests/android.app.NativeActivity
346 Alternatively, you can use the test_APK script to install and run the layer validation tests:
348 test_APK.sh -s <serial number> -p <plaform name> -f <gtest_filter>
351 Use the following steps to build, install, and run Cube and Smoke for Android:
355 adb install -r ../demos/android/cube/bin/cube.apk
356 adb shell am start com.example.Cube/android.app.NativeActivity
358 To build, install, and run Cube with validation layers, first build layers using steps above, then run:
362 adb install -r ../demos/android/cube-with-layers/bin/cube-with-layers.apk
363 # Run without validation enabled:
364 adb shell am start com.example.CubeWithLayers/android.app.NativeActivity
365 # Run with validation enabled:
366 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
368 vkjson_info for Android is built as an executable for devices with root access.
370 To use, simply push it to the device and run it:
373 adb push obj/local/<abi>/vkjson_info /data/tmp/
374 adb shell /data/tmp/vkjson_info
376 The resulting json file will be found in:
378 /sdcard/Android/<device_name>.json
380 To build, install, and run the Smoke demo for Android, run the following, and any
381 prompts that come back from the script:
383 ./update_external_sources.sh --glslang
384 cd demos/smoke/android
385 export ANDROID_SDK_HOME=<path to Android/Sdk>
386 export ANDROID_NDK_HOME=<path to Android/Sdk/ndk-bundle>
388 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.Smoke/android.app.NativeActivity --es args "--validate"
391 ## Ninja Builds - All Platforms
392 The [Qt Creator IDE](https://qt.io/download-open-source/#section-2) can open a root CMakeList.txt as a project directly, and it provides tools within Creator to configure and generate Vulkan SDK build files for one to many targets concurrently, resolving configuration issues as needed. Alternatively, when invoking CMake use the -G Codeblocks Ninja option to generate Ninja build files to be used as project files for QtCreator
394 - Follow the steps defined elsewhere for the OS using the update\_external\_sources script or as shown in **Loader and Validation Layer Dependencies** below
395 - Open, configure, and build the glslang CMakeList.txt files. Note that building the glslang project will provide access to spirv-tools and spirv-headers.
396 - Then do the same with the Vulkan-LoaderAndValidationLayers CMakeList.txt file.
397 - In order to debug with QtCreator, a [Microsoft WDK: eg WDK 10](http://go.microsoft.com/fwlink/p/?LinkId=526733) is required. Note that installing the WDK breaks the MSVC vcvarsall.bat build scripts provided by MSVC, requiring that the LIB, INCLUDE, and PATH env variables be set to the WDK paths by some other means
399 ## Loader and Validation Layer Dependencies
400 The glslang repo is required to build and run Loader and Validation Layer components. It is not a git sub-module of Vulkan-LoaderAndValidationLayers but Vulkan-LoaderAndValidationLayers is linked to a specific revision of gslang. This can be automatically cloned and built to predefined locations with the update\_external\_sources scripts. If a custom configuration is required, do the following steps:
404 git clone https://github.com/KhronosGroup/glslang.git
406 2) checkout the correct version of the tree based on the contents of the glslang\_revision file at the root of the Vulkan-LoaderAndValidationLayers tree (do the same anytime that Vulkan-LoaderAndValidationLayers is updated from remote)
410 git checkout < [path to Vulkan-LoaderAndValidationLayers]\glslang_revision [in glslang repo]
414 git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\glslang_revision` [in glslang repo]
416 3) Configure the glslang source tree with cmake and build it with your IDE of choice
418 4) Enable the CUSTOM\_GLSLANG\_BIN\_PATH and CUSTOM\_SPIRV\_TOOLS\_BIN\_PATH options in the Vulkan-LoaderAndValidationLayers cmake configuration and point the GLSLANG\_BINARY\_PATH and SPIRV\_TOOLS\_BINARY\_PATH variables to the correct location
420 5) If building on Windows with MSVC, set DISABLE\_BUILDTGT\_DIR\_DECORATION to _On_. If building on Windows, but without MSVC set DISABLE\_BUILD\_PATH\_DECORATION to _On_
422 ## Optional software packages:
424 - [Cygwin for windows](https://www.cygwin.com/). Notes:
425 - Cygwin provides some Linux-like tools, which are valuable for obtaining the source code, and running CMake.
426 Especially valuable are the BASH shell and git packages.
427 - If you don't want to use Cygwin, there are other shells and environments that can be used.
428 You can also use a Git package that doesn't come from Cygwin.
430 - [Ninja on all platforms](https://github.com/ninja-build/ninja/releases). [The Ninja-build project](ninja-build.org). [Ninja Users Manual](ninja-build.org/manual.html)
432 - [QtCreator as IDE for CMake builds on all platforms](https://qt.io/download-open-source/#section-2)