1*8975f5c5SAndroid Build Coastguard Worker<!-- 2*8975f5c5SAndroid Build Coastguard WorkerCopyright 2018-2023 The Khronos Group Inc. 3*8975f5c5SAndroid Build Coastguard Worker 4*8975f5c5SAndroid Build Coastguard WorkerSPDX-License-Identifier: Apache-2.0 5*8975f5c5SAndroid Build Coastguard Worker--> 6*8975f5c5SAndroid Build Coastguard Worker 7*8975f5c5SAndroid Build Coastguard Worker# Build Instructions 8*8975f5c5SAndroid Build Coastguard Worker 9*8975f5c5SAndroid Build Coastguard WorkerInstructions for building this repository. 10*8975f5c5SAndroid Build Coastguard Worker 11*8975f5c5SAndroid Build Coastguard Worker```bash 12*8975f5c5SAndroid Build Coastguard Workergit clone https://github.com/KhronosGroup/Vulkan-Headers.git 13*8975f5c5SAndroid Build Coastguard Worker 14*8975f5c5SAndroid Build Coastguard Workercd Vulkan-Headers/ 15*8975f5c5SAndroid Build Coastguard Worker 16*8975f5c5SAndroid Build Coastguard Worker# Configure the project 17*8975f5c5SAndroid Build Coastguard Workercmake -S . -B build/ 18*8975f5c5SAndroid Build Coastguard Worker 19*8975f5c5SAndroid Build Coastguard Worker# Because Vulkan-Headers is header only we don't need to build anything. 20*8975f5c5SAndroid Build Coastguard Worker# Users can install it where they need to. 21*8975f5c5SAndroid Build Coastguard Workercmake --install build --prefix build/install 22*8975f5c5SAndroid Build Coastguard Worker``` 23*8975f5c5SAndroid Build Coastguard Worker 24*8975f5c5SAndroid Build Coastguard WorkerSee the official [CMake documentation](https://cmake.org/cmake/help/latest/index.html) for more information. 25*8975f5c5SAndroid Build Coastguard Worker 26*8975f5c5SAndroid Build Coastguard Worker## Installed Files 27*8975f5c5SAndroid Build Coastguard Worker 28*8975f5c5SAndroid Build Coastguard WorkerThe `install` target installs the following files under the directory 29*8975f5c5SAndroid Build Coastguard Workerindicated by *install_dir*: 30*8975f5c5SAndroid Build Coastguard Worker 31*8975f5c5SAndroid Build Coastguard Worker- *install_dir*`/include/vulkan` : The header files found in the 32*8975f5c5SAndroid Build Coastguard Worker `include/vulkan` directory of this repository 33*8975f5c5SAndroid Build Coastguard Worker- *install_dir*`/share/cmake/VulkanHeaders`: The CMake config files needed 34*8975f5c5SAndroid Build Coastguard Worker for find_package support 35*8975f5c5SAndroid Build Coastguard Worker- *install_dir*`/share/vulkan/registry` : The registry files found in the 36*8975f5c5SAndroid Build Coastguard Worker `registry` directory of this repository 37*8975f5c5SAndroid Build Coastguard Worker 38*8975f5c5SAndroid Build Coastguard Worker## Usage in CMake 39*8975f5c5SAndroid Build Coastguard Worker 40*8975f5c5SAndroid Build Coastguard Worker```cmake 41*8975f5c5SAndroid Build Coastguard Workerfind_package(VulkanHeaders REQUIRED CONFIG) 42*8975f5c5SAndroid Build Coastguard Worker 43*8975f5c5SAndroid Build Coastguard Workertarget_link_libraries(foobar PRIVATE Vulkan::Headers) 44*8975f5c5SAndroid Build Coastguard Worker 45*8975f5c5SAndroid Build Coastguard Workermessage(STATUS "Vulkan Headers Version: ${VulkanHeaders_VERSION}") 46*8975f5c5SAndroid Build Coastguard Worker``` 47