mirror of https://github.com/PCSX2/pcsx2.git
53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
|
<!--
|
||
|
|
Copyright 2018-2023 The Khronos Group Inc.
|
||
|
|
|
||
|
|
SPDX-License-Identifier: Apache-2.0
|
||
|
|
-->
|
||
|
|
|
||
|
|
# Vulkan-Headers
|
||
|
|
|
||
|
|
Vulkan header files and API registry
|
||
|
|
|
||
|
|
This repository contains Vulkan header files, include files for C and C++,
|
||
|
|
and related scripts and tests.
|
||
|
|
|
||
|
|
Most of the files in this repository are sourced from, or generated from,
|
||
|
|
other repositories as described in [CONTRIBUTING.md](CONTRIBUTING.md).
|
||
|
|
Vulkan-Headers exists as a staging area for these files, most of which are
|
||
|
|
then consumed by downstream repositories used to build SDK components such
|
||
|
|
as the Vulkan Validation Layers and Conformance Test Suite.
|
||
|
|
|
||
|
|
Developers normally obtain headers from the official
|
||
|
|
[Vulkan-SDK](https://www.lunarg.com/vulkan-sdk/).
|
||
|
|
They can also use headers from, or packaged from, this repository.
|
||
|
|
|
||
|
|
In most cases, developers should only need the headers, not the scripts and
|
||
|
|
other material in this repository.
|
||
|
|
If you need to run the scripts, please use them from their canonical source
|
||
|
|
in the [Vulkan Specification
|
||
|
|
repository](https://github.com/KhronosGroup/Vulkan-Docs).
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
See the [CONTRIBUTING.md](CONTRIBUTING.md)
|
||
|
|
|
||
|
|
## Building
|
||
|
|
|
||
|
|
See [BUILD.md](BUILD.md)
|
||
|
|
|
||
|
|
## SDK Support
|
||
|
|
|
||
|
|
Vulkan-Headers are shipped as part of the official [Vulkan-SDK](https://www.lunarg.com/vulkan-sdk/)
|
||
|
|
|
||
|
|
## C/C++ Package Manager Support
|
||
|
|
|
||
|
|
`Vulkan-Headers` are also supported by both [conan](https://conan.io/) & [vcpkg](https://learn.microsoft.com/en-us/vcpkg/).
|
||
|
|
|
||
|
|
## Version Tagging Scheme
|
||
|
|
|
||
|
|
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`).
|
||
|
|
|
||
|
|
**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`).
|
||
|
|
|
||
|
|
This scheme was adopted following the `1.3.266` Vulkan specification release.
|