diff options
| -rw-r--r-- | CONTRIBUTING.md | 6 | ||||
| -rw-r--r-- | README.md | 12 |
2 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45217a7..bed4271 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,8 @@ Please note when contributing what files this repository actually is responsible for. +The majority for the Vulkan headers come from [Vulkan-Docs](https://github.com/KhronosGroup/Vulkan-Docs) or [Vulkan-Hpp](https://github.com/KhronosGroup/Vulkan-Hpp) + ### This repository (https://github.com/KhronosGroup/Vulkan-Headers) * BUILD.gn @@ -26,4 +28,8 @@ Please note when contributing what files this repository actually is responsible ### Vulkan C++ Binding Repository (https://github.com/KhronosGroup/Vulkan-Hpp) +As of the Vulkan-Docs 1.2.182 spec update, the Vulkan-Hpp headers have been +split into multiple files. All of those files are now included in this +repository. + * include/vulkan/*.hpp @@ -24,3 +24,15 @@ Vulkan-Headers are shipped as part of the official [Vulkan-SDK](https://www.luna ## C/C++ Package Manager Support `Vulkan-Headers` are also supported by both [conan](https://conan.io/) & [vcpkg](https://learn.microsoft.com/en-us/vcpkg/). + +## Version Tagging Scheme + +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.1.96`). + +**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.1.92.0`). + +This scheme was adopted following the 1.1.96 Vulkan specification release. |