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 8and are collected, coordinated, and curated here. 9 10If proposing changes to any file originating from a different repository, 11please propose such changes in that repository, rather than Vulkan-Headers. 12Files in this repository originate from: 13 14### Specification repository (https://github.com/KhronosGroup/Vulkan-Docs) 15 16* registry/cgenerator.py 17* registry/conventions.py 18* registry/generator.py 19* registry/genvk.py 20* registry/reg.py 21* registry/spec_tools/util.py 22* registry/validusage.json 23* registry/vk.xml 24* registry/vkconventions.py 25* All files under include/vulkan/ which are *not* listed explicitly as originating from another repository. 26 27### This repository (https://github.com/KhronosGroup/Vulkan-Headers) 28 29* .cmake-format.py 30* BUILD.gn 31* BUILD.md 32* CMakeLists.txt 33* CODE_OF_CONDUCT.md 34* LICENSE.txt 35* README.md 36* cmake/Copyright_cmake.txt 37* cmake/cmake_uninstall.cmake.in 38* Non-API headers (report issues against @lenny-lunarg) 39 * include/vulkan/vk_icd.h 40 * include/vulkan/vk_layer.h 41 * include/vulkan/vk_sdk_platform.h 42 43### Vulkan C++ Binding Repository (https://github.com/KhronosGroup/Vulkan-Hpp) 44 45As of the Vulkan-Docs 1.2.182 spec update, the Vulkan-Hpp headers have been 46split into multiple files. All of those files are now included in this 47repository. 48 49* include/vulkan/vulkan.hpp 50* include/vulkan/vulkan_enums.hpp 51* include/vulkan/vulkan_funcs.hpp 52* include/vulkan/vulkan_handles.hpp 53* include/vulkan/vulkan_raii.hpp 54* include/vulkan/vulkan_structs.hpp 55 56## Version Tagging Scheme 57 58Updates to the `Vulkan-Headers` repository which correspond to a new Vulkan 59specification release are tagged using the following format: 60`v<`_`version`_`>` (e.g., `v1.1.96`). 61 62**Note**: Marked version releases have undergone thorough testing but do not 63imply the same quality level as SDK tags. SDK tags follow the 64`sdk-<`_`version`_`>.<`_`patch`_`>` format (e.g., `sdk-1.1.92.0`). 65 66This scheme was adopted following the 1.1.96 Vulkan specification release. 67