BUILD.md

   1 # Build Instructions
   2
   3 Instructions for building this repository on Linux, Windows, Android, and MacOS.
   4
   5 ## Index
   6
   7 1. [Contributing](#contributing-to-the-repository)
   8 1. [Repository Content](#repository-content)
   9 1. [Repository Set-Up](#repository-set-up)
  10 1. [Windows Build](#building-on-windows)
  11 1. [Linux Build](#building-on-linux)
  12 1. [Android Build](#building-on-android)
  13 1. [MacOS build](#building-on-macos)
  14
  15 ## Contributing to the Repository
  16
  17 If you intend to contribute, the preferred work flow is for you to develop
  18 your contribution in a fork of this repository in your GitHub account and then
  19 submit a pull request. Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file
  20 in this repository for more details.
  21
  22 ## Repository Content
  23
  24 This repository contains the source code necessary to build the following components:
  25
  26 - vulkaninfo
  27 - vkcube and vkcubepp demos
  28 - mock ICD
  29
  30 ### Installed Files
  31
  32 The `install` target installs the following files under the directory
  33 indicated by *install_dir*:
  34
  35 - *install_dir*`/bin` : The vulkaninfo, vkcube and vkcubepp executables
  36 - *install_dir*`/lib` : The mock ICD library and JSON (Windows) (If INSTALL_ICD=ON)
  37 - *install_dir*`/share/vulkan/icd.d` : mock ICD JSON (Linux/MacOS) (If INSTALL_ICD=ON)
  38
  39 The `uninstall` target can be used to remove the above files from the install
  40 directory.
  41
  42 ## Repository Set-Up
  43
  44 ### Display Drivers
  45
  46 This repository does not contain a Vulkan-capable driver. You will need to
  47 obtain and install a Vulkan driver from your graphics hardware vendor or from
  48 some other suitable source if you intend to run Vulkan applications.
  49
  50 ### Download the Repository
  51
  52 To create your local git repository:
  53
  54     git clone https://github.com/KhronosGroup/Vulkan-Tools.git
  55
  56 ### Repository Dependencies
  57
  58 This repository attempts to resolve some of its dependencies by using
  59 components found from the following places, in this order:
  60
  61 1. CMake or Environment variable overrides (e.g., -DVULKAN_HEADERS_INSTALL_DIR)
  62 1. LunarG Vulkan SDK, located by the `VULKAN_SDK` environment variable
  63 1. System-installed packages, mostly applicable on Linux
  64
  65 Dependencies that cannot be resolved by the SDK or installed packages must be
  66 resolved with the "install directory" override and are listed below. The
  67 "install directory" override can also be used to force the use of a specific
  68 version of that dependency.
  69
  70 #### Vulkan-Headers
  71
  72 This repository has a required dependency on the
  73 [Vulkan Headers repository](https://github.com/KhronosGroup/Vulkan-Headers).
  74 You must clone the headers repository and build its `install` target before
  75 building this repository. The Vulkan-Headers repository is required because it
  76 contains the Vulkan API definition files (registry) that are required to build
  77 the mock ICD. You must also take note of the headers install directory and
  78 pass it on the CMake command line for building this repository, as described
  79 below.
  80
  81 Note that this dependency can be ignored if not building the mock ICD
  82 (CMake option: `-DBUILD_ICD=OFF`).
  83
  84 #### glslang
  85
  86 This repository has a required dependency on the `glslangValidator` (shader
  87 compiler) for compiling the shader programs for the vkcube demos.
  88
  89 The CMake code in this repository downloads release binaries of glslang if a
  90 build glslang repository is not provided. The glslangValidator is obtained
  91 from this set of release binaries.
  92
  93 If you don't wish the CMake code to download these binaries, then you must
  94 clone the [glslang repository](https://github.com/KhronosGroup/glslang) and
  95 build its `install` target. Follow the build instructions in the glslang
  96 [README.md](https://github.com/KhronosGroup/glslang/blob/master/README.md)
  97 file. Ensure that the `update_glslang_sources.py` script has been run as part
  98 of building glslang. You must also take note of the glslang install directory
  99 and pass it on the CMake command line for building this repository, as
 100 described below.
 101
 102 Note that this dependency can be ignored if not building the vkcube demo
 103 (CMake option: `-DBUILD_CUBE=OFF`).
 104
 105 ### Build and Install Directories
 106
 107 A common convention is to place the build directory in the top directory of
 108 the repository with a name of `build` and place the install directory as a
 109 child of the build directory with the name `install`. The remainder of these
 110 instructions follow this convention, although you can use any name for these
 111 directories and place them in any location.
 112
 113 ### Building Dependent Repositories with Known-Good Revisions
 114
 115 There is a Python utility script, `scripts/update_deps.py`, that you can use to
 116 gather and build the dependent repositories mentioned above. This script uses
 117 information stored in the `scripts/known_good.json` file to check out dependent
 118 repository revisions that are known to be compatible with the revision of this
 119 repository that you currently have checked out. As such, this script is useful
 120 as a quick-start tool for common use cases and default configurations.
 121
 122 For all platforms, start with:
 123
 124     git clone git@github.com:KhronosGroup/Vulkan-Tools.git
 125     cd Vulkan-Tools
 126     mkdir build
 127     cd build
 128
 129 For 64-bit Linux and MacOS, continue with:
 130
 131     ../scripts/update_deps.py
 132     cmake -C helper.cmake ..
 133     cmake --build .
 134
 135 For 64-bit Windows, continue with:
 136
 137     ..\scripts\update_deps.py --arch x64
 138     cmake -A x64 -C helper.cmake ..
 139     cmake --build .
 140
 141 For 32-bit Windows, continue with:
 142
 143     ..\scripts\update_deps.py --arch Win32
 144     cmake -A Win32 -C helper.cmake ..
 145     cmake --build .
 146
 147 Please see the more detailed build information later in this file if you have
 148 specific requirements for configuring and building these components.
 149
 150 #### Notes
 151
 152 - You may need to adjust some of the CMake options based on your platform. See
 153   the platform-specific sections later in this document.
 154 - The `update_deps.py` script fetches and builds the dependent repositories in
 155   the current directory when it is invoked. In this case, they are built in
 156   the `build` directory.
 157 - The `build` directory is also being used to build this
 158   (Vulkan-Tools) repository. But there shouldn't be any conflicts
 159   inside the `build` directory between the dependent repositories and the
 160   build files for this repository.
 161 - The `--dir` option for `update_deps.py` can be used to relocate the
 162   dependent repositories to another arbitrary directory using an absolute or
 163   relative path.
 164 - The `update_deps.py` script generates a file named `helper.cmake` and places
 165   it in the same directory as the dependent repositories (`build` in this
 166   case). This file contains CMake commands to set the CMake `*_INSTALL_DIR`
 167   variables that are used to point to the install artifacts of the dependent
 168   repositories. You can use this file with the `cmake -C` option to set these
 169   variables when you generate your build files with CMake. This lets you avoid
 170   entering several `*_INSTALL_DIR` variable settings on the CMake command line.
 171 - If using "MINGW" (Git For Windows), you may wish to run
 172   `winpty update_deps.py` in order to avoid buffering all of the script's
 173   "print" output until the end and to retain the ability to interrupt script
 174   execution.
 175 - Please use `update_deps.py --help` to list additional options and read the
 176   internal documentation in `update_deps.py` for further information.
 177
 178 ### Generated source code
 179
 180 This repository contains generated source code in the `icd/generated`
 181 directory which is not intended to be modified directly. Instead, changes should be
 182 made to the corresponding generator in the `scripts` directory. The source files can
 183 then be regenerated using `scripts/generate_source.py`:
 184
 185     python3 scripts/generate_source.py PATH_TO_VULKAN_HEADERS_REGISTRY_DIR
 186
 187 A helper CMake target `VulkanTools_generated_source` is also provided to simplify
 188 the invocation of `scripts/generate_source.py` from the build directory:
 189
 190     cmake --build . --target VulkanTools_generated_source
 191
 192 ### Build Options
 193
 194 When generating native platform build files through CMake, several options can
 195 be specified to customize the build. Some of the options are binary on/off
 196 options, while others take a string as input. The following is a table of all
 197 on/off options currently supported by this repository:
 198
 199 | Option | Platform | Default | Description |
 200 | ------ | -------- | ------- | ----------- |
 201 | BUILD_CUBE | All | `ON` | Controls whether or not the vkcube demo is built. |
 202 | BUILD_VULKANINFO | All | `ON` | Controls whether or not the vulkaninfo utility is built. |
 203 | BUILD_ICD | All | `ON` | Controls whether or not the mock ICD is built. |
 204 | INSTALL_ICD | All | `OFF` | Controls whether or not the mock ICD is installed as part of the install target. |
 205 | BUILD_WSI_XCB_SUPPORT | Linux | `ON` | Build the components with XCB support. |
 206 | BUILD_WSI_XLIB_SUPPORT | Linux | `ON` | Build the components with Xlib support. |
 207 | BUILD_WSI_WAYLAND_SUPPORT | Linux | `ON` | Build the components with Wayland support. |
 208 | USE_CCACHE | Linux | `OFF` | Enable caching with the CCache program. |
 209
 210 The following is a table of all string options currently supported by this repository:
 211
 212 | Option | Platform | Default | Description |
 213 | ------ | -------- | ------- | ----------- |
 214 | CMAKE_OSX_DEPLOYMENT_TARGET | MacOS | `10.12` | The minimum version of MacOS for loader deployment. |
 215
 216 These variables should be set using the `-D` option when invoking CMake to
 217 generate the native platform files.
 218
 219 ## Building On Windows
 220
 221 ### Windows Development Environment Requirements
 222
 223 - Windows
 224   - Any Personal Computer version supported by Microsoft
 225 - Microsoft [Visual Studio](https://www.visualstudio.com/)
 226   - Versions
 227     - [2013 (update 4)](https://www.visualstudio.com/vs/older-downloads/)
 228     - [2015](https://www.visualstudio.com/vs/older-downloads/)
 229     - [2017](https://www.visualstudio.com/vs/downloads/)
 230   - The Community Edition of each of the above versions is sufficient, as
 231     well as any more capable edition.
 232 - [CMake 3.10.2](https://cmake.org/files/v3.10/cmake-3.10.2-win64-x64.zip) is recommended.
 233   - Use the installer option to add CMake to the system PATH
 234 - Git Client Support
 235   - [Git for Windows](http://git-scm.com/download/win) is a popular solution
 236     for Windows
 237   - Some IDEs (e.g., [Visual Studio](https://www.visualstudio.com/),
 238     [GitHub Desktop](https://desktop.github.com/)) have integrated
 239     Git client support
 240
 241 ### Windows Build - Microsoft Visual Studio
 242
 243 The general approach is to run CMake to generate the Visual Studio project
 244 files. Then either run CMake with the `--build` option to build from the
 245 command line or use the Visual Studio IDE to open the generated solution and
 246 work with the solution interactively.
 247
 248 #### Windows Quick Start
 249
 250     cd Vulkan-Tools
 251     mkdir build
 252     cd build
 253     cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir
 254     cmake --build .
 255
 256 The above commands instruct CMake to find and use the default Visual Studio
 257 installation to generate a Visual Studio solution and projects for the x64
 258 architecture. The second CMake command builds the Debug (default)
 259 configuration of the solution.
 260
 261 See below for the details.
 262
 263 #### Use `CMake` to Create the Visual Studio Project Files
 264
 265 Change your current directory to the top of the cloned repository directory,
 266 create a build directory and generate the Visual Studio project files:
 267
 268     cd Vulkan-Tools
 269     mkdir build
 270     cd build
 271     cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir
 272
 273 > Note: The `..` parameter tells `cmake` the location of the top of the
 274 > repository. If you place your build directory someplace else, you'll need to
 275 > specify the location of the repository top differently.
 276
 277 The `-A` option is used to select either the "Win32" or "x64" architecture.
 278
 279 If a generator for a specific version of Visual Studio is required, you can
 280 specify it for Visual Studio 2015, for example, with:
 281
 282     64-bit: -G "Visual Studio 14 2015 Win64"
 283     32-bit: -G "Visual Studio 14 2015"
 284
 285 See this [list](#cmake-visual-studio-generators) of other possible generators
 286 for Visual Studio.
 287
 288 When generating the project files, the absolute path to a Vulkan-Headers
 289 install directory must be provided. This can be done by setting the
 290 `VULKAN_HEADERS_INSTALL_DIR` environment variable or by setting the
 291 `VULKAN_HEADERS_INSTALL_DIR` CMake variable with the `-D` CMake option. In
 292 either case, the variable should point to the installation directory of a
 293 Vulkan-Headers repository built with the install target.
 294
 295 The above steps create a Windows solution file named
 296 `Vulkan-Tools.sln` in the build directory.
 297
 298 At this point, you can build the solution from the command line or open the
 299 generated solution with Visual Studio.
 300
 301 #### Build the Solution From the Command Line
 302
 303 While still in the build directory:
 304
 305     cmake --build .
 306
 307 to build the Debug configuration (the default), or:
 308
 309     cmake --build . --config Release
 310
 311 to make a Release build.
 312
 313 #### Build the Solution With Visual Studio
 314
 315 Launch Visual Studio and open the "Vulkan-Tools.sln" solution file in the
 316 build folder. You may select "Debug" or "Release" from the Solution
 317 Configurations drop-down list. Start a build by selecting the Build->Build
 318 Solution menu item.
 319
 320 #### Windows Install Target
 321
 322 The CMake project also generates an "install" target that you can use to copy
 323 the primary build artifacts to a specific location using a "bin, include, lib"
 324 style directory structure. This may be useful for collecting the artifacts and
 325 providing them to another project that is dependent on them.
 326
 327 The default location is `$CMAKE_BINARY_DIR\install`, but can be changed with
 328 the `CMAKE_INSTALL_PREFIX` variable when first generating the project build
 329 files with CMake.
 330
 331 You can build the install target from the command line with:
 332
 333     cmake --build . --config Release --target install
 334
 335 or build the `INSTALL` target from the Visual Studio solution explorer.
 336
 337 #### Using a Loader Built from a Repository
 338
 339 If you do need to build and use your own loader, build the Vulkan-Loader
 340 repository with the install target and modify your CMake invocation to add the
 341 location of the loader's install directory:
 342
 343     cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
 344                  -DVULKAN_LOADER_INSTALL_DIR=absolute_path_to_install_dir ..
 345
 346 #### Using glslang Built from a Repository
 347
 348 If you do need to build and use your own glslang, build the glslang repository
 349 with the install target and modify your CMake invocation to add the location
 350 of the glslang's install directory:
 351
 352     cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
 353                  -DGLSLANG_INSTALL_DIR=absolute_path_to_install_dir ..
 354
 355 ### Windows Notes
 356
 357 #### CMake Visual Studio Generators
 358
 359 The chosen generator should match one of the Visual Studio versions that you
 360 have installed. Generator strings that correspond to versions of Visual Studio
 361 include:
 362
 363 | Build Platform               | 64-bit Generator              | 32-bit Generator        |
 364 |------------------------------|-------------------------------|-------------------------|
 365 | Microsoft Visual Studio 2013 | "Visual Studio 12 2013 Win64" | "Visual Studio 12 2013" |
 366 | Microsoft Visual Studio 2015 | "Visual Studio 14 2015 Win64" | "Visual Studio 14 2015" |
 367 | Microsoft Visual Studio 2017 | "Visual Studio 15 2017 Win64" | "Visual Studio 15 2017" |
 368
 369 ## Building On Linux
 370
 371 ### Linux Build Requirements
 372
 373 This repository has been built and tested on the two most recent Ubuntu LTS
 374 versions. Currently, the oldest supported version is Ubuntu 16.04, meaning
 375 that the minimum officially supported C++11 compiler version is GCC 5.4.0,
 376 although earlier versions may work. It should be straightforward to adapt this
 377 repository to other Linux distributions.
 378
 379 [CMake 3.10.2](https://cmake.org/files/v3.10/cmake-3.10.2-Linux-x86_64.tar.gz) is recommended.
 380
 381 #### Required Package List
 382
 383     sudo apt-get install git cmake build-essential libx11-xcb-dev \
 384         libxkbcommon-dev libwayland-dev libxrandr-dev
 385
 386 ### Linux Build
 387
 388 The general approach is to run CMake to generate make files. Then either run
 389 CMake with the `--build` option or `make` to build from the command line.
 390
 391 #### Linux Quick Start
 392
 393     cd Vulkan-Tools
 394     mkdir build
 395     cd build
 396     cmake -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir ..
 397     make
 398
 399 See below for the details.
 400
 401 #### Use CMake to Create the Make Files
 402
 403 Change your current directory to the top of the cloned repository directory,
 404 create a build directory and generate the make files.
 405
 406     cd Vulkan-Tools
 407     mkdir build
 408     cd build
 409     cmake -DCMAKE_BUILD_TYPE=Debug \
 410           -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
 411           -DCMAKE_INSTALL_PREFIX=install ..
 412
 413 > Note: The `..` parameter tells `cmake` the location of the top of the
 414 > repository. If you place your `build` directory someplace else, you'll need
 415 > to specify the location of the repository top differently.
 416
 417 Use `-DCMAKE_BUILD_TYPE` to specify a Debug or Release build.
 418
 419 When generating the project files, the absolute path to a Vulkan-Headers
 420 install directory must be provided. This can be done by setting the
 421 `VULKAN_HEADERS_INSTALL_DIR` environment variable or by setting the
 422 `VULKAN_HEADERS_INSTALL_DIR` CMake variable with the `-D` CMake option. In
 423 either case, the variable should point to the installation directory of a
 424 Vulkan-Headers repository built with the install target.
 425
 426 > Note: For Linux, the default value for `CMAKE_INSTALL_PREFIX` is
 427 > `/usr/local`, which would be used if you do not specify
 428 > `CMAKE_INSTALL_PREFIX`. In this case, you may need to use `sudo` to install
 429 > to system directories later when you run `make install`.
 430
 431 #### Build the Project
 432
 433 You can just run `make` to begin the build.
 434
 435 To speed up the build on a multi-core machine, use the `-j` option for `make`
 436 to specify the number of cores to use for the build. For example:
 437
 438     make -j4
 439
 440 You can also use
 441
 442     cmake --build .
 443
 444 If your build system supports ccache, you can enable that via CMake option `-DUSE_CCACHE=On`
 445
 446 ### Linux Notes
 447
 448 #### WSI Support Build Options
 449
 450 By default, the repository components are built with support for the
 451 Vulkan-defined WSI display servers: Xcb, Xlib, and Wayland. It is recommended
 452 to build the repository components with support for these display servers to
 453 maximize their usability across Linux platforms. If it is necessary to build
 454 these modules without support for one of the display servers, the appropriate
 455 CMake option of the form `BUILD_WSI_xxx_SUPPORT` can be set to `OFF`.
 456
 457 Note vulkaninfo currently only supports Xcb and Xlib WSI display servers. See
 458 the CMakeLists.txt file in `Vulkan-Tools/vulkaninfo` for more info.
 459
 460 You can select which WSI subsystem is used to execute the vkcube applications
 461 using a CMake option called DEMOS_WSI_SELECTION. Supported options are XCB
 462 (default), XLIB, and WAYLAND. Note that you must build using the corresponding
 463 BUILD_WSI_*_SUPPORT enabled at the base repository level. For instance,
 464 creating a build that will use Xlib when running the vkcube demos, your CMake
 465 command line might look like:
 466
 467     cmake -DCMAKE_BUILD_TYPE=Debug -DDEMOS_WSI_SELECTION=XLIB ..
 468
 469 #### Linux Install to System Directories
 470
 471 Installing the files resulting from your build to the systems directories is
 472 optional since environment variables can usually be used instead to locate the
 473 binaries. There are also risks with interfering with binaries installed by
 474 packages. If you are certain that you would like to install your binaries to
 475 system directories, you can proceed with these instructions.
 476
 477 Assuming that you've built the code as described above and the current
 478 directory is still `build`, you can execute:
 479
 480     sudo make install
 481
 482 This command installs files to `/usr/local` if no `CMAKE_INSTALL_PREFIX` is
 483 specified when creating the build files with CMake.
 484
 485 You may need to run `ldconfig` in order to refresh the system loader search
 486 cache on some Linux systems.
 487
 488 You can further customize the installation location by setting additional
 489 CMake variables to override their defaults. For example, if you would like to
 490 install to `/tmp/build` instead of `/usr/local`, on your CMake command line
 491 specify:
 492
 493     -DCMAKE_INSTALL_PREFIX=/tmp/build
 494
 495 Then run `make install` as before. The install step places the files in
 496 `/tmp/build`. This may be useful for collecting the artifacts and providing
 497 them to another project that is dependent on them.
 498
 499 Note: The Mock ICD is not installed by default since it is a "null" driver
 500 that does not render anything and is used for testing purposes. Installing it
 501 to system directories may cause some applications to discover and use this
 502 driver instead of other full drivers installed on the system. If you really
 503 want to install this null driver, use:
 504
 505     -DINSTALL_ICD=ON
 506
 507 See the CMake documentation for more details on using these variables to
 508 further customize your installation.
 509
 510 Also see the `LoaderAndLayerInterface` document in the `loader` folder of the
 511 Vulkan-Loader repository for more information about loader and layer
 512 operation.
 513
 514 #### Linux Uninstall
 515
 516 To uninstall the files from the system directories, you can execute:
 517
 518     sudo make uninstall
 519
 520 ### Linux Tests
 521
 522 After making any changes to the repository, you should perform some quick
 523 sanity tests, such as running the vkcube demo with validation enabled.
 524
 525 To run the **vkcube application** with validation, in a terminal change to the
 526 `build/cube` directory and run:
 527
 528     VK_LAYER_PATH=../path/to/validation/layers ./vkcube --validate
 529
 530 If you have an SDK installed and have run the setup script to set the
 531 `VULKAN_SDK` environment variable, it may be unnecessary to specify a
 532 `VK_LAYER_PATH`.
 533
 534 #### Linux 32-bit support
 535
 536 Usage of the contents of this repository in 32-bit Linux environments is not
 537 officially supported. However, since this repository is supported on 32-bit
 538 Windows, these modules should generally work on 32-bit Linux.
 539
 540 Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference"
 541 platform:
 542
 543 If not already installed, install the following 32-bit development libraries:
 544
 545 `gcc-multilib g++-multilib libx11-dev:i386`
 546
 547 This list may vary depending on your distribution and which windowing systems
 548 you are building for.
 549
 550 Set up your environment for building 32-bit targets:
 551
 552     export ASFLAGS=--32
 553     export CFLAGS=-m32
 554     export CXXFLAGS=-m32
 555     export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
 556
 557 Again, your PKG_CONFIG configuration may be different, depending on your
 558 distribution.
 559
 560 Finally, rebuild the repository using `cmake` and `make`, as explained above.
 561
 562 ## Building On Android
 563
 564 Install the required tools for Linux and Windows covered above, then add the
 565 following.
 566
 567 ### Android Build Requirements
 568
 569 - Install [Android Studio 2.3](https://developer.android.com/studio/index.html) or later.
 570 - From the "Welcome to Android Studio" splash screen, add the following components using
 571   Configure > SDK Manager:
 572   - SDK Platforms > Android 6.0 and newer
 573   - SDK Tools > Android SDK Build-Tools
 574   - SDK Tools > Android SDK Platform-Tools
 575   - SDK Tools > Android SDK Tools
 576   - SDK Tools > NDK
 577
 578 #### Add Android specifics to environment
 579
 580 For each of the below, you may need to specify a different build-tools
 581 version, as Android Studio will roll it forward fairly regularly.
 582
 583 On Linux:
 584
 585     export ANDROID_SDK_HOME=$HOME/Android/sdk
 586     export ANDROID_NDK_HOME=$HOME/Android/sdk/ndk-bundle
 587     export PATH=$ANDROID_SDK_HOME:$PATH
 588     export PATH=$ANDROID_NDK_HOME:$PATH
 589     export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
 590
 591 On Windows:
 592
 593     set ANDROID_SDK_HOME=%LOCALAPPDATA%\Android\sdk
 594     set ANDROID_NDK_HOME=%LOCALAPPDATA%\Android\sdk\ndk-bundle
 595     set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
 596
 597 On OSX:
 598
 599     export ANDROID_SDK_HOME=$HOME/Library/Android/sdk
 600     export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk-bundle
 601     export PATH=$ANDROID_NDK_PATH:$PATH
 602     export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
 603
 604 Note: If `jarsigner` is missing from your platform, you can find it in the
 605 Android Studio install or in your Java installation. If you do not have Java,
 606 you can get it with something like the following:
 607
 608   sudo apt-get install openjdk-8-jdk
 609
 610 #### Additional OSX System Requirements
 611
 612 Tested on OSX version 10.13.3
 613
 614 Setup Homebrew and components
 615
 616 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
 617
 618       /usr/bin/ruby -e "$(curl -fsSL \
 619           https://raw.githubusercontent.com/Homebrew/install/master/install)"
 620
 621 - Ensure Homebrew is at the beginning of your PATH:
 622
 623       export PATH=/usr/local/bin:$PATH
 624
 625 - Add packages with the following:
 626
 627       brew install python
 628
 629 ### Android Build
 630
 631 There are two options for building the Android tools. Either using the SPIRV
 632 tools provided as part of the Android NDK, or using upstream sources. To build
 633 with SPIRV tools from the NDK, remove the build-android/third_party directory
 634 created by running update_external_sources_android.sh, (or avoid running
 635 update_external_sources_android.sh). Use the following script to build
 636 everything in the repository for Android, including validation layers, tests,
 637 demos, and APK packaging: This script does retrieve and use the upstream SPRIV
 638 tools.
 639
 640     cd build-android
 641     ./build_all.sh
 642
 643 Test and application APKs can be installed on production devices with:
 644
 645     ./install_all.sh [-s <serial number>]
 646
 647 Note that there are no equivalent scripts on Windows yet, that work needs to
 648 be completed. The following per platform commands can be used for layer only
 649 builds:
 650
 651 #### Linux and OSX
 652
 653 Follow the setup steps for Linux or OSX above, then from your terminal:
 654
 655     cd build-android
 656     ./update_external_sources_android.sh --no-build
 657     ./android-generate.sh
 658     ndk-build -j4
 659
 660 #### Windows
 661
 662 Follow the setup steps for Windows above, then from Developer Command Prompt
 663 for VS2013:
 664
 665     cd build-android
 666     update_external_sources_android.bat
 667     android-generate.bat
 668     ndk-build
 669
 670 ### Android Tests and Demos
 671
 672 After making any changes to the repository you should perform some quick
 673 sanity tests, including the layer validation tests and the vkcube
 674 demo with validation enabled.
 675
 676 #### Run Layer Validation Tests
 677
 678 Use the following steps to build, install, and run the layer validation tests
 679 for Android:
 680
 681     cd build-android
 682     ./build_all.sh
 683     adb install -r bin/VulkanLayerValidationTests.apk
 684     adb shell am start com.example.VulkanLayerValidationTests/android.app.NativeActivity
 685
 686 Alternatively, you can use the test_APK script to install and run the layer
 687 validation tests:
 688
 689     test_APK.sh -s <serial number> -p <platform name> -f <gtest_filter>
 690
 691 #### Run vkcube with Validation
 692
 693 TODO: This must be reworked to pull in layers from the ValidationLayers repo
 694
 695 Use the following steps to build, install, and run vkcube for Android:
 696
 697     cd build-android
 698     ./build_all.sh
 699     adb install -r ../demos/android/cube/bin/vkcube.apk
 700     adb shell am start com.example.Cube/android.app.NativeActivity
 701
 702 To build, install, and run Cube with validation layers,
 703 first build layers using steps above, then run:
 704
 705     cd build-android
 706     ./build_all.sh
 707     adb install -r ../demos/android/cube-with-layers/bin/cube-with-layers.apk
 708
 709 ##### Run without validation enabled
 710
 711     adb shell am start com.example.CubeWithLayers/android.app.NativeActivity
 712
 713 ##### Run with validation enabled
 714
 715     adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
 716
 717 ## Building on MacOS
 718
 719 ### MacOS Build Requirements
 720
 721 Tested on OSX version 10.12.6
 722
 723 - [CMake 3.10.2](https://cmake.org/files/v3.10/cmake-3.10.2-Darwin-x86_64.tar.gz) is recommended.
 724
 725 Setup Homebrew and components
 726
 727 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
 728
 729       /usr/bin/ruby -e "$(curl -fsSL \
 730           https://raw.githubusercontent.com/Homebrew/install/master/install)"
 731
 732 - Ensure Homebrew is at the beginning of your PATH:
 733
 734       export PATH=/usr/local/bin:$PATH
 735
 736 - Add packages with the following (may need refinement)
 737
 738       brew install python python3 git
 739
 740 ### Clone the Repository
 741
 742 Clone the Vulkan-Tools repository as defined above in the [Download the Repository](#download-the-repository)
 743 section.
 744
 745 ### Get the External Libraries
 746
 747 [MoltenVK](https://github.com/KhronosGroup/MoltenVK) Library
 748
 749 - Building the vkcube and vulkaninfo applications require linking to the
 750   MoltenVK Library (libMoltenVK.dylib)
 751   - The following option should be used on the cmake command line to specify a
 752     vulkan loader library: MOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK
 753     making sure to specify an absolute path, like so: cmake
 754     -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK ....
 755
 756 Vulkan Loader Library
 757
 758 - Building the vkcube and vulkaninfo applications require linking to the Vulkan
 759   Loader Library (libvulkan.1.dylib)
 760   - The following option should be used on the cmake command line to specify a
 761     vulkan loader library:
 762     VULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir
 763     making sure to specify an absolute path.
 764
 765 ### MacOS build
 766
 767 #### CMake Generators
 768
 769 This repository uses CMake to generate build or project files that are then
 770 used to build the repository. The CMake generators explicitly supported in
 771 this repository are:
 772
 773 - Unix Makefiles
 774 - Xcode
 775
 776 #### Building with the Unix Makefiles Generator
 777
 778 This generator is the default generator, so all that is needed for a debug
 779 build is:
 780
 781         mkdir build
 782         cd build
 783         cmake -DCMAKE_BUILD_TYPE=Debug \
 784               -DVULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir \
 785               -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK \
 786               -DCMAKE_INSTALL_PREFIX=install ..
 787         make
 788
 789 To speed up the build on a multi-core machine, use the `-j` option for `make`
 790 to specify the number of cores to use for the build. For example:
 791
 792     make -j4
 793
 794 You can now run the demo applications from the command line:
 795
 796     open cube/vkcube.app
 797     open cube/vkcubepp.app
 798     open vulkaninfo/vulkaninfo.app
 799
 800 Or you can locate them from `Finder` and launch them from there.
 801
 802 ##### The Install Target and RPATH
 803
 804 The applications you just built are "bundled applications", but the
 805 executables are using the `RPATH` mechanism to locate runtime dependencies
 806 that are still in your build tree.
 807
 808 To see this, run this command from your `build` directory:
 809
 810     otool -l cube/cube.app/Contents/MacOS/vkcube
 811
 812 and note that the `vkcube` executable contains loader commands:
 813
 814 - `LC_LOAD_DYLIB` to load `libvulkan.1.dylib` via an `@rpath`
 815 - `LC_RPATH` that contains an absolute path to the build location of the Vulkan loader
 816
 817 This makes the bundled application "non-transportable", meaning that it won't
 818 run unless the Vulkan loader is on that specific absolute path. This is useful
 819 for debugging the loader or other components built in this repository, but not
 820 if you want to move the application to another machine or remove your build
 821 tree.
 822
 823 To address this problem, run:
 824
 825     make install
 826
 827 This step copies the bundled applications to the location specified by
 828 CMAKE_INSTALL_PREFIX and "cleans up" the `RPATH` to remove any external
 829 references and performs other bundle fix-ups. After running `make install`,
 830 run the `otool` command again from the `build/install` directory and note:
 831
 832 - `LC_LOAD_DYLIB` is now `@executable_path/../MacOS/libvulkan.1.dylib`
 833 - `LC_RPATH` is no longer present
 834
 835 The "bundle fix-up" operation also puts a copy of the Vulkan loader into the
 836 bundle, making the bundle completely self-contained and self-referencing.
 837
 838 ##### The Non-bundled vulkaninfo Application
 839
 840 There is also a non-bundled version of the `vulkaninfo` application that you
 841 can run from the command line:
 842
 843     vulkaninfo/vulkaninfo
 844
 845 If you run this from the build directory, vulkaninfo's RPATH is already
 846 set to point to the Vulkan loader in the build tree, so it has no trouble
 847 finding it. But the loader will not find the MoltenVK driver and you'll see a
 848 message about an incompatible driver. To remedy this:
 849
 850     VK_ICD_FILENAMES=<path-to>/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json vulkaninfo/vulkaninfo
 851
 852 If you run `vulkaninfo` from the install directory, the `RPATH` in the
 853 `vulkaninfo` application got removed and the OS needs extra help to locate
 854 the Vulkan loader:
 855
 856     DYLD_LIBRARY_PATH=<path-to>/Vulkan-Loader/loader VK_ICD_FILENAMES=<path-to>/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json vulkaninfo/vulkaninfo
 857
 858 #### Building with the Xcode Generator
 859
 860 To create and open an Xcode project:
 861
 862         mkdir build-xcode
 863         cd build-xcode
 864         cmake -DVULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK -GXcode ..
 865         open VULKAN.xcodeproj
 866
 867 Within Xcode, you can select Debug or Release builds in the project's Build
 868 Settings. You can also select individual schemes for working with specific
 869 applications like `vkcube`.