BUILD.md

   1 # Build Instructions
   2 This document contains the instructions for building this repository on Linux and Windows.
   3
   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
   6 and install it.
   7
   8 Note: The sample Vulkan Intel driver for Linux (ICD) is being deprecated in favor of other driver options from Intel.
   9 This driver has been moved to the [VulkanTools repo](https://github.com/LunarG/VulkanTools).
  10 Further instructions regarding this ICD are available there.
  11
  12 ## Contributing
  13
  14 If you intend to contribute, the preferred work flow is for you to develop your contribution
  15 in a fork of this repo in your GitHub account and then submit a pull request.
  16 Please see the [CONTRIBUTING](CONTRIBUTING.md) file in this respository for more details.
  17
  18 ## Git the Bits
  19
  20 To create your local git repository:
  21 ```
  22 git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers
  23 ```
  24
  25 ## Linux Build
  26
  27 The build process uses CMake to generate makefiles for this project.
  28 The build generates the loader, layers, and tests.
  29
  30 This repo has been built and tested on Ubuntu 14.04.3 LTS, 14.10, 15.04, 15.10, and 16.04 LTS.
  31 It should be straightforward to use it on other Linux distros.
  32
  33 These packages are needed to build this repository:
  34 ```
  35 sudo apt-get install git cmake build-essential bison libx11-dev libxcb1-dev
  36 ```
  37
  38 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 ```
  40 cd Vulkan-LoaderAndValidationLayers  # cd to the root of the cloned git repository
  41 ./update_external_sources.sh
  42 cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug
  43 cd dbuild
  44 make
  45 ```
  46
  47 If you have installed a Vulkan driver obtained from your graphics hardware vendor, the install process should
  48 have configured the driver so that the Vulkan loader can find and load it.
  49
  50 If you want to use the loader and layers that you have just built:
  51 ```
  52 export LD_LIBRARY_PATH=<path to your repository root>/dbuild/loader
  53 export VK_LAYER_PATH=<path to your repository root>/dbuild/layers
  54 ```
  55 You can run the `vulkaninfo` application to see which driver, loader and layers are being used.
  56
  57 The `LoaderAndLayerInterface` document in the `loader` folder in this repository is a specification that
  58 describes both how ICDs and layers should be properly
  59 packaged, and how developers can point to ICDs and layers within their builds.
  60
  61 ## Validation Test
  62
  63 The test executables can be found in the dbuild/tests directory.
  64 Some of the tests that are available:
  65 - vk\_layer\_validation\_tests: Test Vulkan layers.
  66
  67 There are also a few shell and Python scripts that run test collections (eg,
  68 `run_all_tests.sh`).
  69
  70 ## Linux Demos
  71
  72 Some demos that can be found in the dbuild/demos directory are:
  73 - vulkaninfo: report GPU properties
  74 - cube: a textured spinning cube
  75 - smoke/smoke: A "smoke" test using a more complex Vulkan demo
  76
  77 ## Windows System Requirements
  78
  79 Windows 7+ with additional required software packages:
  80
  81 - Microsoft Visual Studio 2013 Professional.  Note: it is possible that lesser/older versions may work, but that has not been tested.
  82 - [CMake](http://www.cmake.org/download/).  Notes:
  83   - Tell the installer to "Add CMake to the system PATH" environment variable.
  84 - [Python 3](https://www.python.org/downloads).  Notes:
  85   - Select to install the optional sub-package to add Python to the system PATH environment variable.
  86   - Ensure the pip module is installed (it should be by default)
  87   - 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
  88   - 32 bit python works
  89 - [Git](http://git-scm.com/download/win).
  90   - 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.
  91   - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
  92   - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
  93   - Install each a 32-bit and a 64-bit version, as the 64-bit installer does not install the 32-bit libraries and tools.
  94 - glslang is required for demos and tests.
  95   - [You can download and configure it (in a peer directory) here](https://github.com/KhronosGroup/glslang/blob/master/README.md)
  96   - 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:
  97     - update\_external\_sources.bat --build-glslang (Note: see **Loader and Validation Layer Dependencies** below for other options)
  98
  99 ## Windows Build - MSVC
 100
 101 Before building on Windows, you may want to modify the customize section in loader/loader.rc to so as to
 102 set the version numbers and build description for your build. Doing so will set the information displayed
 103 for the Properites->Details tab of the loader vulkan-1.dll file that is built.
 104
 105 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):
 106 ```
 107 cd Vulkan-LoaderAndValidationLayers  # cd to the root of the cloned git repository
 108 update_external_sources.bat --all
 109 build_windows_targets.bat
 110 ```
 111
 112 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.
 113
 114 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.
 115
 116 To run Vulkan programs you must tell the icd loader where to find the libraries.
 117 This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
 118 This specification describes both how ICDs and layers should be properly
 119 packaged, and how developers can point to ICDs and layers within their builds.
 120
 121 ## Android Build
 122 Install the required tools for Linux and Windows covered above, then add the
 123 following.
 124 ### Android Studio
 125 - Install [Android Studio 2.1](http://tools.android.com/download/studio/canary), latest Preview (tested with 4):
 126 - From the "Welcome to Android Studio" splash screen, add the following components using Configure > SDK Manager:
 127   - SDK Platforms > Android N Preview
 128   - SDK Tools > Android NDK
 129
 130 #### Add NDK to path
 131
 132 On Linux:
 133 ```
 134 export PATH=$HOME/Android/sdk/ndk-bundle:$PATH
 135 ```
 136 On Windows:
 137 ```
 138 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
 139 ```
 140 On OSX:
 141 ```
 142 export PATH=$HOME/Library/Android/sdk/ndk-bundle:$PATH
 143 ```
 144 ### Additional OSX System Requirements
 145 Tested on OSX version 10.11.4
 146
 147  Setup Homebrew and components
 148 - Follow instructions on [brew.sh](http://brew.sh) to get homebrew installed.
 149 ```
 150 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 151 ```
 152 - Ensure Homebrew is at the beginning of your PATH:
 153 ```
 154 export PATH=/usr/local/bin:$PATH
 155 ```
 156 - Add packages with the following (may need refinement)
 157 ```
 158 brew install cmake python python3 git
 159 ```
 160 ### Build steps for Android
 161 Use the following to ensure the Android build works.
 162 #### Linux and OSX
 163 Follow the setup steps for Linux or OSX above, then from your terminal:
 164 ```
 165 cd build-android
 166 ./update_external_sources_android.sh
 167 ./android-generate.sh
 168 ndk-build -j $(sysctl -n hw.ncpu)
 169 ```
 170 #### Windows
 171 Follow the setup steps for Windows above, then from Developer Command Prompt for VS2013:
 172 ```
 173 cd build-android
 174 update_external_sources_android.bat
 175 android-generate.bat
 176 ndk-build
 177 ```
 178 #### Android demos
 179 Use the following steps to build, install, and run Cube and Tri for Android:
 180 ```
 181 cd demos/android
 182 android update project -s -p . -t "android-23"
 183 ndk-build
 184 ant -buildfile cube debug
 185 adb install ./cube/bin/NativeActivity-debug.apk
 186 adb shell am start com.example.Cube/android.app.NativeActivity
 187 ```
 188 To build, install, and run Cube with validation layers, first build layers using steps above, then run:
 189 ```
 190 cd demos/android
 191 android update project -s -p . -t "android-23"
 192 ndk-build -j
 193 ant -buildfile cube-with-layers debug
 194 adb install ./cube-with-layers/bin/NativeActivity-debug.apk
 195 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
 196 ```
 197
 198 To build, install, and run the Smoke demo for Android, run the following, and any
 199 prompts that come back from the script:
 200 ```
 201 ./update_external_sources.sh --glslang
 202 cd demos/smoke/android
 203 export ANDROID_SDK_HOME=<path to Android/Sdk>
 204 export ANDROID_NDK_HOME=<path to Android/Sdk/ndk-bundle>
 205 ./build-and-install
 206 adb shell am start com.example.Smoke/android.app.NativeActivity
 207 ```
 208
 209 ## Ninja Builds - All Platforms
 210 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
 211
 212 - Follow the steps defined elsewhere for the OS using the update\_external\_sources script or as shown in **Loader and Validation Layer Dependencies** below
 213 - Open, configure, and build the gslang and spirv-tools CMakeList.txt files
 214 - Then do the same with the Vulkan-LoaderAndValidationLayers CMakeList.txt file.
 215 - 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
 216
 217 ## Loader and Validation Layer Dependencies
 218 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:
 219
 220 1) clone the repos:
 221
 222     git clone https://github.com/KhronosGroup/glslang.git
 223     git clone https://github.com/KhronosGroup/SPIRV-Tools.git
 224
 225
 226 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)
 227
 228 _on windows_
 229
 230     git checkout < [path to Vulkan-LoaderAndValidationLayers]\glslang_revision [in glslang repo]
 231         git checkout < [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision[in spriv-tools repo]
 232
 233 *non windows*
 234
 235     git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\glslang_revision` [in glslang repo]
 236         git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision` [in spriv-tools repo]
 237
 238 3) Configure the gslang and spirv-tools source trees with cmake and build them with your IDE of choice
 239
 240 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
 241
 242 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_
 243
 244 ## Optional software packages:
 245
 246 - [Cygwin for windows](https://www.cygwin.com/).  Notes:
 247   - Cygwin provides some Linux-like tools, which are valuable for obtaining the source code, and running CMake.
 248     Especially valuable are the BASH shell and git packages.
 249   - If you don't want to use Cygwin, there are other shells and environments that can be used.
 250     You can also use a Git package that doesn't come from Cygwin.
 251
 252 - [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)
 253
 254 - [QtCreator as IDE for CMake builds on all platforms](https://qt.io/download-open-source/#section-2)