1# Build Instructions
2This document contains the instructions for building this repository on Linux and Windows.
3
4This repository does not contain a Vulkan-capable driver.
5Before proceeding, it is strongly recommended that you obtain a Vulkan driver from your graphics hardware vendor
6and install it.
7
8Note: The sample Vulkan Intel driver for Linux (ICD) is being deprecated in favor of other driver options from Intel.
9This driver has been moved to the [VulkanTools repo](https://github.com/LunarG/VulkanTools).
10Further instructions regarding this ICD are available there.
11
12## Git the Bits
13
14To create your local git repository:
15```
16git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers
17```
18
19If you intend to contribute, the preferred work flow is for you to develop your contribution
20in a fork of this repo in your GitHub account and then submit a pull request.
21Please see the CONTRIBUTING.md file in this respository for more details.
22
23## Linux Build
24
25The build process uses CMake to generate makefiles for this project.
26The build generates the loader, layers, and tests.
27
28This repo has been built and tested on Ubuntu 14.04.3 LTS, 14.10, 15.04 and 15.10.
29It should be straightforward to use it on other Linux distros.
30
31These packages are needed to build this repository:
32```
33sudo apt-get install git cmake build-essential bison libxcb1-dev
34```
35
36Example debug build:
37```
38cd Vulkan-LoaderAndValidationLayers  # cd to the root of the cloned git repository
39./update_external_sources.sh  # Fetches and builds glslang and spirv-tools
40cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug
41cd dbuild
42make
43```
44
45If you have installed a Vulkan driver obtained from your graphics hardware vendor, the install process should
46have configured the driver so that the Vulkan loader can find and load it.
47
48If you want to use the loader and layers that you have just built:
49```
50export LD_LIBRARY_PATH=<path to your repository root>/dbuild/loader
51export VK_LAYER_PATH=<path to your repository root>/dbuild/layers
52```
53Note that if you have installed the [LunarG Vulkan SDK](https://vulkan.lunarg.com),
54you will also have the SDK version of the loader and layers installed in your default system libraries.
55
56You can run the `vulkaninfo` application to see which driver, loader and layers are being used.
57
58The `LoaderAndLayerInterface` document in the `loader` folder in this repository is a specification that
59describes both how ICDs and layers should be properly
60packaged, and how developers can point to ICDs and layers within their builds.
61
62## Validation Test
63
64The test executables can be found in the dbuild/tests directory.
65Some of the tests that are available:
66- vk_layer_validation_tests: Test Vulkan layers.
67
68There are also a few shell and Python scripts that run test collections (eg,
69`run_all_tests.sh`).
70
71## Linux Demos
72
73Some 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
81Windows 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- Python lxml package must be installed
92  - Download the lxml package from
93        http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml
94        32-bit latest for Python 3.5 is: lxml-3.5.0-cp35-none-win32.whl
95        64-bit latest for Python 3.5 is: lxml-3.5.0-cp35-none-win_amd64.whl
96  - The package can be installed with pip as follows:
97        pip install lxml-3.5.0-cp35-none-win32.whl
98        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.
99- Git (from http://git-scm.com/download/win).
100  - 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.
101  - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
102  - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
103  - Install each a 32-bit and a 64-bit version, as the 64-bit installer does not install the 32-bit libraries and tools.
104- glslang is required for demos and tests.
105  - You can download and configure it (in a peer directory) here: https://github.com/KhronosGroup/glslang/blob/master/README.md
106  - 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:
107    - update_external_sources.bat --build-glslang
108
109Optional software packages:
110
111- Cygwin (from https://www.cygwin.com/).  Notes:
112  - Cygwin provides some Linux-like tools, which are valuable for obtaining the source code, and running CMake.
113    Especially valuable are the BASH shell and git packages.
114  - If you don't want to use Cygwin, there are other shells and environments that can be used.
115    You can also use a Git package that doesn't come from Cygwin.
116
117## Windows Build
118
119Cygwin 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.
120
121To build all Windows targets (e.g. in a "Developer Command Prompt for VS2013" window):
122```
123cd Vulkan-LoaderAndValidationLayers  # cd to the root of the cloned git repository
124update_external_sources.bat --all
125build_windows_targets.bat
126```
127
128At 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.
129
130Vulkan 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.
131
132To run Vulkan programs you must tell the icd loader where to find the libraries.
133This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
134This specification describes both how ICDs and layers should be properly
135packaged, and how developers can point to ICDs and layers within their builds.
136
137