README.md
1# Vulkan-Headers
2
3Vulkan header files and API registry
4
5## Repository Content
6
7The contents of this repository are largely obtained from other repositories and are
8collected, coordinated, and curated here.
9
10Do not propose pull requests to this repository which modify any files under
11include/vulkan/ or registry/. All such files are generated from the
12Vulkan-Docs repository and, in the case of include/vulkan/vulkan.hpp, the
13Vulkan-Hpp repository. Any changes must be made in those repositories.
14
15The projects for these repositories are:
16
17- [KhronosGroup/Vulkan-Docs](https://github.com/KhronosGroup/Vulkan-Docs)
18 - Core Vulkan headers and Registry
19- [KhronosGroup/Vulkan-Hpp](https://github.com/KhronosGroup/Vulkan-Hpp)
20 - C++ Bindings for Vulkan
21
22Please visit the appropriate project in the above list for obtaining additional information,
23asking questions, or opening issues.
24
25## Version Tagging Scheme
26
27Updates to the `Vulkan-Headers` repository which correspond to a new Vulkan
28specification release are tagged using the following format:
29`v<`_`version`_`>` (e.g., `v1.1.96`).
30
31**Note**: Marked version releases have undergone thorough testing but do not
32imply the same quality level as SDK tags. SDK tags follow the
33`sdk-<`_`version`_`>.<`_`patch`_`>` format (e.g., `sdk-1.1.92.0`).
34
35This scheme was adopted following the 1.1.96 Vulkan specification release.
36