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