Lines Matching full:build
1 # Build Instructions
11 1. [Windows Build](#building-on-windows)
12 1. [Linux Build](#building-on-linux)
13 1. [Android Build](#building-on-android)
14 1. [MacOS build](#building-on-macos)
25 This repository contains the source code necessary to build the Vulkan
72 You must clone the headers repository and build its `install` target before
74 contains the Vulkan API definition files (registry) that are required to build
84 required to build the validation layers. You must clone the glslang repository
85 and build its `install` target. Follow the build instructions in the glslang
96 framework and do not build unless this framework is downloaded into the
106 before configuring your build with CMake.
120 to use a loader built from a repository, then you must build the
127 ### Build and Install Directories
129 A common convention is to place the build directory in the top directory of
130 the repository with a name of `build` and place the install directory as a
131 child of the build directory with the name `install`. The remainder of these
138 to gather and build the dependent repositories mentioned above. This program
147 mkdir build
148 cd build
151 cmake --build .
159 the `build` directory.
160 - The `build` directory is also being used to build this
162 inside the `build` directory between the dependent repositories and the
163 build files for this repository.
168 it in the same directory as the dependent repositories (`build` in this
172 variables when you generate your build files with CMake. This lets you avoid
181 ### Build Options
183 When generating native platform build files through CMake, several options can
184 be specified to customize the build. Some of the options are binary on/off
194 | BUILD_WSI_XCB_SUPPORT | Linux | `ON` | Build the components with XCB support. |
195 | BUILD_WSI_XLIB_SUPPORT | Linux | `ON` | Build the components with Xlib support. |
196 | BUILD_WSI_WAYLAND_SUPPORT | Linux | `ON` | Build the components with Wayland support. |
230 ### Windows Build - Microsoft Visual Studio
233 files. Then either run CMake with the `--build` option to build from the
240 mkdir build
241 cd build
244 cmake --build .
256 create a build directory and generate the Visual Studio project files:
259 mkdir build
260 cd build
265 > repository. If you place your build directory someplace else, you'll need to
294 `Vulkan-ValidationLayers.sln` in the build directory.
296 At this point, you can build the solution from the command line or open the
299 #### Build the Solution From the Command Line
301 While still in the build directory:
303 cmake --build .
305 to build the Debug configuration (the default), or:
307 cmake --build . --config Release
309 to make a Release build.
311 #### Build the Solution With Visual Studio
314 in the build folder. You may select "Debug" or "Release" from the Solution
315 Configurations drop-down list. Start a build by selecting the Build->Build
321 the primary build artifacts to a specific location using a "bin, include, lib"
326 the `CMAKE_INSTALL_PREFIX` variable when first generating the project build
329 You can build the install target from the command line with:
331 cmake --build . --config Release --target install
333 or build the `INSTALL` target from the Visual Studio solution explorer.
337 If you do need to build and use your own loader, build the Vulkan-Loader
354 build/tests directory, and run:
377 | Build Platform | 64-bit Generator | 32-bit Generator |
391 `build\tests\Debug` or the `build\tests\Release` directory, which is where the
397 ### Linux Build Requirements
407 sudo apt-get install git cmake build-essential libx11-xcb-dev \
411 ### Linux Build
414 CMake with the `--build` option or `make` to build from the command line.
419 mkdir build
420 cd build
430 create a build directory and generate the make files.
433 mkdir build
434 cd build
441 > repository. If you place your `build` directory someplace else, you'll need
444 Use `-DCMAKE_BUILD_TYPE` to specify a Debug or Release build.
465 #### Build the Project argument
467 You can just run `make` to begin the build.
469 To speed up the build on a multi-core machine, use the `-j` option for `make`
470 to specify the number of cores to use for the build. For example:
476 cmake --build .
478 If your build system supports ccache, you can enable that via CMake option `-DUSE_CCACHE=On`
482 #### WSI Support Build Options
486 to build the repository components with support for these display servers to
487 maximize their usability across Linux platforms. If it is necessary to build
493 Installing the files resulting from your build to the systems directories is
500 directory is still `build`, you can execute:
505 specified when creating the build files with CMake:
515 install to `/tmp/build` instead of `/usr/local`, on your CMake command line
518 -DCMAKE_INSTALL_PREFIX=/tmp/build
521 `/tmp/build`. This may be useful for collecting the artifacts and providing
539 To run the **validation test script**, in a terminal change to the build/tests directory and run:
576 export VK_LAYER_PATH=<path to your repository root>/build/layers
586 ### Android Build Requirements
593 - SDK Tools > Android SDK Build-Tools
600 For each of the below, you may need to specify a different build-tools
609 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
622 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
648 ### Android Build
651 tools provided as part of the Android NDK, or using upstream sources. To build
652 with SPIRV tools from the NDK, remove the build-android/third_party directory
654 update_external_sources_android.sh). Use the following script to build
659 cd build-android
662 Resulting validation layer binaries will be in build-android/libs. Test and
675 cd build-android
676 ./update_external_sources_android.sh --no-build
678 ndk-build -j4
685 cd build-android
688 ndk-build
698 Use the following steps to build, install, and run the layer validation tests
701 cd build-android
713 ### MacOS Build Requirements
737 ### MacOS build
741 This repository uses CMake to generate build or project files that are then
742 used to build the repository. The CMake generators explicitly supported in
751 build is:
753 mkdir build
754 cd build
760 To speed up the build on a multi-core machine, use the `-j` option for `make`
761 to specify the number of cores to use for the build. For example:
769 mkdir build-xcode
770 cd build-xcode
776 Within Xcode, you can select Debug or Release builds in the Build Settings of the project.
780 export VK_LAYER_PATH=<path to your repository root>/build/layers
799 Clone and build the [MoltenVK](https://github.com/KhronosGroup/MoltenVK) repository.
807 Clone and build the [Vulkan-Tools](https://github.com/KhronosGroup/Vulkan-Tools) repository.
811 export VK_ICD_FILENAMES=<path to Vulkan-Tools repository>/build/icd/VkICD_mock_icd.json
815 To run the **validation test script**, in a terminal change to the build/tests directory and run: