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.
27 It should be straightforward to use it on other Linux distros.
29 These packages are needed to build this repository:
31 sudo apt-get install git cmake build-essential bison libx11-xcb-dev libxkbcommon-dev libmirclient-dev libwayland-dev libxrandr-dev
34 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):
36 cd Vulkan-LoaderAndValidationLayers # cd to the root of the cloned git repository
37 ./update_external_sources.sh
38 cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug
43 If you have installed a Vulkan driver obtained from your graphics hardware vendor, the install process should
44 have configured the driver so that the Vulkan loader can find and load it.
46 If you want to use the loader and layers that you have just built:
48 export LD_LIBRARY_PATH=<path to your repository root>/dbuild/loader
49 export VK_LAYER_PATH=<path to your repository root>/dbuild/layers
51 You can run the `vulkaninfo` application to see which driver, loader and layers are being used.
53 The `LoaderAndLayerInterface` document in the `loader` folder in this repository is a specification that
54 describes both how ICDs and layers should be properly
55 packaged, and how developers can point to ICDs and layers within their builds.
57 ### WSI Support Build Options
58 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
59 display systems to maximize their usability across Linux platforms.
60 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.
62 ### Linux Install to System Directories
64 Installing the files resulting from your build to the systems directories is optional since
65 environment variables can usually be used instead to locate the binaries.
66 There are also risks with interfering with binaries installed by packages.
67 If you are certain that you would like to install your binaries to system directories,
68 you can proceed with these instructions.
70 Assuming that you've built the code as described above and the current directory is still `dbuild`,
77 This command installs files to:
79 * `/usr/local/include/vulkan`: Vulkan include files
80 * `/usr/local/lib`: Vulkan loader and layers shared objects
81 * `/usr/local/bin`: vulkaninfo application
82 * `/usr/local/etc/vulkan/explicit_layer.d`: Layer JSON files
84 You may need to run `ldconfig` in order to refresh the system loader search cache on some Linux systems.
86 The list of installed files appears in the build directory in a file named `install_manifest.txt`.
87 You can easily remove the installed files with:
90 cat install_manifest.txt | sudo xargs rm
93 You can further customize the installation location by setting additional CMake variables
94 to override their defaults.
95 For example, if you would like to install to `/tmp/build` instead of `/usr/local`, specify:
98 -DCMAKE_INSTALL_PREFIX=/tmp/build
102 on your CMake command line and run `make install` as before.
103 The install step places the files in `/tmp/build`.
105 Using the `CMAKE_INSTALL_PREFIX` to customize the install location also modifies the
106 loader search paths to include searching for layers in the specified install location.
107 In this example, setting `CMAKE_INSTALL_PREFIX` to `/tmp/build` causes the loader to
108 search `/tmp/build/etc/vulkan/explicit_layer.d` and `/tmp/build/share/vulkan/explicit_layer.d`
109 for the layer JSON files.
110 The loader also searches the "standard" system locations of `/etc/vulkan/explicit_layer.d`
111 and `/usr/share/vulkan/explicit_layer.d` after searching the two locations under `/tmp/build`.
113 You can further customize the installation directories by using the CMake variables
114 `CMAKE_INSTALL_SYSCONFDIR` to rename the `etc` directory and `CMAKE_INSTALL_DATADIR`
115 to rename the `share` directory.
117 See the CMake documentation for more details on using these variables
118 to further customize your installation.
120 Also see the `LoaderAndLayerInterface` document in the `loader` folder in this repository for more
121 information about loader operation.
123 Note that some executables in this repository (e.g., `cube`) use the "rpath" linker directive
124 to load the Vulkan loader from the build directory, `dbuild` in this example.
125 This means that even after installing the loader to the system directories, these executables
126 still use the loader from the build directory.
128 ### Linux 32-bit support
130 Usage of this repository's contents in 32-bit Linux environments is not officially supported.
131 However, since this repository is supported on 32-bit Windows, these modules should generally
132 work on 32-bit Linux.
134 Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference" platform:
136 If not already installed, install the following 32-bit development libraries:
138 `gcc-multilib g++-multilib libx11-dev:i386`
140 This list may vary depending on your distro and which windowing systems you are building for.
142 Set up your environment for building 32-bit targets:
147 export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
150 Again, your PKG_CONFIG configuration may be different, depending on your distro.
152 If the libraries in the `external` directory have already been built
154 delete or "clean" this directory and rebuild it with
155 the above settings using the `update_external_sources` shell script.
156 This is required because the libraries in `external` must be built for
157 32-bit in order to be usable by the rest of the components in the repository.
159 Finally, rebuild the repository using `cmake` and `make`, as explained above.
163 The test executables can be found in the dbuild/tests directory.
164 Some of the tests that are available:
165 - vk\_layer\_validation\_tests: Test Vulkan layers.
167 There are also a few shell and Python scripts that run test collections (eg,
172 Some demos that can be found in the dbuild/demos directory are:
173 - vulkaninfo: report GPU properties
174 - cube: a textured spinning cube
175 - smoke/smoke: A "smoke" test using a more complex Vulkan demo
177 You can select which WSI subsystem is used to build the demos using a cmake option called DEMOS_WSI_SELECTION.
178 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).
179 For instance, creating a build that will use Xlib to build the demos, your cmake command line might look like:
181 cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug -DDEMOS_WSI_SELECTION=XLIB
183 ## Windows System Requirements
185 Windows 7+ with additional required software packages:
187 - Microsoft Visual Studio 2013 Professional. Note: it is possible that lesser/older versions may work, but that has not been tested.
188 - [CMake](http://www.cmake.org/download/). Notes:
189 - Tell the installer to "Add CMake to the system PATH" environment variable.
190 - [Python 3](https://www.python.org/downloads). Notes:
191 - Select to install the optional sub-package to add Python to the system PATH environment variable.
192 - Ensure the pip module is installed (it should be by default)
193 - 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
194 - 32 bit python works
195 - [Git](http://git-scm.com/download/win).
196 - Note: If you use Cygwin, you can normally use Cygwin's "git.exe". However, in order to use the "update\_external\_sources.bat" script, you must have this version.
197 - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
198 - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
199 - Install each a 32-bit and a 64-bit version, as the 64-bit installer does not install the 32-bit libraries and tools.
200 - glslang is required for demos and tests.
201 - [You can download and configure it (in a peer directory) here](https://github.com/KhronosGroup/glslang/blob/master/README.md)
202 - 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:
203 - update\_external\_sources.bat --build-glslang (Note: see **Loader and Validation Layer Dependencies** below for other options)
205 ## Windows Build - MSVC
207 Before building on Windows, you may want to modify the customize section in loader/loader.rc to so as to
208 set the version numbers and build description for your build. Doing so will set the information displayed
209 for the Properties->Details tab of the loader vulkan-1.dll file that is built.
211 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):
213 cd Vulkan-LoaderAndValidationLayers # cd to the root of the cloned git repository
214 update_external_sources.bat --all
215 build_windows_targets.bat
218 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.
220 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.
222 To run Vulkan programs you must tell the icd loader where to find the libraries.
223 This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
224 This specification describes both how ICDs and layers should be properly
225 packaged, and how developers can point to ICDs and layers within their builds.
228 Install the required tools for Linux and Windows covered above, then add the following.
230 - Install [Android Studio 2.3](https://developer.android.com/studio/index.html) or later.
231 - From the "Welcome to Android Studio" splash screen, add the following components using Configure > SDK Manager:
232 - SDK Platforms > Android 6.0 and newer
233 - SDK Tools > Android SDK Build-Tools
234 - SDK Tools > Android SDK Platform-Tools
235 - SDK Tools > Android SDK Tools
236 - SDK Tools > Android NDK
238 #### Add Android specifics to environment
242 export ANDROID_SDK_HOME=$HOME/Android/sdk
243 export ANDROID_NDK_HOME=$HOME/Android/sdk/ndk-bundle
244 export PATH=$ANDROID_SDK_HOME:$PATH
245 export PATH=$ANDROID_NDK_HOME:$PATH
246 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
250 set ANDROID_SDK_HOME=%LOCALAPPDATA%\Android\sdk
251 set ANDROID_NDK_HOME=%LOCALAPPDATA%\Android\sdk\ndk-bundle
252 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
256 export ANDROID_SDK_HOME=$HOME/Library/Android/sdk
257 export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk-bundle
258 export PATH=$ANDROID_NDK_PATH:$PATH
259 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
261 Note: If jarsigner is missing from your platform, you can find it in the Android Studio install.
262 ### Additional OSX System Requirements
263 Tested on OSX version 10.12.4
265 Setup Homebrew and components
266 - Follow instructions on [brew.sh](http://brew.sh) to get homebrew installed.
268 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
270 - Ensure Homebrew is at the beginning of your PATH:
272 export PATH=/usr/local/bin:$PATH
274 - Add packages with the following (may need refinement)
276 brew install cmake python python3 git
278 ### Build steps for Android
279 Use the following script to build everything in the repo for Android, including validation layers, tests, demos, and APK packaging:
284 Resulting validation layer binaries will be in build-android/libs.
285 Test and demo APKs can be installed on production devices with:
287 ./install_all.sh -s <serial number>
289 Note that there are no equivalent scripts on Windows yet, that work needs to be completed.
290 The following per platform commands can be used for layer only builds:
292 Follow the setup steps for Linux or OSX above, then from your terminal:
295 ./update_external_sources_android.sh
296 ./android-generate.sh
297 ndk-build -j $(sysctl -n hw.ncpu)
300 Follow the setup steps for Windows above, then from Developer Command Prompt for VS2013:
303 update_external_sources_android.bat
308 Use the following steps to build, install, and run the layer validation tests for Android:
312 adb install -r bin/VulkanLayerValidationTests.apk
313 adb shell am start com.example.VulkanLayerValidationTests/android.app.NativeActivity
315 Alternatively, you can use the test_APK script to install and run the layer validation tests:
317 test_APK.sh -s <serial number> -p <plaform name> -f <gtest_filter>
320 Use the following steps to build, install, and run Cube and Smoke for Android:
324 adb install -r ../demos/android/cube/bin/cube.apk
325 adb shell am start com.example.Cube/android.app.NativeActivity
327 To build, install, and run Cube with validation layers, first build layers using steps above, then run:
331 adb install -r ../demos/android/cube-with-layers/bin/cube-with-layers.apk
332 adb shell am start com.example.CubeWithLayers/android.app.NativeActivity
333 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
336 To build, install, and run the Smoke demo for Android, run the following, and any
337 prompts that come back from the script:
339 ./update_external_sources.sh --glslang
340 cd demos/smoke/android
341 export ANDROID_SDK_HOME=<path to Android/Sdk>
342 export ANDROID_NDK_HOME=<path to Android/Sdk/ndk-bundle>
344 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.Smoke/android.app.NativeActivity --es args "--validate"
347 ## Ninja Builds - All Platforms
348 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
350 - Follow the steps defined elsewhere for the OS using the update\_external\_sources script or as shown in **Loader and Validation Layer Dependencies** below
351 - Open, configure, and build the gslang and spirv-tools CMakeList.txt files
352 - Then do the same with the Vulkan-LoaderAndValidationLayers CMakeList.txt file.
353 - 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
355 ## Loader and Validation Layer Dependencies
356 gslang and SPIRV-Tools repos are required to build and run Loader and Validation Layer components. They are not git sub-modules of Vulkan-LoaderAndValidationLayers but Vulkan-LoaderAndValidationLayers is linked to specific revisions of gslang and spirv-tools. These 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:
360 git clone https://github.com/KhronosGroup/glslang.git
361 git clone https://github.com/KhronosGroup/SPIRV-Tools.git
364 2) checkout the correct version of each tree based on the contents of the glslang\_revision and spirv-tools\_revision files at the root of the Vulkan-LoaderAndValidationLayers tree (do the same anytime that Vulkan-LoaderAndValidationLayers is updated from remote)
368 git checkout < [path to Vulkan-LoaderAndValidationLayers]\glslang_revision [in glslang repo]
369 git checkout < [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision[in spriv-tools repo]
373 git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\glslang_revision` [in glslang repo]
374 git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision` [in spriv-tools repo]
376 3) Configure the gslang and spirv-tools source trees with cmake and build them with your IDE of choice
378 4) Enable the CUSTOM\_GSLANG\_BIN\_PATH and CUSTOM\_SPIRV\_TOOLS\_BIN\_PATH options in the Vulkan-LoaderAndValidationLayers cmake configuration and point the GSLANG\_BINARY\_PATH and SPIRV\_TOOLS\_BINARY\_PATH variables to the correct location
380 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_
382 ## Optional software packages:
384 - [Cygwin for windows](https://www.cygwin.com/). Notes:
385 - Cygwin provides some Linux-like tools, which are valuable for obtaining the source code, and running CMake.
386 Especially valuable are the BASH shell and git packages.
387 - If you don't want to use Cygwin, there are other shells and environments that can be used.
388 You can also use a Git package that doesn't come from Cygwin.
390 - [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)
392 - [QtCreator as IDE for CMake builds on all platforms](https://qt.io/download-open-source/#section-2)