|
1501
|
1 <!--
|
|
|
2 Copyright 2018-2023 The Khronos Group Inc.
|
|
|
3
|
|
|
4 SPDX-License-Identifier: Apache-2.0
|
|
|
5 -->
|
|
|
6
|
|
|
7 # Vulkan-Headers
|
|
|
8
|
|
|
9 Vulkan header files and API registry
|
|
|
10
|
|
|
11 This repository contains Vulkan header files, include files for C and C++,
|
|
|
12 and related scripts and tests.
|
|
|
13
|
|
|
14 Most of the files in this repository are sourced from, or generated from,
|
|
|
15 other repositories as described in [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
|
16 Vulkan-Headers exists as a staging area for these files, most of which are
|
|
|
17 then consumed by downstream repositories used to build SDK components such
|
|
|
18 as the Vulkan Validation Layers and Conformance Test Suite.
|
|
|
19
|
|
|
20 Developers normally obtain headers from the official
|
|
|
21 [Vulkan-SDK](https://www.lunarg.com/vulkan-sdk/).
|
|
|
22 They can also use headers from, or packaged from, this repository.
|
|
|
23
|
|
|
24 In most cases, developers should only need the headers, not the scripts and
|
|
|
25 other material in this repository.
|
|
|
26 If you need to run the scripts, please use them from their canonical source
|
|
|
27 in the [Vulkan Specification
|
|
|
28 repository](https://github.com/KhronosGroup/Vulkan-Docs).
|
|
|
29
|
|
|
30 ## Contributing
|
|
|
31
|
|
|
32 See the [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
|
33
|
|
|
34 ## Building
|
|
|
35
|
|
|
36 See [BUILD.md](BUILD.md)
|
|
|
37
|
|
|
38 ## SDK Support
|
|
|
39
|
|
|
40 Vulkan-Headers are shipped as part of the official [Vulkan-SDK](https://www.lunarg.com/vulkan-sdk/)
|
|
|
41
|
|
|
42 ## C/C++ Package Manager Support
|
|
|
43
|
|
|
44 `Vulkan-Headers` are also supported by both [conan](https://conan.io/) & [vcpkg](https://learn.microsoft.com/en-us/vcpkg/).
|
|
|
45
|
|
|
46 ## Version Tagging Scheme
|
|
|
47
|
|
|
48 Updates to this repository which correspond to a new Vulkan specification release are tagged using the following format: `v<`_`version`_`>` (e.g., `v1.3.266`).
|
|
|
49
|
|
|
50 **Note**: Marked version releases have undergone thorough testing but do not imply the same quality level as SDK tags. SDK tags follow the `vulkan-sdk-<`_`version`_`>.<`_`patch`_`>` format (e.g., `vulkan-sdk-1.3.266.0`).
|
|
|
51
|
|
|
52 This scheme was adopted following the `1.3.266` Vulkan specification release.
|
