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 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.
122 For all platforms, start with:
124 git clone git@github.com:KhronosGroup/Vulkan-Tools.git
129 For 64-bit Linux and MacOS, continue with:
131 ../scripts/update_deps.py
132 cmake -C helper.cmake ..
135 For 64-bit Windows, continue with:
137 ..\scripts\update_deps.py --arch x64
138 cmake -A x64 -C helper.cmake ..
141 For 32-bit Windows, continue with:
143 ..\scripts\update_deps.py --arch Win32
144 cmake -A Win32 -C helper.cmake ..
147 Please see the more detailed build information later in this file if you have
148 specific requirements for configuring and building these components.
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
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
175 - Please use `update_deps.py --help` to list additional options and read the
176 internal documentation in `update_deps.py` for further information.
181 When generating native platform build files through CMake, several options can
182 be specified to customize the build. Some of the options are binary on/off
183 options, while others take a string as input. The following is a table of all
184 on/off options currently supported by this repository:
186 | Option | Platform | Default | Description |
187 | ------ | -------- | ------- | ----------- |
188 | BUILD_CUBE | All | `ON` | Controls whether or not the vkcube demo is built. |
189 | BUILD_VULKANINFO | All | `ON` | Controls whether or not the vulkaninfo utility is built. |
190 | BUILD_ICD | All | `ON` | Controls whether or not the mock ICD is built. |
191 | INSTALL_ICD | All | `OFF` | Controls whether or not the mock ICD is installed as part of the install target. |
192 | BUILD_WSI_XCB_SUPPORT | Linux | `ON` | Build the components with XCB support. |
193 | BUILD_WSI_XLIB_SUPPORT | Linux | `ON` | Build the components with Xlib support. |
194 | BUILD_WSI_WAYLAND_SUPPORT | Linux | `ON` | Build the components with Wayland support. |
195 | USE_CCACHE | Linux | `OFF` | Enable caching with the CCache program. |
197 The following is a table of all string options currently supported by this repository:
199 | Option | Platform | Default | Description |
200 | ------ | -------- | ------- | ----------- |
201 | CMAKE_OSX_DEPLOYMENT_TARGET | MacOS | `10.12` | The minimum version of MacOS for loader deployment. |
203 These variables should be set using the `-D` option when invoking CMake to
204 generate the native platform files.
206 ## Building On Windows
208 ### Windows Development Environment Requirements
211 - Any Personal Computer version supported by Microsoft
212 - Microsoft [Visual Studio](https://www.visualstudio.com/)
214 - [2013 (update 4)](https://www.visualstudio.com/vs/older-downloads/)
215 - [2015](https://www.visualstudio.com/vs/older-downloads/)
216 - [2017](https://www.visualstudio.com/vs/downloads/)
217 - The Community Edition of each of the above versions is sufficient, as
218 well as any more capable edition.
219 - CMake: Continuous integration tools use [CMake 3.12.2](https://github.com/Kitware/CMake/releases/tag/v3.12.2) for Windows
220 - Use the installer option to add CMake to the system PATH
222 - [Git for Windows](http://git-scm.com/download/win) is a popular solution
224 - Some IDEs (e.g., [Visual Studio](https://www.visualstudio.com/),
225 [GitHub Desktop](https://desktop.github.com/)) have integrated
228 ### Windows Build - Microsoft Visual Studio
230 The general approach is to run CMake to generate the Visual Studio project
231 files. Then either run CMake with the `--build` option to build from the
232 command line or use the Visual Studio IDE to open the generated solution and
233 work with the solution interactively.
235 #### Windows Quick Start
240 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir
243 The above commands instruct CMake to find and use the default Visual Studio
244 installation to generate a Visual Studio solution and projects for the x64
245 architecture. The second CMake command builds the Debug (default)
246 configuration of the solution.
248 See below for the details.
250 #### Use `CMake` to Create the Visual Studio Project Files
252 Change your current directory to the top of the cloned repository directory,
253 create a build directory and generate the Visual Studio project files:
258 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir
260 > Note: The `..` parameter tells `cmake` the location of the top of the
261 > repository. If you place your build directory someplace else, you'll need to
262 > specify the location of the repository top differently.
264 The `-A` option is used to select either the "Win32" or "x64" architecture.
266 If a generator for a specific version of Visual Studio is required, you can
267 specify it for Visual Studio 2015, for example, with:
269 64-bit: -G "Visual Studio 14 2015 Win64"
270 32-bit: -G "Visual Studio 14 2015"
272 See this [list](#cmake-visual-studio-generators) of other possible generators
275 When generating the project files, the absolute path to a Vulkan-Headers
276 install directory must be provided. This can be done by setting the
277 `VULKAN_HEADERS_INSTALL_DIR` environment variable or by setting the
278 `VULKAN_HEADERS_INSTALL_DIR` CMake variable with the `-D` CMake option. In
279 either case, the variable should point to the installation directory of a
280 Vulkan-Headers repository built with the install target.
282 The above steps create a Windows solution file named
283 `Vulkan-Tools.sln` in the build directory.
285 At this point, you can build the solution from the command line or open the
286 generated solution with Visual Studio.
288 #### Build the Solution From the Command Line
290 While still in the build directory:
294 to build the Debug configuration (the default), or:
296 cmake --build . --config Release
298 to make a Release build.
300 #### Build the Solution With Visual Studio
302 Launch Visual Studio and open the "Vulkan-Tools.sln" solution file in the
303 build folder. You may select "Debug" or "Release" from the Solution
304 Configurations drop-down list. Start a build by selecting the Build->Build
307 #### Windows Install Target
309 The CMake project also generates an "install" target that you can use to copy
310 the primary build artifacts to a specific location using a "bin, include, lib"
311 style directory structure. This may be useful for collecting the artifacts and
312 providing them to another project that is dependent on them.
314 The default location is `$CMAKE_BINARY_DIR\install`, but can be changed with
315 the `CMAKE_INSTALL_PREFIX` variable when first generating the project build
318 You can build the install target from the command line with:
320 cmake --build . --config Release --target install
322 or build the `INSTALL` target from the Visual Studio solution explorer.
324 #### Using a Loader Built from a Repository
326 If you do need to build and use your own loader, build the Vulkan-Loader
327 repository with the install target and modify your CMake invocation to add the
328 location of the loader's install directory:
330 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
331 -DVULKAN_LOADER_INSTALL_DIR=absolute_path_to_install_dir ..
333 #### Using glslang Built from a Repository
335 If you do need to build and use your own glslang, build the glslang repository
336 with the install target and modify your CMake invocation to add the location
337 of the glslang's install directory:
339 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
340 -DGLSLANG_INSTALL_DIR=absolute_path_to_install_dir ..
344 #### CMake Visual Studio Generators
346 The chosen generator should match one of the Visual Studio versions that you
347 have installed. Generator strings that correspond to versions of Visual Studio
350 | Build Platform | 64-bit Generator | 32-bit Generator |
351 |------------------------------|-------------------------------|-------------------------|
352 | Microsoft Visual Studio 2013 | "Visual Studio 12 2013 Win64" | "Visual Studio 12 2013" |
353 | Microsoft Visual Studio 2015 | "Visual Studio 14 2015 Win64" | "Visual Studio 14 2015" |
354 | Microsoft Visual Studio 2017 | "Visual Studio 15 2017 Win64" | "Visual Studio 15 2017" |
358 ### Linux Build Requirements
360 This repository has been built and tested on the two most recent Ubuntu LTS
361 versions. Currently, the oldest supported version is Ubuntu 14.04, meaning
362 that the minimum supported compiler versions are GCC 4.8.2 and Clang 3.4,
363 although earlier versions may work. It should be straightforward to adapt this
364 repository to other Linux distributions.
366 The continuous integration tools use [CMake 3.12.4](https://github.com/Kitware/CMake/releases/tag/v3.12.4) for Linux
368 #### Required Package List
370 sudo apt-get install git cmake build-essential libx11-xcb-dev \
371 libxkbcommon-dev libwayland-dev libxrandr-dev
375 The general approach is to run CMake to generate make files. Then either run
376 CMake with the `--build` option or `make` to build from the command line.
378 #### Linux Quick Start
383 cmake -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir ..
386 See below for the details.
388 #### Use CMake to Create the Make Files
390 Change your current directory to the top of the cloned repository directory,
391 create a build directory and generate the make files.
396 cmake -DCMAKE_BUILD_TYPE=Debug \
397 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
398 -DCMAKE_INSTALL_PREFIX=install ..
400 > Note: The `..` parameter tells `cmake` the location of the top of the
401 > repository. If you place your `build` directory someplace else, you'll need
402 > to specify the location of the repository top differently.
404 Use `-DCMAKE_BUILD_TYPE` to specify a Debug or Release build.
406 When generating the project files, the absolute path to a Vulkan-Headers
407 install directory must be provided. This can be done by setting the
408 `VULKAN_HEADERS_INSTALL_DIR` environment variable or by setting the
409 `VULKAN_HEADERS_INSTALL_DIR` CMake variable with the `-D` CMake option. In
410 either case, the variable should point to the installation directory of a
411 Vulkan-Headers repository built with the install target.
413 > Note: For Linux, the default value for `CMAKE_INSTALL_PREFIX` is
414 > `/usr/local`, which would be used if you do not specify
415 > `CMAKE_INSTALL_PREFIX`. In this case, you may need to use `sudo` to install
416 > to system directories later when you run `make install`.
418 #### Build the Project
420 You can just run `make` to begin the build.
422 To speed up the build on a multi-core machine, use the `-j` option for `make`
423 to specify the number of cores to use for the build. For example:
431 If your build system supports ccache, you can enable that via CMake option `-DUSE_CCACHE=On`
435 #### WSI Support Build Options
437 By default, the repository components are built with support for the
438 Vulkan-defined WSI display servers: Xcb, Xlib, and Wayland. It is recommended
439 to build the repository components with support for these display servers to
440 maximize their usability across Linux platforms. If it is necessary to build
441 these modules without support for one of the display servers, the appropriate
442 CMake option of the form `BUILD_WSI_xxx_SUPPORT` can be set to `OFF`.
444 Note vulkaninfo currently only supports Xcb and Xlib WSI display servers. See
445 the CMakeLists.txt file in `Vulkan-Tools/vulkaninfo` for more info.
447 You can select which WSI subsystem is used to execute the vkcube applications
448 using a CMake option called DEMOS_WSI_SELECTION. Supported options are XCB
449 (default), XLIB, and WAYLAND. Note that you must build using the corresponding
450 BUILD_WSI_*_SUPPORT enabled at the base repository level. For instance,
451 creating a build that will use Xlib when running the vkcube demos, your CMake
452 command line might look like:
454 cmake -DCMAKE_BUILD_TYPE=Debug -DDEMOS_WSI_SELECTION=XLIB ..
456 #### Linux Install to System Directories
458 Installing the files resulting from your build to the systems directories is
459 optional since environment variables can usually be used instead to locate the
460 binaries. There are also risks with interfering with binaries installed by
461 packages. If you are certain that you would like to install your binaries to
462 system directories, you can proceed with these instructions.
464 Assuming that you've built the code as described above and the current
465 directory is still `build`, you can execute:
469 This command installs files to `/usr/local` if no `CMAKE_INSTALL_PREFIX` is
470 specified when creating the build files with CMake.
472 You may need to run `ldconfig` in order to refresh the system loader search
473 cache on some Linux systems.
475 You can further customize the installation location by setting additional
476 CMake variables to override their defaults. For example, if you would like to
477 install to `/tmp/build` instead of `/usr/local`, on your CMake command line
480 -DCMAKE_INSTALL_PREFIX=/tmp/build
482 Then run `make install` as before. The install step places the files in
483 `/tmp/build`. This may be useful for collecting the artifacts and providing
484 them to another project that is dependent on them.
486 Note: The Mock ICD is not installed by default since it is a "null" driver
487 that does not render anything and is used for testing purposes. Installing it
488 to system directories may cause some applications to discover and use this
489 driver instead of other full drivers installed on the system. If you really
490 want to install this null driver, use:
494 See the CMake documentation for more details on using these variables to
495 further customize your installation.
497 Also see the `LoaderAndLayerInterface` document in the `loader` folder of the
498 Vulkan-Loader repository for more information about loader and layer
503 To uninstall the files from the system directories, you can execute:
509 After making any changes to the repository, you should perform some quick
510 sanity tests, such as running the vkcube demo with validation enabled.
512 To run the **vkcube application** with validation, in a terminal change to the
513 `build/cube` directory and run:
515 VK_LAYER_PATH=../path/to/validation/layers ./vkcube --validate
517 If you have an SDK installed and have run the setup script to set the
518 `VULKAN_SDK` environment variable, it may be unnecessary to specify a
521 #### Linux 32-bit support
523 Usage of the contents of this repository in 32-bit Linux environments is not
524 officially supported. However, since this repository is supported on 32-bit
525 Windows, these modules should generally work on 32-bit Linux.
527 Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference"
530 If not already installed, install the following 32-bit development libraries:
532 `gcc-multilib g++-multilib libx11-dev:i386`
534 This list may vary depending on your distribution and which windowing systems
535 you are building for.
537 Set up your environment for building 32-bit targets:
542 export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
544 Again, your PKG_CONFIG configuration may be different, depending on your
547 Finally, rebuild the repository using `cmake` and `make`, as explained above.
549 ## Building On Android
551 Install the required tools for Linux and Windows covered above, then add the
554 ### Android Build Requirements
556 - Install [Android Studio 2.3](https://developer.android.com/studio/index.html) or later.
557 - From the "Welcome to Android Studio" splash screen, add the following components using
558 Configure > SDK Manager:
559 - SDK Platforms > Android 6.0 and newer
560 - SDK Tools > Android SDK Build-Tools
561 - SDK Tools > Android SDK Platform-Tools
562 - SDK Tools > Android SDK Tools
565 #### Add Android specifics to environment
567 For each of the below, you may need to specify a different build-tools
568 version, as Android Studio will roll it forward fairly regularly.
572 export ANDROID_SDK_HOME=$HOME/Android/sdk
573 export ANDROID_NDK_HOME=$HOME/Android/sdk/ndk-bundle
574 export PATH=$ANDROID_SDK_HOME:$PATH
575 export PATH=$ANDROID_NDK_HOME:$PATH
576 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
580 set ANDROID_SDK_HOME=%LOCALAPPDATA%\Android\sdk
581 set ANDROID_NDK_HOME=%LOCALAPPDATA%\Android\sdk\ndk-bundle
582 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
586 export ANDROID_SDK_HOME=$HOME/Library/Android/sdk
587 export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk-bundle
588 export PATH=$ANDROID_NDK_PATH:$PATH
589 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
591 Note: If `jarsigner` is missing from your platform, you can find it in the
592 Android Studio install or in your Java installation. If you do not have Java,
593 you can get it with something like the following:
595 sudo apt-get install openjdk-8-jdk
597 #### Additional OSX System Requirements
599 Tested on OSX version 10.13.3
601 Setup Homebrew and components
603 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
605 /usr/bin/ruby -e "$(curl -fsSL \
606 https://raw.githubusercontent.com/Homebrew/install/master/install)"
608 - Ensure Homebrew is at the beginning of your PATH:
610 export PATH=/usr/local/bin:$PATH
612 - Add packages with the following:
614 brew install cmake python
618 There are two options for building the Android tools. Either using the SPIRV
619 tools provided as part of the Android NDK, or using upstream sources. To build
620 with SPIRV tools from the NDK, remove the build-android/third_party directory
621 created by running update_external_sources_android.sh, (or avoid running
622 update_external_sources_android.sh). Use the following script to build
623 everything in the repository for Android, including validation layers, tests,
624 demos, and APK packaging: This script does retrieve and use the upstream SPRIV
630 Test and application APKs can be installed on production devices with:
632 ./install_all.sh [-s <serial number>]
634 Note that there are no equivalent scripts on Windows yet, that work needs to
635 be completed. The following per platform commands can be used for layer only
640 Follow the setup steps for Linux or OSX above, then from your terminal:
643 ./update_external_sources_android.sh --no-build
644 ./android-generate.sh
649 Follow the setup steps for Windows above, then from Developer Command Prompt
653 update_external_sources_android.bat
657 ### Android Tests and Demos
659 After making any changes to the repository you should perform some quick
660 sanity tests, including the layer validation tests and the vkcube
661 demo with validation enabled.
663 #### Run Layer Validation Tests
665 Use the following steps to build, install, and run the layer validation tests
670 adb install -r bin/VulkanLayerValidationTests.apk
671 adb shell am start com.example.VulkanLayerValidationTests/android.app.NativeActivity
673 Alternatively, you can use the test_APK script to install and run the layer
676 test_APK.sh -s <serial number> -p <platform name> -f <gtest_filter>
678 #### Run vkcube with Validation
680 TODO: This must be reworked to pull in layers from the ValidationLayers repo
682 Use the following steps to build, install, and run vkcube for Android:
686 adb install -r ../demos/android/cube/bin/vkcube.apk
687 adb shell am start com.example.Cube/android.app.NativeActivity
689 To build, install, and run Cube with validation layers,
690 first build layers using steps above, then run:
694 adb install -r ../demos/android/cube-with-layers/bin/cube-with-layers.apk
696 ##### Run without validation enabled
698 adb shell am start com.example.CubeWithLayers/android.app.NativeActivity
700 ##### Run with validation enabled
702 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
706 ### MacOS Build Requirements
708 Tested on OSX version 10.12.6
710 The continuous integration tools use [CMake 3.11.3](https://github.com/Kitware/CMake/releases/tag/v3.11.3) for MacOS
712 Setup Homebrew and components
714 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
716 /usr/bin/ruby -e "$(curl -fsSL \
717 https://raw.githubusercontent.com/Homebrew/install/master/install)"
719 - Ensure Homebrew is at the beginning of your PATH:
721 export PATH=/usr/local/bin:$PATH
723 - Add packages with the following (may need refinement)
725 brew install cmake python python3 git
727 ### Clone the Repository
729 Clone the Vulkan-Tools repository as defined above in the [Download the Repository](#download-the-repository)
732 ### Get the External Libraries
734 [MoltenVK](https://github.com/KhronosGroup/MoltenVK) Library
736 - Building the vkcube and vulkaninfo applications require linking to the
737 MoltenVK Library (libMoltenVK.dylib)
738 - The following option should be used on the cmake command line to specify a
739 vulkan loader library: MOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK
740 making sure to specify an absolute path, like so: cmake
741 -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK ....
743 Vulkan Loader Library
745 - Building the vkcube and vulkaninfo applications require linking to the Vulkan
746 Loader Library (libvulkan.1.dylib)
747 - The following option should be used on the cmake command line to specify a
748 vulkan loader library:
749 VULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir
750 making sure to specify an absolute path.
754 #### CMake Generators
756 This repository uses CMake to generate build or project files that are then
757 used to build the repository. The CMake generators explicitly supported in
763 #### Building with the Unix Makefiles Generator
765 This generator is the default generator, so all that is needed for a debug
770 cmake -DCMAKE_BUILD_TYPE=Debug \
771 -DVULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir \
772 -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK \
773 -DCMAKE_INSTALL_PREFIX=install ..
776 To speed up the build on a multi-core machine, use the `-j` option for `make`
777 to specify the number of cores to use for the build. For example:
781 You can now run the demo applications from the command line:
784 open cube/vkcubepp.app
785 open vulkaninfo/vulkaninfo.app
787 Or you can locate them from `Finder` and launch them from there.
789 ##### The Install Target and RPATH
791 The applications you just built are "bundled applications", but the
792 executables are using the `RPATH` mechanism to locate runtime dependencies
793 that are still in your build tree.
795 To see this, run this command from your `build` directory:
797 otool -l cube/cube.app/Contents/MacOS/vkcube
799 and note that the `vkcube` executable contains loader commands:
801 - `LC_LOAD_DYLIB` to load `libvulkan.1.dylib` via an `@rpath`
802 - `LC_RPATH` that contains an absolute path to the build location of the Vulkan loader
804 This makes the bundled application "non-transportable", meaning that it won't
805 run unless the Vulkan loader is on that specific absolute path. This is useful
806 for debugging the loader or other components built in this repository, but not
807 if you want to move the application to another machine or remove your build
810 To address this problem, run:
814 This step copies the bundled applications to the location specified by
815 CMAKE_INSTALL_PREFIX and "cleans up" the `RPATH` to remove any external
816 references and performs other bundle fix-ups. After running `make install`,
817 run the `otool` command again from the `build/install` directory and note:
819 - `LC_LOAD_DYLIB` is now `@executable_path/../MacOS/libvulkan.1.dylib`
820 - `LC_RPATH` is no longer present
822 The "bundle fix-up" operation also puts a copy of the Vulkan loader into the
823 bundle, making the bundle completely self-contained and self-referencing.
825 ##### The Non-bundled vulkaninfo Application
827 There is also a non-bundled version of the `vulkaninfo` application that you
828 can run from the command line:
830 vulkaninfo/vulkaninfo
832 If you run this from the build directory, vulkaninfo's RPATH is already
833 set to point to the Vulkan loader in the build tree, so it has no trouble
834 finding it. But the loader will not find the MoltenVK driver and you'll see a
835 message about an incompatible driver. To remedy this:
837 VK_ICD_FILENAMES=<path-to>/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json vulkaninfo/vulkaninfo
839 If you run `vulkaninfo` from the install directory, the `RPATH` in the
840 `vulkaninfo` application got removed and the OS needs extra help to locate
843 DYLD_LIBRARY_PATH=<path-to>/Vulkan-Loader/loader VK_ICD_FILENAMES=<path-to>/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json vulkaninfo/vulkaninfo
845 #### Building with the Xcode Generator
847 To create and open an Xcode project:
851 cmake -DVULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK -GXcode ..
852 open VULKAN.xcodeproj
854 Within Xcode, you can select Debug or Release builds in the project's Build
855 Settings. You can also select individual schemes for working with specific
856 applications like `vkcube`.