3 Instructions for building this repository on Linux, Windows, Android, and MacOS.
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)
15 ## Contributing to the Repository
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.
24 This repository contains the source code necessary to build the following components:
27 - vkcube and vkcubepp demos
32 The `install` target installs the following files under the directory
33 indicated by *install_dir*:
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)
39 The `uninstall` target can be used to remove the above files from the install
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.
50 ### Download the Repository
52 To create your local git repository:
54 git clone https://github.com/KhronosGroup/Vulkan-Tools.git
56 ### Repository Dependencies
58 This repository attempts to resolve some of its dependencies by using
59 components found from the following places, in this order:
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
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.
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
81 Note that this dependency can be ignored if not building the mock ICD
82 (CMake option: `-DBUILD_ICD=OFF`).
86 This repository has a required dependency on the `glslangValidator` (shader
87 compiler) for compiling the shader programs for the vkcube demos.
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.
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
102 Note that this dependency can be ignored if not building the vkcube demo
103 (CMake option: `-DBUILD_CUBE=OFF`).
105 ### Build and Install Directories
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.
113 ### Building Dependent Repositories with Known-Good Revisions
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.
121 Here is a usage example for this repository:
123 git clone git@github.com:KhronosGroup/Vulkan-Tools.git
127 ../scripts/update_deps.py
128 cmake -C helper.cmake ..
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
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
156 - Please use `update_deps.py --help` to list additional options and read the
157 internal documentation in `update_deps.py` for further information.
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:
167 | Option | Platform | Default | Description |
168 | ------ | -------- | ------- | ----------- |
169 | BUILD_CUBE | All | `ON` | Controls whether or not the vkcube 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 | USE_CCACHE | Linux | `OFF` | Enable caching with the CCache program. |
178 The following is a table of all string options currently supported by this repository:
180 | Option | Platform | Default | Description |
181 | ------ | -------- | ------- | ----------- |
182 | CMAKE_OSX_DEPLOYMENT_TARGET | MacOS | `10.12` | The minimum version of MacOS for loader deployment. |
184 These variables should be set using the `-D` option when invoking CMake to
185 generate the native platform files.
187 ## Building On Windows
189 ### Windows Development Environment Requirements
192 - Any Personal Computer version supported by Microsoft
193 - Microsoft [Visual Studio](https://www.visualstudio.com/)
195 - [2013 (update 4)](https://www.visualstudio.com/vs/older-downloads/)
196 - [2015](https://www.visualstudio.com/vs/older-downloads/)
197 - [2017](https://www.visualstudio.com/vs/downloads/)
198 - The Community Edition of each of the above versions is sufficient, as
199 well as any more capable edition.
200 - [CMake](http://www.cmake.org/download/) (CI uses CMake 3.12.2)
201 - Use the installer option to add CMake to the system PATH
203 - [Git for Windows](http://git-scm.com/download/win) is a popular solution
205 - Some IDEs (e.g., [Visual Studio](https://www.visualstudio.com/),
206 [GitHub Desktop](https://desktop.github.com/)) have integrated
209 ### Windows Build - Microsoft Visual Studio
211 The general approach is to run CMake to generate the Visual Studio project
212 files. Then either run CMake with the `--build` option to build from the
213 command line or use the Visual Studio IDE to open the generated solution and
214 work with the solution interactively.
216 #### Windows Quick Start
221 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir
224 The above commands instruct CMake to find and use the default Visual Studio
225 installation to generate a Visual Studio solution and projects for the x64
226 architecture. The second CMake command builds the Debug (default)
227 configuration of the solution.
229 See below for the details.
231 #### Use `CMake` to Create the Visual Studio Project Files
233 Change your current directory to the top of the cloned repository directory,
234 create a build directory and generate the Visual Studio project files:
239 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir
241 > Note: The `..` parameter tells `cmake` the location of the top of the
242 > repository. If you place your build directory someplace else, you'll need to
243 > specify the location of the repository top differently.
245 The `-A` option is used to select either the "Win32" or "x64" architecture.
247 If a generator for a specific version of Visual Studio is required, you can
248 specify it for Visual Studio 2015, for example, with:
250 64-bit: -G "Visual Studio 14 2015 Win64"
251 32-bit: -G "Visual Studio 14 2015"
253 See this [list](#cmake-visual-studio-generators) of other possible generators
256 When generating the project files, the absolute path to a Vulkan-Headers
257 install directory must be provided. This can be done by setting the
258 `VULKAN_HEADERS_INSTALL_DIR` environment variable or by setting the
259 `VULKAN_HEADERS_INSTALL_DIR` CMake variable with the `-D` CMake option. In
260 either case, the variable should point to the installation directory of a
261 Vulkan-Headers repository built with the install target.
263 The above steps create a Windows solution file named
264 `Vulkan-Tools.sln` in the build directory.
266 At this point, you can build the solution from the command line or open the
267 generated solution with Visual Studio.
269 #### Build the Solution From the Command Line
271 While still in the build directory:
275 to build the Debug configuration (the default), or:
277 cmake --build . --config Release
279 to make a Release build.
281 #### Build the Solution With Visual Studio
283 Launch Visual Studio and open the "Vulkan-Tools.sln" solution file in the
284 build folder. You may select "Debug" or "Release" from the Solution
285 Configurations drop-down list. Start a build by selecting the Build->Build
288 #### Windows Install Target
290 The CMake project also generates an "install" target that you can use to copy
291 the primary build artifacts to a specific location using a "bin, include, lib"
292 style directory structure. This may be useful for collecting the artifacts and
293 providing them to another project that is dependent on them.
295 The default location is `$CMAKE_BINARY_DIR\install`, but can be changed with
296 the `CMAKE_INSTALL_PREFIX` variable when first generating the project build
299 You can build the install target from the command line with:
301 cmake --build . --config Release --target install
303 or build the `INSTALL` target from the Visual Studio solution explorer.
305 #### Using a Loader Built from a Repository
307 If you do need to build and use your own loader, build the Vulkan-Loader
308 repository with the install target and modify your CMake invocation to add the
309 location of the loader's install directory:
311 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
312 -DVULKAN_LOADER_INSTALL_DIR=absolute_path_to_install_dir ..
314 #### Using glslang Built from a Repository
316 If you do need to build and use your own glslang, build the glslang repository
317 with the install target and modify your CMake invocation to add the location
318 of the glslang's install directory:
320 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
321 -DGLSLANG_INSTALL_DIR=absolute_path_to_install_dir ..
325 #### CMake Visual Studio Generators
327 The chosen generator should match one of the Visual Studio versions that you
328 have installed. Generator strings that correspond to versions of Visual Studio
331 | Build Platform | 64-bit Generator | 32-bit Generator |
332 |------------------------------|-------------------------------|-------------------------|
333 | Microsoft Visual Studio 2013 | "Visual Studio 12 2013 Win64" | "Visual Studio 12 2013" |
334 | Microsoft Visual Studio 2015 | "Visual Studio 14 2015 Win64" | "Visual Studio 14 2015" |
335 | Microsoft Visual Studio 2017 | "Visual Studio 15 2017 Win64" | "Visual Studio 15 2017" |
339 ### Linux Build Requirements
341 This repository has been built and tested on the two most recent Ubuntu LTS
342 versions. Currently, the oldest supported version is Ubuntu 14.04, meaning
343 that the minimum supported compiler versions are GCC 4.8.2 and Clang 3.4,
344 although earlier versions may work. It should be straightforward to adapt this
345 repository to other Linux distributions.
347 #### Required Package List
349 sudo apt-get install git cmake build-essential libx11-xcb-dev \
350 libxkbcommon-dev libwayland-dev libxrandr-dev
352 *Note: CI uses CMake 3.12.4*
356 The general approach is to run CMake to generate make files. Then either run
357 CMake with the `--build` option or `make` to build from the command line.
359 #### Linux Quick Start
364 cmake -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir ..
367 See below for the details.
369 #### Use CMake to Create the Make Files
371 Change your current directory to the top of the cloned repository directory,
372 create a build directory and generate the make files.
377 cmake -DCMAKE_BUILD_TYPE=Debug \
378 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
379 -DCMAKE_INSTALL_PREFIX=install ..
381 > Note: The `..` parameter tells `cmake` the location of the top of the
382 > repository. If you place your `build` directory someplace else, you'll need
383 > to specify the location of the repository top differently.
385 Use `-DCMAKE_BUILD_TYPE` to specify a Debug or Release build.
387 When generating the project files, the absolute path to a Vulkan-Headers
388 install directory must be provided. This can be done by setting the
389 `VULKAN_HEADERS_INSTALL_DIR` environment variable or by setting the
390 `VULKAN_HEADERS_INSTALL_DIR` CMake variable with the `-D` CMake option. In
391 either case, the variable should point to the installation directory of a
392 Vulkan-Headers repository built with the install target.
394 > Note: For Linux, the default value for `CMAKE_INSTALL_PREFIX` is
395 > `/usr/local`, which would be used if you do not specify
396 > `CMAKE_INSTALL_PREFIX`. In this case, you may need to use `sudo` to install
397 > to system directories later when you run `make install`.
399 #### Build the Project
401 You can just run `make` to begin the build.
403 To speed up the build on a multi-core machine, use the `-j` option for `make`
404 to specify the number of cores to use for the build. For example:
412 If your build system supports ccache, you can enable that via CMake option `-DUSE_CCACHE=On`
416 #### WSI Support Build Options
418 By default, the repository components are built with support for the
419 Vulkan-defined WSI display servers: Xcb, Xlib, and Wayland. It is recommended
420 to build the repository components with support for these display servers to
421 maximize their usability across Linux platforms. If it is necessary to build
422 these modules without support for one of the display servers, the appropriate
423 CMake option of the form `BUILD_WSI_xxx_SUPPORT` can be set to `OFF`.
425 Note vulkaninfo currently only supports Xcb and Xlib WSI display servers. See
426 the CMakeLists.txt file in `Vulkan-Tools/vulkaninfo` for more info.
428 You can select which WSI subsystem is used to execute the vkcube applications
429 using a CMake option called DEMOS_WSI_SELECTION. Supported options are XCB
430 (default), XLIB, and WAYLAND. Note that you must build using the corresponding
431 BUILD_WSI_*_SUPPORT enabled at the base repository level. For instance,
432 creating a build that will use Xlib when running the vkcube demos, your CMake
433 command line might look like:
435 cmake -DCMAKE_BUILD_TYPE=Debug -DDEMOS_WSI_SELECTION=XLIB ..
437 #### Linux Install to System Directories
439 Installing the files resulting from your build to the systems directories is
440 optional since environment variables can usually be used instead to locate the
441 binaries. There are also risks with interfering with binaries installed by
442 packages. If you are certain that you would like to install your binaries to
443 system directories, you can proceed with these instructions.
445 Assuming that you've built the code as described above and the current
446 directory is still `build`, you can execute:
450 This command installs files to `/usr/local` if no `CMAKE_INSTALL_PREFIX` is
451 specified when creating the build files with CMake.
453 You may need to run `ldconfig` in order to refresh the system loader search
454 cache on some Linux systems.
456 You can further customize the installation location by setting additional
457 CMake variables to override their defaults. For example, if you would like to
458 install to `/tmp/build` instead of `/usr/local`, on your CMake command line
461 -DCMAKE_INSTALL_PREFIX=/tmp/build
463 Then run `make install` as before. The install step places the files in
464 `/tmp/build`. This may be useful for collecting the artifacts and providing
465 them to another project that is dependent on them.
467 Note: The Mock ICD is not installed by default since it is a "null" driver
468 that does not render anything and is used for testing purposes. Installing it
469 to system directories may cause some applications to discover and use this
470 driver instead of other full drivers installed on the system. If you really
471 want to install this null driver, use:
475 See the CMake documentation for more details on using these variables to
476 further customize your installation.
478 Also see the `LoaderAndLayerInterface` document in the `loader` folder of the
479 Vulkan-Loader repository for more information about loader and layer
484 To uninstall the files from the system directories, you can execute:
490 After making any changes to the repository, you should perform some quick
491 sanity tests, such as running the vkcube demo with validation enabled.
493 To run the **vkcube application** with validation, in a terminal change to the
494 `build/cube` directory and run:
496 VK_LAYER_PATH=../path/to/validation/layers ./vkcube --validate
498 If you have an SDK installed and have run the setup script to set the
499 `VULKAN_SDK` environment variable, it may be unnecessary to specify a
502 #### Linux 32-bit support
504 Usage of the contents of this repository in 32-bit Linux environments is not
505 officially supported. However, since this repository is supported on 32-bit
506 Windows, these modules should generally work on 32-bit Linux.
508 Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference"
511 If not already installed, install the following 32-bit development libraries:
513 `gcc-multilib g++-multilib libx11-dev:i386`
515 This list may vary depending on your distribution and which windowing systems
516 you are building for.
518 Set up your environment for building 32-bit targets:
523 export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
525 Again, your PKG_CONFIG configuration may be different, depending on your
528 Finally, rebuild the repository using `cmake` and `make`, as explained above.
530 ## Building On Android
532 Install the required tools for Linux and Windows covered above, then add the
535 ### Android Build Requirements
537 - Install [Android Studio 2.3](https://developer.android.com/studio/index.html) or later.
538 - From the "Welcome to Android Studio" splash screen, add the following components using
539 Configure > SDK Manager:
540 - SDK Platforms > Android 6.0 and newer
541 - SDK Tools > Android SDK Build-Tools
542 - SDK Tools > Android SDK Platform-Tools
543 - SDK Tools > Android SDK Tools
546 #### Add Android specifics to environment
548 For each of the below, you may need to specify a different build-tools
549 version, as Android Studio will roll it forward fairly regularly.
553 export ANDROID_SDK_HOME=$HOME/Android/sdk
554 export ANDROID_NDK_HOME=$HOME/Android/sdk/ndk-bundle
555 export PATH=$ANDROID_SDK_HOME:$PATH
556 export PATH=$ANDROID_NDK_HOME:$PATH
557 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
561 set ANDROID_SDK_HOME=%LOCALAPPDATA%\Android\sdk
562 set ANDROID_NDK_HOME=%LOCALAPPDATA%\Android\sdk\ndk-bundle
563 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
567 export ANDROID_SDK_HOME=$HOME/Library/Android/sdk
568 export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk-bundle
569 export PATH=$ANDROID_NDK_PATH:$PATH
570 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
572 Note: If `jarsigner` is missing from your platform, you can find it in the
573 Android Studio install or in your Java installation. If you do not have Java,
574 you can get it with something like the following:
576 sudo apt-get install openjdk-8-jdk
578 #### Additional OSX System Requirements
580 Tested on OSX version 10.13.3
582 Setup Homebrew and components
584 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
586 /usr/bin/ruby -e "$(curl -fsSL \
587 https://raw.githubusercontent.com/Homebrew/install/master/install)"
589 - Ensure Homebrew is at the beginning of your PATH:
591 export PATH=/usr/local/bin:$PATH
593 - Add packages with the following:
595 brew install cmake python
599 There are two options for building the Android tools. Either using the SPIRV
600 tools provided as part of the Android NDK, or using upstream sources. To build
601 with SPIRV tools from the NDK, remove the build-android/third_party directory
602 created by running update_external_sources_android.sh, (or avoid running
603 update_external_sources_android.sh). Use the following script to build
604 everything in the repository for Android, including validation layers, tests,
605 demos, and APK packaging: This script does retrieve and use the upstream SPRIV
611 Test and application APKs can be installed on production devices with:
613 ./install_all.sh [-s <serial number>]
615 Note that there are no equivalent scripts on Windows yet, that work needs to
616 be completed. The following per platform commands can be used for layer only
621 Follow the setup steps for Linux or OSX above, then from your terminal:
624 ./update_external_sources_android.sh --no-build
625 ./android-generate.sh
630 Follow the setup steps for Windows above, then from Developer Command Prompt
634 update_external_sources_android.bat
638 ### Android Tests and Demos
640 After making any changes to the repository you should perform some quick
641 sanity tests, including the layer validation tests and the vkcube
642 demo with validation enabled.
644 #### Run Layer Validation Tests
646 Use the following steps to build, install, and run the layer validation tests
651 adb install -r bin/VulkanLayerValidationTests.apk
652 adb shell am start com.example.VulkanLayerValidationTests/android.app.NativeActivity
654 Alternatively, you can use the test_APK script to install and run the layer
657 test_APK.sh -s <serial number> -p <platform name> -f <gtest_filter>
659 #### Run vkcube with Validation
661 TODO: This must be reworked to pull in layers from the ValidationLayers repo
663 Use the following steps to build, install, and run vkcube for Android:
667 adb install -r ../demos/android/cube/bin/vkcube.apk
668 adb shell am start com.example.Cube/android.app.NativeActivity
670 To build, install, and run Cube with validation layers,
671 first build layers using steps above, then run:
675 adb install -r ../demos/android/cube-with-layers/bin/cube-with-layers.apk
677 ##### Run without validation enabled
679 adb shell am start com.example.CubeWithLayers/android.app.NativeActivity
681 ##### Run with validation enabled
683 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
687 ### MacOS Build Requirements
689 Tested on OSX version 10.12.6
691 Setup Homebrew and components
693 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
695 /usr/bin/ruby -e "$(curl -fsSL \
696 https://raw.githubusercontent.com/Homebrew/install/master/install)"
698 - Ensure Homebrew is at the beginning of your PATH:
700 export PATH=/usr/local/bin:$PATH
702 - Add packages with the following (may need refinement)
704 brew install cmake python python3 git
706 *Note:* CI uses CMake 3.11.3
708 ### Clone the Repository
710 Clone the Vulkan-Tools repository as defined above in the [Download the Repository](#download-the-repository)
713 ### Get the External Libraries
715 [MoltenVK](https://github.com/KhronosGroup/MoltenVK) Library
717 - Building the vkcube and vulkaninfo applications require linking to the
718 MoltenVK Library (libMoltenVK.dylib)
719 - The following option should be used on the cmake command line to specify a
720 vulkan loader library: MOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK
721 making sure to specify an absolute path, like so: cmake
722 -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK ....
724 Vulkan Loader Library
726 - Building the vkcube and vulkaninfo applications require linking to the Vulkan
727 Loader Library (libvulkan.1.dylib)
728 - The following option should be used on the cmake command line to specify a
729 vulkan loader library:
730 VULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir
731 making sure to specify an absolute path.
735 #### CMake Generators
737 This repository uses CMake to generate build or project files that are then
738 used to build the repository. The CMake generators explicitly supported in
744 #### Building with the Unix Makefiles Generator
746 This generator is the default generator, so all that is needed for a debug
751 cmake -DCMAKE_BUILD_TYPE=Debug \
752 -DVULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir \
753 -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK \
754 -DCMAKE_INSTALL_PREFIX=install ..
757 To speed up the build on a multi-core machine, use the `-j` option for `make`
758 to specify the number of cores to use for the build. For example:
762 You can now run the demo applications from the command line:
765 open cube/vkcubepp.app
766 open vulkaninfo/vulkaninfo.app
768 Or you can locate them from `Finder` and launch them from there.
770 ##### The Install Target and RPATH
772 The applications you just built are "bundled applications", but the
773 executables are using the `RPATH` mechanism to locate runtime dependencies
774 that are still in your build tree.
776 To see this, run this command from your `build` directory:
778 otool -l cube/cube.app/Contents/MacOS/vkcube
780 and note that the `vkcube` executable contains loader commands:
782 - `LC_LOAD_DYLIB` to load `libvulkan.1.dylib` via an `@rpath`
783 - `LC_RPATH` that contains an absolute path to the build location of the Vulkan loader
785 This makes the bundled application "non-transportable", meaning that it won't
786 run unless the Vulkan loader is on that specific absolute path. This is useful
787 for debugging the loader or other components built in this repository, but not
788 if you want to move the application to another machine or remove your build
791 To address this problem, run:
795 This step copies the bundled applications to the location specified by
796 CMAKE_INSTALL_PREFIX and "cleans up" the `RPATH` to remove any external
797 references and performs other bundle fix-ups. After running `make install`,
798 run the `otool` command again from the `build/install` directory and note:
800 - `LC_LOAD_DYLIB` is now `@executable_path/../MacOS/libvulkan.1.dylib`
801 - `LC_RPATH` is no longer present
803 The "bundle fix-up" operation also puts a copy of the Vulkan loader into the
804 bundle, making the bundle completely self-contained and self-referencing.
806 ##### The Non-bundled vulkaninfo Application
808 There is also a non-bundled version of the `vulkaninfo` application that you
809 can run from the command line:
811 vulkaninfo/vulkaninfo
813 If you run this from the build directory, vulkaninfo's RPATH is already
814 set to point to the Vulkan loader in the build tree, so it has no trouble
815 finding it. But the loader will not find the MoltenVK driver and you'll see a
816 message about an incompatible driver. To remedy this:
818 VK_ICD_FILENAMES=<path-to>/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json vulkaninfo/vulkaninfo
820 If you run `vulkaninfo` from the install directory, the `RPATH` in the
821 `vulkaninfo` application got removed and the OS needs extra help to locate
824 DYLD_LIBRARY_PATH=<path-to>/Vulkan-Loader/loader VK_ICD_FILENAMES=<path-to>/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json vulkaninfo/vulkaninfo
826 #### Building with the Xcode Generator
828 To create and open an Xcode project:
832 cmake -DVULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK -GXcode ..
833 open VULKAN.xcodeproj
835 Within Xcode, you can select Debug or Release builds in the project's Build
836 Settings. You can also select individual schemes for working with specific
837 applications like `vkcube`.