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 respository 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 Ubuntu 14.04.3 LTS, 14.10, 15.04, 15.10, and 16.04 LTS.
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-dev libxcb1-dev libxkbcommon-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 ### Linux Install to System Directories
59 Installing the files resulting from your build to the systems directories is optional since
60 environment variables can usually be used instead to locate the binaries.
61 There are also risks with interfering with binaries installed by packages.
62 If you are certain that you would like to install your binaries to system directories,
63 you can proceed with these instructions.
65 Assuming that you've built the code as described above and the current directory is still `dbuild`,
72 This command installs files to:
74 * `/usr/local/include/vulkan`: Vulkan include files
75 * `/usr/local/lib`: Vulkan loader and layers shared objects
76 * `/usr/local/bin`: vulkaninfo application
77 * `/usr/local/etc/vulkan/explicit_layer.d`: Layer JSON files
79 You may need to run `ldconfig` in order to refresh the system loader search cache on some Linux systems.
81 The list of installed files appears in the build directory in a file named `install_manifest.txt`.
82 You can easily remove the installed files with:
85 cat install_manifest.txt | sudo xargs rm
88 You can further customize the installation location by setting additional CMake variables
89 to override their defaults.
90 For example, if you would like to install to `/tmp/build` instead of `/usr/local`, specify:
93 -DCMAKE_INSTALL_PREFIX=/tmp/build
97 on your CMake command line and run `make install` as before.
98 The install step places the files in `/tmp/build`.
100 Using the `CMAKE_INSTALL_PREFIX` to customize the install location also modifies the
101 loader search paths to include searching for layers in the specified install location.
102 In this example, setting `CMAKE_INSTALL_PREFIX` to `/tmp/build` causes the loader to
103 search `/tmp/build/etc/vulkan/explicit_layer.d` and `/tmp/build/share/vulkan/explicit_layer.d`
104 for the layer JSON files.
105 The loader also searches the "standard" system locations of `/etc/vulkan/explicit_layer.d`
106 and `/usr/share/vulkan/explicit_layer.d` after searching the two locations under `/tmp/build`.
108 You can further customize the installation directories by using the CMake variables
109 `CMAKE_INSTALL_SYSCONFDIR` to rename the `etc` directory and `CMAKE_INSTALL_DATADIR`
110 to rename the `share` directory.
112 See the CMake documentation for more details on using these variables
113 to further customize your installation.
115 Also see the `LoaderAndLayerInterface` document in the `loader` folder in this repository for more
116 information about loader operation.
118 Note that some executables in this repository (e.g., `cube`) use the "rpath" linker directive
119 to load the Vulkan loader from the build directory, `dbuild` in this example.
120 This means that even after installing the loader to the system directories, these executables
121 still use the loader from the build directory.
123 ### Linux 32-bit support
125 Usage of this repository's contents in 32-bit Linux environments is not officially supported.
126 However, since this repository is supported on 32-bit Windows, these modules should generally
127 work on 32-bit Linux.
129 Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference" platform:
131 If not already installed, install the following 32-bit development libraries:
133 `gcc-multilib g++-multilib libx11-dev:i386`
135 This list may vary depending on your distro and which windowing systems you are building for.
137 Set up your environment for building 32-bit targets:
142 export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
145 Again, your PKG_CONFIG configuration may be different, depending on your distro.
147 If the libraries in the `external` directory have already been built
149 delete or "clean" this directory and rebuild it with
150 the above settings using the `update_external_sources` shell script.
151 This is required because the libraries in `external` must be built for
152 32-bit in order to be usable by the rest of the components in the repository.
154 Finally, rebuild the repository using `cmake` and `make`, as explained above.
158 The test executables can be found in the dbuild/tests directory.
159 Some of the tests that are available:
160 - vk\_layer\_validation\_tests: Test Vulkan layers.
162 There are also a few shell and Python scripts that run test collections (eg,
167 Some demos that can be found in the dbuild/demos directory are:
168 - vulkaninfo: report GPU properties
169 - cube: a textured spinning cube
170 - smoke/smoke: A "smoke" test using a more complex Vulkan demo
172 ## Windows System Requirements
174 Windows 7+ with additional required software packages:
176 - Microsoft Visual Studio 2013 Professional. Note: it is possible that lesser/older versions may work, but that has not been tested.
177 - [CMake](http://www.cmake.org/download/). Notes:
178 - Tell the installer to "Add CMake to the system PATH" environment variable.
179 - [Python 3](https://www.python.org/downloads). Notes:
180 - Select to install the optional sub-package to add Python to the system PATH environment variable.
181 - Ensure the pip module is installed (it should be by default)
182 - 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
183 - 32 bit python works
184 - [Git](http://git-scm.com/download/win).
185 - 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.
186 - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
187 - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
188 - Install each a 32-bit and a 64-bit version, as the 64-bit installer does not install the 32-bit libraries and tools.
189 - glslang is required for demos and tests.
190 - [You can download and configure it (in a peer directory) here](https://github.com/KhronosGroup/glslang/blob/master/README.md)
191 - 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:
192 - update\_external\_sources.bat --build-glslang (Note: see **Loader and Validation Layer Dependencies** below for other options)
194 ## Windows Build - MSVC
196 Before building on Windows, you may want to modify the customize section in loader/loader.rc to so as to
197 set the version numbers and build description for your build. Doing so will set the information displayed
198 for the Properites->Details tab of the loader vulkan-1.dll file that is built.
200 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):
202 cd Vulkan-LoaderAndValidationLayers # cd to the root of the cloned git repository
203 update_external_sources.bat --all
204 build_windows_targets.bat
207 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.
209 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.
211 To run Vulkan programs you must tell the icd loader where to find the libraries.
212 This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
213 This specification describes both how ICDs and layers should be properly
214 packaged, and how developers can point to ICDs and layers within their builds.
217 Install the required tools for Linux and Windows covered above, then add the
220 - Install [Android Studio 2.1](http://tools.android.com/download/studio/canary), latest Preview (tested with 4):
221 - From the "Welcome to Android Studio" splash screen, add the following components using Configure > SDK Manager:
222 - SDK Platforms > Android N Preview
223 - SDK Tools > Android NDK
229 export PATH=$HOME/Android/sdk/ndk-bundle:$PATH
233 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
237 export PATH=$HOME/Library/Android/sdk/ndk-bundle:$PATH
239 ### Additional OSX System Requirements
240 Tested on OSX version 10.11.4
242 Setup Homebrew and components
243 - Follow instructions on [brew.sh](http://brew.sh) to get homebrew installed.
245 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
247 - Ensure Homebrew is at the beginning of your PATH:
249 export PATH=/usr/local/bin:$PATH
251 - Add packages with the following (may need refinement)
253 brew install cmake python python3 git
255 ### Build steps for Android
256 Use the following to ensure the Android build works.
258 Follow the setup steps for Linux or OSX above, then from your terminal:
261 ./update_external_sources_android.sh
262 ./android-generate.sh
263 ndk-build -j $(sysctl -n hw.ncpu)
266 Follow the setup steps for Windows above, then from Developer Command Prompt for VS2013:
269 update_external_sources_android.bat
274 Use the following steps to build, install, and run Cube and Tri for Android:
277 android update project -s -p . -t "android-23"
279 ant -buildfile cube debug
280 adb install ./cube/bin/NativeActivity-debug.apk
281 adb shell am start com.example.Cube/android.app.NativeActivity
283 To build, install, and run Cube with validation layers, first build layers using steps above, then run:
286 android update project -s -p . -t "android-23"
288 ant -buildfile cube-with-layers debug
289 adb install ./cube-with-layers/bin/NativeActivity-debug.apk
290 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
293 To build, install, and run the Smoke demo for Android, run the following, and any
294 prompts that come back from the script:
296 ./update_external_sources.sh --glslang
297 cd demos/smoke/android
298 export ANDROID_SDK_HOME=<path to Android/Sdk>
299 export ANDROID_NDK_HOME=<path to Android/Sdk/ndk-bundle>
301 adb shell am start com.example.Smoke/android.app.NativeActivity
304 ## Ninja Builds - All Platforms
305 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
307 - Follow the steps defined elsewhere for the OS using the update\_external\_sources script or as shown in **Loader and Validation Layer Dependencies** below
308 - Open, configure, and build the gslang and spirv-tools CMakeList.txt files
309 - Then do the same with the Vulkan-LoaderAndValidationLayers CMakeList.txt file.
310 - 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
312 ## Loader and Validation Layer Dependencies
313 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:
317 git clone https://github.com/KhronosGroup/glslang.git
318 git clone https://github.com/KhronosGroup/SPIRV-Tools.git
321 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)
325 git checkout < [path to Vulkan-LoaderAndValidationLayers]\glslang_revision [in glslang repo]
326 git checkout < [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision[in spriv-tools repo]
330 git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\glslang_revision` [in glslang repo]
331 git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision` [in spriv-tools repo]
333 3) Configure the gslang and spirv-tools source trees with cmake and build them with your IDE of choice
335 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
337 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_
339 ## Optional software packages:
341 - [Cygwin for windows](https://www.cygwin.com/). Notes:
342 - Cygwin provides some Linux-like tools, which are valuable for obtaining the source code, and running CMake.
343 Especially valuable are the BASH shell and git packages.
344 - If you don't want to use Cygwin, there are other shells and environments that can be used.
345 You can also use a Git package that doesn't come from Cygwin.
347 - [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)
349 - [QtCreator as IDE for CMake builds on all platforms](https://qt.io/download-open-source/#section-2)