• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Build Instructions
2
3Instructions for building this repository.
4
5```bash
6git clone https://github.com/KhronosGroup/Vulkan-Headers.git
7
8cd Vulkan-Headers/
9
10# Configure the project
11cmake -S . -B build/
12
13# Because Vulkan-Headers is header only we don't need to build anything.
14# Users can install it where they need to.
15cmake --install build --prefix build/install
16```
17
18See the official [CMake documentation](https://cmake.org/cmake/help/latest/index.html) for more information.
19
20## Installed Files
21
22The `install` target installs the following files under the directory
23indicated by *install_dir*:
24
25- *install_dir*`/include/vulkan` : The header files found in the
26 `include/vulkan` directory of this repository
27- *install_dir*`/share/cmake/VulkanHeaders`: The CMake config files needed
28  for find_package support
29- *install_dir*`/share/vulkan/registry` : The registry files found in the
30  `registry` directory of this repository
31
32## Usage in CMake
33
34```cmake
35find_package(VulkanHeaders REQUIRED CONFIG)
36
37target_link_libraries(foobar PRIVATE Vulkan::Headers)
38
39message(STATUS "Vulkan Headers Registry: ${VULKAN_HEADERS_REGISTRY_DIRECTORY}")
40
41message(STATUS "Vulkan Headers Version: ${VulkanHeaders_VERSION}")
42```
43