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.
178 ### Generated source code
180 This repository contains generated source code in the `icd/generated`
181 directory which is not intended to be modified directly. Instead, changes should be
182 made to the corresponding generator in the `scripts` directory. The source files can
183 then be regenerated using `scripts/generate_source.py`:
185 python3 scripts/generate_source.py PATH_TO_VULKAN_HEADERS_REGISTRY_DIR
187 A helper CMake target `VulkanTools_generated_source` is also provided to simplify
188 the invocation of `scripts/generate_source.py` from the build directory:
190 cmake --build . --target VulkanTools_generated_source
194 When generating native platform build files through CMake, several options can
195 be specified to customize the build. Some of the options are binary on/off
196 options, while others take a string as input. The following is a table of all
197 on/off options currently supported by this repository:
199 | Option | Platform | Default | Description |
200 | ------ | -------- | ------- | ----------- |
201 | BUILD_CUBE | All | `ON` | Controls whether or not the vkcube demo is built. |
202 | BUILD_VULKANINFO | All | `ON` | Controls whether or not the vulkaninfo utility is built. |
203 | BUILD_ICD | All | `ON` | Controls whether or not the mock ICD is built. |
204 | INSTALL_ICD | All | `OFF` | Controls whether or not the mock ICD is installed as part of the install target. |
205 | BUILD_WSI_XCB_SUPPORT | Linux | `ON` | Build the components with XCB support. |
206 | BUILD_WSI_XLIB_SUPPORT | Linux | `ON` | Build the components with Xlib support. |
207 | BUILD_WSI_WAYLAND_SUPPORT | Linux | `ON` | Build the components with Wayland support. |
208 | BUILD_WSI_DIRECTFB_SUPPORT | Linux | `OFF` | Build the components with DirectFB support. |
210 The following is a table of all string options currently supported by this repository:
212 | Option | Platform | Default | Description |
213 | ------ | -------- | ------- | ----------- |
214 | VULKANINFO_BUILD_DLL_VERSIONINFO | Windows | `""` | Set the Windows specific version information for Vulkaninfo. Format is "major.minor.patch.build". |
216 These variables should be set using the `-D` option when invoking CMake to
217 generate the native platform files.
221 There are 2 methods to enable CCACHE:
223 1.) Set environment variables
226 # Requires CMake 3.17 (https://cmake.org/cmake/help/latest/envvar/CMAKE_LANG_COMPILER_LAUNCHER.html)
227 export CMAKE_CXX_COMPILER_LAUNCHER=/usr/bin/ccache
228 export CMAKE_C_COMPILER_LAUNCHER=/usr/bin/ccache
231 2.) Pass in cache variables
234 cmake ... -D CMAKE_CXX_COMPILER_LAUNCHER=/usr/bin/ccache -D CMAKE_C_COMPILER_LAUNCHER=/usr/bin/ccache
237 ## Building On Windows
239 ### Windows Development Environment Requirements
242 - Any Personal Computer version supported by Microsoft
243 - Microsoft [Visual Studio](https://www.visualstudio.com/)
245 - [2013 (update 4)](https://www.visualstudio.com/vs/older-downloads/)
246 - [2015](https://www.visualstudio.com/vs/older-downloads/)
247 - [2017](https://www.visualstudio.com/vs/downloads/)
248 - The Community Edition of each of the above versions is sufficient, as
249 well as any more capable edition.
250 - [CMake 3.10.2](https://cmake.org/files/v3.10/cmake-3.10.2-win64-x64.zip) is recommended.
251 - Use the installer option to add CMake to the system PATH
253 - [Git for Windows](http://git-scm.com/download/win) is a popular solution
255 - Some IDEs (e.g., [Visual Studio](https://www.visualstudio.com/),
256 [GitHub Desktop](https://desktop.github.com/)) have integrated
259 ### Windows Build - Microsoft Visual Studio
261 The general approach is to run CMake to generate the Visual Studio project
262 files. Then either run CMake with the `--build` option to build from the
263 command line or use the Visual Studio IDE to open the generated solution and
264 work with the solution interactively.
266 #### Windows Quick Start
271 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir
274 The above commands instruct CMake to find and use the default Visual Studio
275 installation to generate a Visual Studio solution and projects for the x64
276 architecture. The second CMake command builds the Debug (default)
277 configuration of the solution.
279 See below for the details.
281 #### Use `CMake` to Create the Visual Studio Project Files
283 Change your current directory to the top of the cloned repository directory,
284 create a build directory and generate the Visual Studio project files:
289 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir
291 > Note: The `..` parameter tells `cmake` the location of the top of the
292 > repository. If you place your build directory someplace else, you'll need to
293 > specify the location of the repository top differently.
295 The `-A` option is used to select either the "Win32" or "x64" architecture.
297 If a generator for a specific version of Visual Studio is required, you can
298 specify it for Visual Studio 2015, for example, with:
300 64-bit: -G "Visual Studio 14 2015 Win64"
301 32-bit: -G "Visual Studio 14 2015"
303 See this [list](#cmake-visual-studio-generators) of other possible generators
306 When generating the project files, the absolute path to a Vulkan-Headers
307 install directory must be provided. This can be done by setting the
308 `VULKAN_HEADERS_INSTALL_DIR` environment variable or by setting the
309 `VULKAN_HEADERS_INSTALL_DIR` CMake variable with the `-D` CMake option. In
310 either case, the variable should point to the installation directory of a
311 Vulkan-Headers repository built with the install target.
313 The above steps create a Windows solution file named
314 `Vulkan-Tools.sln` in the build directory.
316 At this point, you can build the solution from the command line or open the
317 generated solution with Visual Studio.
319 #### Build the Solution From the Command Line
321 While still in the build directory:
325 to build the Debug configuration (the default), or:
327 cmake --build . --config Release
329 to make a Release build.
331 #### Build the Solution With Visual Studio
333 Launch Visual Studio and open the "Vulkan-Tools.sln" solution file in the
334 build folder. You may select "Debug" or "Release" from the Solution
335 Configurations drop-down list. Start a build by selecting the Build->Build
338 #### Windows Install Target
340 The CMake project also generates an "install" target that you can use to copy
341 the primary build artifacts to a specific location using a "bin, include, lib"
342 style directory structure. This may be useful for collecting the artifacts and
343 providing them to another project that is dependent on them.
345 The default location is `$CMAKE_BINARY_DIR\install`, but can be changed with
346 the `CMAKE_INSTALL_PREFIX` variable when first generating the project build
349 You can build the install target from the command line with:
351 cmake --build . --config Release --target install
353 or build the `INSTALL` target from the Visual Studio solution explorer.
355 #### Using a Loader Built from a Repository
357 If you do need to build and use your own loader, build the Vulkan-Loader
358 repository with the install target and modify your CMake invocation to add the
359 location of the loader's install directory:
361 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
362 -DVULKAN_LOADER_INSTALL_DIR=absolute_path_to_install_dir ..
364 #### Using glslang Built from a Repository
366 If you do need to build and use your own glslang, build the glslang repository
367 with the install target and modify your CMake invocation to add the location
368 of the glslang's install directory:
370 cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
371 -DGLSLANG_INSTALL_DIR=absolute_path_to_install_dir ..
375 #### CMake Visual Studio Generators
377 The chosen generator should match one of the Visual Studio versions that you
378 have installed. Generator strings that correspond to versions of Visual Studio
381 | Build Platform | 64-bit Generator | 32-bit Generator |
382 |------------------------------|-------------------------------|-------------------------|
383 | Microsoft Visual Studio 2013 | "Visual Studio 12 2013 Win64" | "Visual Studio 12 2013" |
384 | Microsoft Visual Studio 2015 | "Visual Studio 14 2015 Win64" | "Visual Studio 14 2015" |
385 | Microsoft Visual Studio 2017 | "Visual Studio 15 2017 Win64" | "Visual Studio 15 2017" |
389 ### Linux Build Requirements
391 This repository has been built and tested on the two most recent Ubuntu LTS
392 versions. Currently, the oldest supported version is Ubuntu 16.04, meaning
393 that the minimum officially supported C++11 compiler version is GCC 5.4.0,
394 although earlier versions may work. It should be straightforward to adapt this
395 repository to other Linux distributions.
397 [CMake 3.10.2](https://cmake.org/files/v3.10/cmake-3.10.2-Linux-x86_64.tar.gz) is recommended.
399 #### Required Package List
401 sudo apt-get install git cmake build-essential libx11-xcb-dev \
402 libxkbcommon-dev libwayland-dev libxrandr-dev wayland-protocols
406 The general approach is to run CMake to generate make files. Then either run
407 CMake with the `--build` option or `make` to build from the command line.
409 #### Linux Quick Start
414 cmake -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir ..
417 See below for the details.
419 #### Use CMake to Create the Make Files
421 Change your current directory to the top of the cloned repository directory,
422 create a build directory and generate the make files.
427 cmake -DCMAKE_BUILD_TYPE=Debug \
428 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
429 -DCMAKE_INSTALL_PREFIX=install ..
431 > Note: The `..` parameter tells `cmake` the location of the top of the
432 > repository. If you place your `build` directory someplace else, you'll need
433 > to specify the location of the repository top differently.
435 Use `-DCMAKE_BUILD_TYPE` to specify a Debug or Release build.
437 When generating the project files, the absolute path to a Vulkan-Headers
438 install directory must be provided. This can be done by setting the
439 `VULKAN_HEADERS_INSTALL_DIR` environment variable or by setting the
440 `VULKAN_HEADERS_INSTALL_DIR` CMake variable with the `-D` CMake option. In
441 either case, the variable should point to the installation directory of a
442 Vulkan-Headers repository built with the install target.
444 > Note: For Linux, the default value for `CMAKE_INSTALL_PREFIX` is
445 > `/usr/local`, which would be used if you do not specify
446 > `CMAKE_INSTALL_PREFIX`. In this case, you may need to use `sudo` to install
447 > to system directories later when you run `make install`.
449 #### Build the Project
451 You can just run `make` to begin the build.
453 To speed up the build on a multi-core machine, use the `-j` option for `make`
454 to specify the number of cores to use for the build. For example:
462 If your build system supports ccache, you can enable that via CMake option `-DUSE_CCACHE=On`
466 #### WSI Support Build Options
468 By default, the repository components are built with support for the
469 Vulkan-defined WSI display servers: Xcb, Xlib, and Wayland. It is recommended
470 to build the repository components with support for these display servers to
471 maximize their usability across Linux platforms. If it is necessary to build
472 these modules without support for one of the display servers, the appropriate
473 CMake option of the form `BUILD_WSI_xxx_SUPPORT` can be set to `OFF`.
475 Note vulkaninfo currently only supports Xcb and Xlib WSI display servers. See
476 the CMakeLists.txt file in `Vulkan-Tools/vulkaninfo` for more info.
478 You can select which WSI subsystem is used to execute the vkcube applications
479 using a CMake option called CUBE_WSI_SELECTION. Supported options are XCB
480 (default), XLIB, and WAYLAND. Note that you must build using the corresponding
481 BUILD_WSI_*_SUPPORT enabled at the base repository level. For instance,
482 creating a build that will use Xlib when running the vkcube demos, your CMake
483 command line might look like:
485 cmake -DCMAKE_BUILD_TYPE=Debug -DCUBE_WSI_SELECTION=XLIB ..
487 #### Linux Install to System Directories
489 Installing the files resulting from your build to the systems directories is
490 optional since environment variables can usually be used instead to locate the
491 binaries. There are also risks with interfering with binaries installed by
492 packages. If you are certain that you would like to install your binaries to
493 system directories, you can proceed with these instructions.
495 Assuming that you've built the code as described above and the current
496 directory is still `build`, you can execute:
500 This command installs files to `/usr/local` if no `CMAKE_INSTALL_PREFIX` is
501 specified when creating the build files with CMake.
503 You may need to run `ldconfig` in order to refresh the system loader search
504 cache on some Linux systems.
506 You can further customize the installation location by setting additional
507 CMake variables to override their defaults. For example, if you would like to
508 install to `/tmp/build` instead of `/usr/local`, on your CMake command line
511 -DCMAKE_INSTALL_PREFIX=/tmp/build
513 Then run `make install` as before. The install step places the files in
514 `/tmp/build`. This may be useful for collecting the artifacts and providing
515 them to another project that is dependent on them.
517 Note: The Mock ICD is not installed by default since it is a "null" driver
518 that does not render anything and is used for testing purposes. Installing it
519 to system directories may cause some applications to discover and use this
520 driver instead of other full drivers installed on the system. If you really
521 want to install this null driver, use:
525 See the CMake documentation for more details on using these variables to
526 further customize your installation.
528 Also see the `LoaderAndLayerInterface` document in the `loader` folder of the
529 Vulkan-Loader repository for more information about loader and layer
534 To uninstall the files from the system directories, you can execute:
540 After making any changes to the repository, you should perform some quick
541 sanity tests, such as running the vkcube demo with validation enabled.
543 To run the **vkcube application** with validation, in a terminal change to the
544 `build/cube` directory and run:
546 VK_LAYER_PATH=../path/to/validation/layers ./vkcube --validate
548 If you have an SDK installed and have run the setup script to set the
549 `VULKAN_SDK` environment variable, it may be unnecessary to specify a
552 #### Linux 32-bit support
554 Usage of the contents of this repository in 32-bit Linux environments is not
555 officially supported. However, since this repository is supported on 32-bit
556 Windows, these modules should generally work on 32-bit Linux.
558 Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference"
561 If not already installed, install the following 32-bit development libraries:
563 `gcc-multilib g++-multilib libx11-dev:i386`
565 This list may vary depending on your distribution and which windowing systems
566 you are building for.
568 Set up your environment for building 32-bit targets:
573 export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
575 Again, your PKG_CONFIG configuration may be different, depending on your
578 Finally, rebuild the repository using `cmake` and `make`, as explained above.
580 ## Building On Android
582 Install the required tools for Linux and Windows covered above, then add the
585 ### Android Build Requirements
587 - Install [Android Studio 2.3](https://developer.android.com/studio/index.html) or later.
588 - From the "Welcome to Android Studio" splash screen, add the following components using
589 Configure > SDK Manager:
590 - SDK Platforms > Android 6.0 and newer
591 - SDK Tools > Android SDK Build-Tools
592 - SDK Tools > Android SDK Platform-Tools
593 - SDK Tools > NDK (Side by side)
595 #### Add Android specifics to environment
597 For each of the below, you may need to specify a different build-tools and ndk
598 versions, as Android Studio will roll them forward fairly regularly.
602 export ANDROID_SDK_HOME=$HOME/Android/sdk
603 export ANDROID_NDK_HOME=$HOME/Android/sdk/ndk/23.0.7599858
604 export PATH=$ANDROID_NDK_HOME:$PATH
605 export PATH=$ANDROID_SDK_HOME/platform-tools:$PATH
606 export PATH=$ANDROID_SDK_HOME/build-tools/31.0.0:$PATH
610 set ANDROID_SDK_HOME=%LOCALAPPDATA%\Android\sdk
611 set ANDROID_NDK_HOME=%LOCALAPPDATA%\Android\sdk\ndk\23.0.7599858
612 set PATH=%ANDROID_NDK_HOME%;%PATH%
613 set PATH=%ANDROID_SDK_HOME%\platform-tools;%PATH%
614 set PATH=%ANDROID_SDK_HOME%\build-tools\31.0.0;%PATH%
618 export ANDROID_SDK_HOME=$HOME/Library/Android/sdk
619 export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk/23.0.7599858
620 export PATH=$ANDROID_NDK_PATH:$PATH
621 export PATH=$ANDROID_SDK_HOME/platform-tools:$PATH
622 export PATH=$ANDROID_SDK_HOME/build-tools/31.0.0:$PATH
624 Note: If `jarsigner` is missing from your platform, you can find it in the
625 Android Studio install or in your Java installation. If you do not have Java,
626 you can get it with something like the following:
628 sudo apt-get install openjdk-8-jdk
632 Use the following script to build the vkcube demo for Android:
637 The APK can be installed on production devices with:
639 ./install_all.sh [-s <serial number>]
641 Note that there are no equivalent scripts on Windows yet, that work needs to
646 Use the following command to run vkcube for Android:
648 adb shell am start com.example.VkCube/android.app.NativeActivity
652 ### MacOS Build Requirements
654 Tested on OSX version 10.12
656 NOTE: To force the OSX version set the environment variable [MACOSX_DEPLOYMENT_TARGET](https://cmake.org/cmake/help/latest/envvar/MACOSX_DEPLOYMENT_TARGET.html) when building VVL and it's dependencies.
658 Setup Homebrew and components
660 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
662 /usr/bin/ruby -e "$(curl -fsSL \
663 https://raw.githubusercontent.com/Homebrew/install/master/install)"
665 - Ensure Homebrew is at the beginning of your PATH:
667 export PATH=/usr/local/bin:$PATH
669 - Add packages with the following (may need refinement)
671 brew install python python3 git
673 ### Clone the Repository
675 Clone the Vulkan-Tools repository as defined above in the [Download the Repository](#download-the-repository)
678 ### Get the External Libraries
680 [MoltenVK](https://github.com/KhronosGroup/MoltenVK) Library
682 - Building the vkcube and vulkaninfo applications require linking to the
683 MoltenVK Library (libMoltenVK.dylib)
684 - The following option should be used on the cmake command line to specify a
685 vulkan loader library: MOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK
686 making sure to specify an absolute path, like so: cmake
687 -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK ....
689 Vulkan Loader Library
691 - Building the vkcube and vulkaninfo applications require linking to the Vulkan
692 Loader Library (libvulkan.1.dylib)
693 - The following option should be used on the cmake command line to specify a
694 vulkan loader library:
695 VULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir
696 making sure to specify an absolute path.
700 #### CMake Generators
702 This repository uses CMake to generate build or project files that are then
703 used to build the repository. The CMake generators explicitly supported in
709 #### Building with the Unix Makefiles Generator
711 This generator is the default generator, so all that is needed for a debug
716 cmake -DCMAKE_BUILD_TYPE=Debug \
717 -DVULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir \
718 -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK \
719 -DCMAKE_INSTALL_PREFIX=install ..
722 To speed up the build on a multi-core machine, use the `-j` option for `make`
723 to specify the number of cores to use for the build. For example:
727 You can now run the demo applications from the command line:
730 open cube/vkcubepp.app
731 open vulkaninfo/vulkaninfo.app
733 Or you can locate them from `Finder` and launch them from there.
735 ##### The Install Target and RPATH
737 The applications you just built are "bundled applications", but the
738 executables are using the `RPATH` mechanism to locate runtime dependencies
739 that are still in your build tree.
741 To see this, run this command from your `build` directory:
743 otool -l cube/cube.app/Contents/MacOS/vkcube
745 and note that the `vkcube` executable contains loader commands:
747 - `LC_LOAD_DYLIB` to load `libvulkan.1.dylib` via an `@rpath`
748 - `LC_RPATH` that contains an absolute path to the build location of the Vulkan loader
750 This makes the bundled application "non-transportable", meaning that it won't
751 run unless the Vulkan loader is on that specific absolute path. This is useful
752 for debugging the loader or other components built in this repository, but not
753 if you want to move the application to another machine or remove your build
756 To address this problem, run:
760 This step copies the bundled applications to the location specified by
761 CMAKE_INSTALL_PREFIX and "cleans up" the `RPATH` to remove any external
762 references and performs other bundle fix-ups. After running `make install`,
763 run the `otool` command again from the `build/install` directory and note:
765 - `LC_LOAD_DYLIB` is now `@executable_path/../MacOS/libvulkan.1.dylib`
766 - `LC_RPATH` is no longer present
768 The "bundle fix-up" operation also puts a copy of the Vulkan loader into the
769 bundle, making the bundle completely self-contained and self-referencing.
771 ##### The Non-bundled vulkaninfo Application
773 There is also a non-bundled version of the `vulkaninfo` application that you
774 can run from the command line:
776 vulkaninfo/vulkaninfo
778 If you run this from the build directory, vulkaninfo's RPATH is already
779 set to point to the Vulkan loader in the build tree, so it has no trouble
780 finding it. But the loader will not find the MoltenVK driver and you'll see a
781 message about an incompatible driver. To remedy this:
783 VK_ICD_FILENAMES=<path-to>/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json vulkaninfo/vulkaninfo
785 If you run `vulkaninfo` from the install directory, the `RPATH` in the
786 `vulkaninfo` application got removed and the OS needs extra help to locate
789 DYLD_LIBRARY_PATH=<path-to>/Vulkan-Loader/loader VK_ICD_FILENAMES=<path-to>/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json vulkaninfo/vulkaninfo
791 #### Building with the Xcode Generator
793 To create and open an Xcode project:
797 cmake -DVULKAN_LOADER_INSTALL_DIR=/absolute_path_to/Vulkan-Loader_install_dir -DMOLTENVK_REPO_ROOT=/absolute_path_to/MoltenVK -GXcode ..
798 open VULKAN.xcodeproj
800 Within Xcode, you can select Debug or Release builds in the project's Build
801 Settings. You can also select individual schemes for working with specific
802 applications like `vkcube`.