commit | 482af6d865a925911eefa84f8ea9d9170f5168ad | [log] [tgz] |
---|---|---|
author | Juan Ramos <juan@lunarg.com> | Wed Jul 05 15:16:20 2023 -0600 |
committer | Juan Ramos <114601453+juan-lunarg@users.noreply.github.com> | Wed Jul 05 15:22:17 2023 -0600 |
tree | 7f816ef390aebcf8839fc9097c7f1434b2c35d46 | |
parent | 6f34ca5a370c3664c02abdfc9b11baf7b0c369bd [diff] |
cmake: Remove VULKAN_HEADERS_INSTALL VULKAN_HEADERS_INSTALL was added since it was believed there was a valid use case for it. After looking into the use case that provoked this change there is no reason to keep VULKAN_HEADERS_INSTALL as an option. Here is the use case we do NOT want to support: https://github.com/KhronosGroup/Vulkan-Headers/pull/416#issuecomment-1622318949 Fundamentally this problem is caused add_subdirectory/find_package not being able to work together flawlessly. Which isn't the responsibility of Vulkan-Headers to fix. It's the responsibility of projects that consume Vulkan-Headers to account for either method. As described by the CMake maintainers: https://discourse.cmake.org/t/idiomatic-way-to-handle-packages-and-add-subdirectory/8400
Vulkan header files and API registry
This repository contains Vulkan header files, include files for C and C++, and related scripts and tests.
Most of the files in this repository are sourced from, or generated from, other repositories as described in CONTRIBUTING.md. Vulkan-Headers exists as a staging area for these files, most of which are then consumed by downstream repositories used to build SDK components such as the Vulkan Validation Layers and Conformance Test Suite.
Developers normally obtain headers from the official Vulkan-SDK. They can also use headers from, or packaged from, this repository.
In most cases, developers should only need the headers, not the scripts and other material in this repository. In particular if you are packaging the headers for inclusion in Linux distributions or similar uses, we advise that you do not include the scripts, and direct potential users of the scripts to their canonical sources in the Vulkan Specification repository.
See the CONTRIBUTING.md
See BUILD.md
Vulkan-Headers are shipped as part of the official Vulkan-SDK
Vulkan-Headers
are also supported by both conan & vcpkg.
Updates to the Vulkan-Headers
repository which correspond to a new Vulkan specification release are tagged using the following format: v<
version
>
(e.g., v1.3.255
).
Note: Marked version releases have undergone thorough testing but do not imply the same quality level as SDK tags. SDK tags follow the sdk-<
version
>.<
patch
>
format (e.g., sdk-1.3.250.0
).