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