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 **LVL's 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 Note that if you have installed the [LunarG Vulkan SDK](https://vulkan.lunarg.com),
  56 you will also have the SDK version of the loader and layers installed in your default system libraries.
  57
  58 You can run the `vulkaninfo` application to see which driver, loader and layers are being used.
  59
  60 The `LoaderAndLayerInterface` document in the `loader` folder in this repository is a specification that
  61 describes both how ICDs and layers should be properly
  62 packaged, and how developers can point to ICDs and layers within their builds.
  63
  64 ## Validation Test
  65
  66 The test executables can be found in the dbuild/tests directory.
  67 Some of the tests that are available:
  68 - vk\_layer\_validation\_tests: Test Vulkan layers.
  69
  70 There are also a few shell and Python scripts that run test collections (eg,
  71 `run_all_tests.sh`).
  72
  73 ## Linux Demos
  74
  75 Some demos that can be found in the dbuild/demos directory are:
  76 - vulkaninfo: report GPU properties
  77 - tri: a textured triangle (which is animated to demonstrate Z-clipping)
  78 - cube: a textured spinning cube
  79 - smoke/smoke: A "smoke" test using a more complex Vulkan demo
  80
  81 ## Windows System Requirements
  82
  83 Windows 7+ with additional required software packages:
  84
  85 - Microsoft Visual Studio 2013 Professional.  Note: it is possible that lesser/older versions may work, but that has not been tested.
  86 - [CMake](http://www.cmake.org/download/).  Notes:
  87   - Tell the installer to "Add CMake to the system PATH" environment variable.
  88 - [Python 3](https://www.python.org/downloads).  Notes:
  89   - Select to install the optional sub-package to add Python to the system PATH environment variable.
  90   - Ensure the pip module is installed (it should be by default)
  91   - 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
  92   - 32 bit python works
  93 - [Git](http://git-scm.com/download/win).
  94   - 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.
  95   - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
  96   - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
  97   - Install each a 32-bit and a 64-bit version, as the 64-bit installer does not install the 32-bit libraries and tools.
  98 - glslang is required for demos and tests.
  99   - [You can download and configure it (in a peer directory) here](https://github.com/KhronosGroup/glslang/blob/master/README.md)
 100   - 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:
 101     - update\_external\_sources.bat --build-glslang (Note: see **LVL's Dependencies** below for other options)
 102
 103 ## Windows Build - MSVC
 104
 105 Before building on Windows, you may want to modify the customize section in loader/loader.rc to so as to
 106 set the version numbers and build description for your build. Doing so will set the information displayed
 107 for the Properites->Details tab of the loader vulkan-1.dll file that is built.
 108
 109 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):
 110 ```
 111 cd Vulkan-LoaderAndValidationLayers  # cd to the root of the cloned git repository
 112 update_external_sources.bat --all
 113 build_windows_targets.bat
 114 ```
 115
 116 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.
 117
 118 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.
 119
 120 To run Vulkan programs you must tell the icd loader where to find the libraries.
 121 This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
 122 This specification describes both how ICDs and layers should be properly
 123 packaged, and how developers can point to ICDs and layers within their builds.
 124
 125 ## Android Build
 126 Install the required tools for Linux and Windows covered above, then add the
 127 following.
 128 ### Android Studio
 129 - Install [Android Studio 2.1](http://tools.android.com/download/studio/canary), latest Preview (tested with 4):
 130 - From the "Welcome to Android Studio" splash screen, add the following components using Configure > SDK Manager:
 131   - SDK Platforms > Android N Preview
 132   - SDK Tools > Android NDK
 133
 134 #### Add NDK to path
 135
 136 On Linux:
 137 ```
 138 export PATH=$HOME/Android/sdk/ndk-bundle:$PATH
 139 ```
 140 On Windows:
 141 ```
 142 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
 143 ```
 144 On OSX:
 145 ```
 146 export PATH=$HOME/Library/Android/sdk/ndk-bundle:$PATH
 147 ```
 148 ### Additional OSX System Requirements
 149 Tested on OSX version 10.11.4
 150
 151  Setup Homebrew and components
 152 - Follow instructions on [brew.sh](http://brew.sh) to get homebrew installed.
 153 ```
 154 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 155 ```
 156 - Ensure Homebrew is at the beginning of your PATH:
 157 ```
 158 export PATH=/usr/local/bin:$PATH
 159 ```
 160 - Add packages with the following (may need refinement)
 161 ```
 162 brew install cmake python python3 git
 163 ```
 164 ### Build steps for Android
 165 Use the following to ensure the Android build works.
 166 #### Linux and OSX
 167 Follow the setup steps for Linux or OSX above, then from your terminal:
 168 ```
 169 cd build-android
 170 ./update_external_sources_android.sh
 171 ./android-generate.sh
 172 ndk-build -j $(sysctl -n hw.ncpu)
 173 ```
 174 #### Windows
 175 Follow the setup steps for Windows above, then from Developer Command Prompt for VS2013:
 176 ```
 177 cd build-android
 178 update_external_sources_android.bat
 179 android-generate.bat
 180 ndk-build
 181 ```
 182
 183 ## Ninja Builds - All Platforms
 184 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
 185
 186 - Follow the steps defined elsewhere for the OS using the update\_external\_sources script or as shown in **LVL's Dependencies** below
 187 - Open, configure, and build the gslang and spirv-tools CMakeList.txt files
 188 - Then do the same with the Vulkan-LoaderAndValidationLayers CMakeList.txt file.
 189 - 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
 190
 191 ## LVL's Dependencies
 192 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:
 193
 194 1) clone the repos:
 195
 196     git clone https://github.com/KhronosGroup/glslang.git
 197     git clone https://github.com/KhronosGroup/SPIRV-Tools.git
 198
 199
 200 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)
 201
 202 _on windows_
 203
 204     git checkout < [path to Vulkan-LoaderAndValidationLayers]\glslang_revision [in glslang repo]
 205         git checkout < [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision[in spriv-tools repo]
 206
 207 *non windows*
 208
 209     git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\glslang_revision` [in glslang repo]
 210         git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision` [in spriv-tools repo]
 211
 212 3) Configure the gslang and spirv-tools source trees with cmake and build them with your IDE of choice
 213
 214 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
 215
 216 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_
 217
 218 ## Optional software packages:
 219
 220 - [Cygwin for windows](https://www.cygwin.com/).  Notes:
 221   - Cygwin provides some Linux-like tools, which are valuable for obtaining the source code, and running CMake.
 222     Especially valuable are the BASH shell and git packages.
 223   - If you don't want to use Cygwin, there are other shells and environments that can be used.
 224     You can also use a Git package that doesn't come from Cygwin.
 225
 226 - [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)
 227
 228 - [QtCreator as IDE for CMake builds on all platforms](https://qt.io/download-open-source/#section-2)