BUILD.md

   1 # Build Instructions
   2 These instructions are for Linux and Windows.
   3
   4 It is strongly suggested that you first install a Vulkan-capable driver, obtained from your graphics hardware vendor.
   5
   6 Note: The sample Vulkan Intel driver for Linux (ICD) has been moved to the
   7 [VulkanTools repo](https://github.com/LunarG/VulkanTools).
   8 Further instructions regarding the ICD are available there.
   9
  10 ## Git the Bits
  11
  12 If you intend to contribute, the preferred work flow is to fork the repo, create a branch in your forked repo, do the work, and create a pull request on GitHub to integrate that work back into the repo.
  13
  14 To create your local git repository:
  15 ```
  16 git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers
  17 # Or substitute the URL from your forked repo for https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers above.
  18 ```
  19
  20 ## Linux Build
  21
  22 The build process uses cmake and should work with the usual cmake options and utilities.
  23 The build generates the loader, layers, and tests.
  24
  25 This repo has been built and tested on Ubuntu 14.04.3 LTS, 14.10, 15.04 and 15.10.
  26 It should be straightforward to use it on other Linux distros.
  27
  28 These packages should be installed
  29 ```
  30 sudo apt-get install git cmake build-essential bison libxcb1-dev
  31 ```
  32
  33 Example debug build:
  34 ```
  35 cd YOUR_DEV_DIRECTORY  # cd to the root of the Vulkan-LoaderAndValidationLayers git repository
  36 ./update_external_sources.sh  # Fetches and builds glslang and spirv-tools
  37 cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug
  38 cd dbuild
  39 make
  40 ```
  41
  42 To run Vulkan programs you must tell the icd loader where to find the libraries.
  43 This is described in a [specification](https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers/blob/sdk-1.0.3/loader/LoaderAndLayerInterface.md#vulkan-installable-client-driver-interface-with-the-loader).
  44
  45 This specification describes both how ICDs and layers should be properly
  46 packaged, and how developers can point to ICDs and layers within their builds.
  47
  48 For example, you may wish to point to your just-built loader and layers with:
  49 ```
  50 export LD_LIBRARY_PATH=<path to your build root>/dbuild/loader
  51 export VK_LAYER_PATH=<path to your build root>/dbuild/layers
  52 ```
  53
  54 ## Validation Test
  55
  56 The test executables can be found in the dbuild/tests directory. The tests use the Google
  57 gtest infrastructure. Tests available so far:
  58 - vk_layer_validation_tests: Test Vulkan layers.
  59
  60 There are also a few shell and Python scripts that run test collections (eg,
  61 `run_all_tests.sh`).
  62
  63 ## Linux Demos
  64
  65 The demos executables can be found in the dbuild/demos directory.
  66 - vulkaninfo: report GPU properties
  67 - tri: a textured triangle (which is animated to demonstrate Z-clipping)
  68 - cube: a textured spinning cube
  69
  70 ## Windows System Requirements
  71
  72 Windows 7+ with additional required software packages:
  73
  74 - Microsoft Visual Studio 2013 Professional.  Note: it is possible that lesser/older versions may work, but that has not been tested.
  75 - CMake (from http://www.cmake.org/download/).  Notes:
  76   - Tell the installer to "Add CMake to the system PATH" environment variable.
  77 - Python 3 (from https://www.python.org/downloads).  Notes:
  78   - Select to install the optional sub-package to add Python to the system PATH environment variable.
  79   - Ensure the pip module is installed (it should be by default)
  80   - 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
  81   - 32 bit python works
  82 - Python lxml package must be installed
  83   - Download the lxml package from
  84         http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml
  85         32-bit latest for Python 3.5 is: lxml-3.5.0-cp35-none-win32.whl
  86         64-bit latest for Python 3.5 is: lxml-3.5.0-cp35-none-win_amd64.whl
  87   - The package can be installed with pip as follows:
  88         pip install lxml-3.5.0-cp35-none-win32.whl
  89         If pip is not in your path, you can find it at $PYTHON_HOME\Scripts\pip.exe, where PYTHON_HOME is the folder where you installed Python.
  90 - Git (from http://git-scm.com/download/win).
  91   - 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.
  92   - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
  93   - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
  94   - Install each a 32-bit and a 64-bit version, as the 64-bit installer does not install the 32-bit libraries and tools.
  95 - glslang is required for demos and tests.
  96   - You can download and configure it (in a peer directory) here: https://github.com/KhronosGroup/glslang/blob/master/README.md
  97   - 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:
  98     - update_external_sources.bat --build-glslang
  99
 100 Optional software packages:
 101
 102 - Cygwin (from https://www.cygwin.com/).  Notes:
 103   - Cygwin provides some Linux-like tools, which are valuable for obtaining the source code, and running CMake.
 104     Especially valuable are the BASH shell and git packages.
 105   - If you don't want to use Cygwin, there are other shells and environments that can be used.
 106     You can also use a Git package that doesn't come from Cygwin.
 107
 108 ## Windows Build
 109
 110 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.
 111
 112 Example debug x64 build (e.g. in a "Developer Command Prompt for VS2013" window):
 113 ```
 114 cd YOUR_DEV_DIRECTORY  # cd to the root of the Vulkan-LoaderAndValidationLayers git repository
 115 update_external_sources.bat --all
 116 build_windows_targets.bat
 117 ```
 118
 119 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.
 120
 121 Vulkan programs must be able to find and use the vulkan-1.dll libary. 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.
 122
 123 To run Vulkan programs you must tell the icd loader where to find the libraries.
 124 This is described in a [specification](https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers/blob/sdk-1.0.3/loader/LoaderAndLayerInterface.md#vulkan-installable-client-driver-interface-with-the-loader).
 125
 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 ### Windows 64-bit Installation Notes
 130 If you plan on creating a Windows Install file (done in the windowsRuntimeInstaller sub-directory) you will need to build for both 32-bit and 64-bit Windows since both versions of EXEs and DLLs exist simultaneously on Windows 64.
 131
 132 To do this, simply create and build the release versions of each target:
 133 ```
 134 cd LoaderAndTools  # cd to the root of the Vulkan git repository
 135 update_external_sources.bat --all
 136 mkdir build
 137 cd build
 138 cmake -G "Visual Studio 12 Win64" ..
 139 msbuild ALL_BUILD.vcxproj /p:Platform=x64 /p:Configuration=Release
 140 mkdir build32
 141 cd build32
 142 cmake -G "Visual Studio 12" ..
 143 msbuild ALL_BUILD.vcxproj /p:Platform=x86 /p:Configuration=Release
 144 ```
 145