2020-12-28 16:15:37 +01:00
|
|
|
# Vulkan-Headers
|
|
|
|
|
|
|
|
Vulkan header files and API registry
|
|
|
|
|
|
|
|
## Repository Content
|
|
|
|
|
2021-07-09 23:54:15 +02:00
|
|
|
The contents of this repository are largely obtained from other repositories
|
|
|
|
and are collected, coordinated, and curated here.
|
|
|
|
|
|
|
|
If proposing changes to any file originating from a different repository,
|
|
|
|
please propose such changes in that repository, rather than Vulkan-Headers.
|
|
|
|
Files in this repository originate from:
|
|
|
|
|
|
|
|
### Specification repository (https://github.com/KhronosGroup/Vulkan-Docs)
|
|
|
|
|
|
|
|
* registry/cgenerator.py
|
|
|
|
* registry/conventions.py
|
|
|
|
* registry/generator.py
|
|
|
|
* registry/genvk.py
|
|
|
|
* registry/reg.py
|
|
|
|
* registry/spec_tools/util.py
|
|
|
|
* registry/validusage.json
|
|
|
|
* registry/vk.xml
|
|
|
|
* registry/vkconventions.py
|
|
|
|
* All files under include/vulkan/ which are *not* listed explicitly as originating from another repository.
|
|
|
|
|
|
|
|
### This repository (https://github.com/KhronosGroup/Vulkan-Headers)
|
|
|
|
|
|
|
|
* .cmake-format.py
|
|
|
|
* BUILD.gn
|
|
|
|
* BUILD.md
|
|
|
|
* CMakeLists.txt
|
|
|
|
* CODE_OF_CONDUCT.md
|
|
|
|
* LICENSE.txt
|
|
|
|
* README.md
|
|
|
|
* cmake/Copyright_cmake.txt
|
|
|
|
* cmake/cmake_uninstall.cmake.in
|
|
|
|
* Non-API headers (report issues against @lenny-lunarg)
|
|
|
|
* include/vulkan/vk_icd.h
|
|
|
|
* include/vulkan/vk_layer.h
|
|
|
|
* include/vulkan/vk_sdk_platform.h
|
|
|
|
|
|
|
|
### Vulkan C++ Binding Repository (https://github.com/KhronosGroup/Vulkan-Hpp)
|
|
|
|
|
|
|
|
* include/vulkan/vulkan.hpp
|
2020-12-28 16:15:37 +01:00
|
|
|
|
|
|
|
## 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.
|