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:
  37 ```
  38 cd Vulkan-LoaderAndValidationLayers  # cd to the root of the cloned git repository
  39 ./update_external_sources.sh  # Fetches and builds glslang and spirv-tools
  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 (from http://www.cmake.org/download/).  Notes:
  85   - Tell the installer to "Add CMake to the system PATH" environment variable.
  86 - Python 3 (from 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 (from 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
 100
 101 Optional software packages:
 102
 103 - Cygwin (from https://www.cygwin.com/).  Notes:
 104   - Cygwin provides some Linux-like tools, which are valuable for obtaining the source code, and running CMake.
 105     Especially valuable are the BASH shell and git packages.
 106   - If you don't want to use Cygwin, there are other shells and environments that can be used.
 107     You can also use a Git package that doesn't come from Cygwin.
 108
 109 ## Windows Build
 110
 111 Cygwin is used in order to obtain a local copy of the Git repository, and to run the CMake command that creates Visual Studio files.  Visual Studio is used to build the software, and will re-run CMake as appropriate.
 112
 113 To build all Windows targets (e.g. in a "Developer Command Prompt for VS2013" window):
 114 ```
 115 cd Vulkan-LoaderAndValidationLayers  # cd to the root of the cloned git repository
 116 update_external_sources.bat --all
 117 build_windows_targets.bat
 118 ```
 119
 120 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.
 121
 122 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.
 123
 124 To run Vulkan programs you must tell the icd loader where to find the libraries.
 125 This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
 126 This specification describes both how ICDs and layers should be properly
 127 packaged, and how developers can point to ICDs and layers within their builds.
 128
 129 ## Android Build
 130 Install the required tools for Linux and Windows covered above, then add the
 131 following.
 132 ### Android Studio
 133 - Install Android Studio 2.1, latest Preview (tested with 4):
 134   - http://tools.android.com/download/studio/canary
 135 - From the "Welcome to Android Studio" splash screen, add the following components using Configure > SDK Manager:
 136   - SDK Platforms > Android N Preview
 137   - SDK Tools > Android NDK
 138
 139 #### Add NDK to path
 140
 141 On Linux:
 142 ```
 143 export PATH=$HOME/Android/sdk/ndk-bundle:$PATH
 144 ```
 145 On Windows:
 146 ```
 147 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
 148 ```
 149 On OSX:
 150 ```
 151 export PATH=$HOME/Library/Android/sdk/ndk-bundle:$PATH
 152 ```
 153 ### Additional OSX System Requirements
 154 Tested on OSX version 10.11.4
 155
 156  Setup Homebrew and components
 157 - Follow instructions on [brew.sh](http://brew.sh) to get homebrew installed.
 158 ```
 159 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 160 ```
 161 - Ensure Homebrew is at the beginning of your PATH:
 162 ```
 163 export PATH=$HOME/homebrew/bin:$PATH
 164 ```
 165 - Add packages with the following (may need refinement)
 166 ```
 167 brew install cmake
 168 brew install python
 169 brew install python3
 170 ```
 171 ### Build steps for Android
 172 Use the following to ensure the Android build works.
 173 #### Linux and OSX
 174 Follow the setup steps for Linux or OSX above, then from your terminal:
 175 ```
 176 cd build-android
 177 ./update_external_sources_android.sh
 178 ./android-generate.sh
 179 ndk-build
 180 ```
 181 #### Windows
 182 Follow the setup steps for Windows above, then from Developer Command Prompt for VS2013:
 183 ```
 184 cd build-android
 185 update_external_sources_android.bat
 186 android-generate.bat
 187 ndk-build
 188 ```