BUILD.md

   1 # Build Instructions
   2 These instructions are for Linux and Windows.
   3
   4 ## Git the Bits
   5
   6 The public repository for Vulkan-LoaderAndValidationLayers is hosted at https://github.com/KhronosGroup/.
   7
   8 If you intend to contribute, the
   9 preferred work flow is to fork the repo, create a branch in your forked repo, do the work, and create a pull request
  10 on GitHub to integrate that work back into the repo.
  11
  12 Note: The sample Vulkan driver for Linux (ICD) has been moved to the VulkanTools repo at https://github.com/LunarG/VulkanTools.
  13 Further instructions regarding the ICD are available there.
  14
  15 ## Clone the repository
  16
  17 To create your local git repository:
  18 ```
  19 git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers
  20 # Or substitute the URL from your forked repo for https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers above.
  21 ```
  22
  23 ## Linux Build
  24
  25 The build process uses cmake and should work with the usual cmake options and utilities.
  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 and 15.10.
  29 It should be straightforward to use it on other Linux distros.
  30
  31 These packages should be installed
  32 ```
  33 ssudo apt-get install git subversion cmake libgl1-mesa-dev freeglut3-dev libglm-dev qt5-default libpciaccess-dev libpthread-stubs0-dev libudev-dev bison graphviz libpng-dev libxcb1-dev
  34 sudo apt-get build-dep mesa
  35 ```
  36
  37 Example debug build:
  38 ```
  39 cd YOUR_DEV_DIRECTORY  # cd to the root of the Vulkan-LoaderAndValidationLayers git repository
  40 ./update_external_sources.sh  # Fetches and builds glslang and spirv-tools
  41 cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug
  42 cd dbuild
  43 make
  44 ```
  45
  46 To run Vulkan programs you must tell the icd loader where to find the libraries.
  47 This is described in a specification in the Khronos documentation Git
  48 repository.  See the file:
  49 https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers/blob/sdk-1.0.3/loader/LoaderAndLayerInterface.md#vulkan-installable-client-driver-interface-with-the-loader
  50
  51 This specification describes both how ICDs and layers should be properly
  52 packaged, and how developers can point to ICDs and layers within their builds.
  53
  54 For example, you may wish to point to your just-built loader and layers with:
  55 ```
  56 export LD_LIBRARY_PATH=<path to your build root>/dbuild/loader
  57 export VK_LAYER_PATH=<path to your build root>/dbuild/layers
  58 ```
  59
  60 ## Validation Test
  61
  62 The test executables can be found in the dbuild/tests directory. The tests use the Google
  63 gtest infrastructure. Tests available so far:
  64 - vk_layer_validation_tests: Test Vulkan layers.
  65
  66 There are also a few shell and Python scripts that run test collections (eg,
  67 `run_all_tests.sh`).
  68
  69 ## Linux Demos
  70
  71 The demos executables can be found in the dbuild/demos directory. The demos use DRI 3
  72 to render directly onto window surfaces.
  73 - vulkaninfo: report GPU properties
  74 - tri: a textured triangle
  75 - cube: a textured spinning cube
  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 (from http://www.cmake.org/download/).  Notes:
  83   - Tell the installer to "Add CMake to the system PATH" environment variable.
  84 - Python 3 (from https://www.python.org/downloads).  Notes:
  85   - Select to install the optional sub-package to add Python to the system PATH environment variable.
  86   - 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
  87 - Git (from http://git-scm.com/download/win).
  88   - 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.
  89   - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
  90   - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
  91   - Install each a 32-bit and a 64-bit version, as the 64-bit installer does not install the 32-bit libraries and tools.
  92 - glslang is required for demos and tests.
  93   - You can download and configure it (in a peer directory) here: https://github.com/KhronosGroup/glslang/blob/master/README.md
  94   - 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:
  95     - update_external_sources.bat --build-glslang
  96
  97 Optional software packages:
  98
  99 - Cygwin (from https://www.cygwin.com/).  Notes:
 100   - Cygwin provides some Linux-like tools, which are valuable for obtaining the source code, and running CMake.
 101     Especially valuable are the BASH shell and git packages.
 102   - If you don't want to use Cygwin, there are other shells and environments that can be used.
 103     You can also use a Git package that doesn't come from Cygwin.
 104
 105 ## Windows Build
 106
 107 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.
 108
 109 Example debug x64 build (e.g. in a "Developer Command Prompt for VS2013" window):
 110 ```
 111 cd YOUR_DEV_DIRECTORY  # cd to the root of the Vulkan-LoaderAndValidationLayers 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 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.
 119
 120 To run Vulkan programs you must tell the icd loader where to find the libraries.
 121 This is described in a specification in the Khronos documentation Git
 122 repository.  See the file:
 123 https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers/blob/sdk-1.0.3/loader/LoaderAndLayerInterface.md#vulkan-installable-client-driver-interface-with-the-loader
 124
 125 This specification describes both how ICDs and layers should be properly
 126 packaged, and how developers can point to ICDs and layers within their builds.
 127
 128 ### Windows 64-bit Installation Notes
 129 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.
 130
 131 To do this, simply create and build the release versions of each target:
 132 ```
 133 cd LoaderAndTools  # cd to the root of the Vulkan git repository
 134 update_external_sources.bat --all
 135 mkdir build
 136 cd build
 137 cmake -G "Visual Studio 12 Win64" ..
 138 msbuild ALL_BUILD.vcxproj /p:Platform=x64 /p:Configuration=Release
 139 mkdir build32
 140 cd build32
 141 cmake -G "Visual Studio 12" ..
 142 msbuild ALL_BUILD.vcxproj /p:Platform=x86 /p:Configuration=Release
 143 ```
 144