1# Vulkan-Headers 2 3Vulkan header files and API registry 4 5## Default branch changed to 'main' 2021-09-12 6 7As discussed in #222, the default branch of this repository is now 'main'. This change should be largely transparent to repository users, since github rewrites many references to the old 'master' branch to 'main'. However, if you have a checked-out local clone, you may wish to take the following steps as recommended by github: 8 9```sh 10git branch -m master main 11git fetch origin 12git branch -u origin/main main 13git remote set-head origin -a 14``` 15 16## Repository Content 17 18The contents of this repository are largely obtained from other repositories 19and are collected, coordinated, and curated here. 20 21If proposing changes to any file originating from a different repository, 22please propose such changes in that repository, rather than Vulkan-Headers. 23Files in this repository originate from: 24 25### Specification repository (https://github.com/KhronosGroup/Vulkan-Docs) 26 27* registry/cgenerator.py 28* registry/spec_tools/conventions.py 29* registry/generator.py 30* registry/genvk.py 31* registry/reg.py 32* registry/spec_tools/util.py 33* registry/validusage.json 34* registry/video.xml 35* registry/vk.xml 36* registry/vkconventions.py 37* All files under include/vulkan/ which are *not* listed explicitly as originating from another repository. 38 39### This repository (https://github.com/KhronosGroup/Vulkan-Headers) 40 41* .cmake-format.py 42* BUILD.gn 43* BUILD.md 44* CMakeLists.txt 45* CODE_OF_CONDUCT.md 46* LICENSE.txt 47* README.md 48* cmake/Copyright_cmake.txt 49* cmake/cmake_uninstall.cmake.in 50* Non-API headers (report issues to the [Vulkan-Loader/issues](https://github.com/KhronosGroup/Vulkan-Loader/issues) tracker) 51 * include/vulkan/vk_icd.h 52 * include/vulkan/vk_layer.h 53 * include/vulkan/vk_sdk_platform.h 54 55### Vulkan C++ Binding Repository (https://github.com/KhronosGroup/Vulkan-Hpp) 56 57As of the Vulkan-Docs 1.2.182 spec update, the Vulkan-Hpp headers have been 58split into multiple files. All of those files are now included in this 59repository. 60 61* include/vulkan/vulkan.hpp 62* include/vulkan/vulkan_enums.hpp 63* include/vulkan/vulkan_funcs.hpp 64* include/vulkan/vulkan_handles.hpp 65* include/vulkan/vulkan_raii.hpp 66* include/vulkan/vulkan_structs.hpp 67 68## Version Tagging Scheme 69 70Updates to the `Vulkan-Headers` repository which correspond to a new Vulkan 71specification release are tagged using the following format: 72`v<`_`version`_`>` (e.g., `v1.1.96`). 73 74**Note**: Marked version releases have undergone thorough testing but do not 75imply the same quality level as SDK tags. SDK tags follow the 76`sdk-<`_`version`_`>.<`_`patch`_`>` format (e.g., `sdk-1.1.92.0`). 77 78This scheme was adopted following the 1.1.96 Vulkan specification release. 79