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