third_party_vulkan-headers/BUILD.md
andrew0229 35e74be546 update vulkan headers v1.3.275
Signed-off-by: andrew0229 <zhangzhao62@huawei.com>
Change-Id: Iea9dae9f174999d70e16290430669ed16181a54d
2024-05-21 10:34:44 +00:00

47 lines
1.2 KiB
Markdown

<!--
Copyright 2018-2023 The Khronos Group Inc.
SPDX-License-Identifier: Apache-2.0
-->
# 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 Version: ${VulkanHeaders_VERSION}")
```