yuzu/Vulkan-Headers
1
0
Fork 0
mirror of https://github.com/KhronosGroup/Vulkan-Headers synced 2024-11-21 06:26:00 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
Vulkan-Headers/README.md
Jon Leech 9b834aa443 Update README to be more clear about use of the different files in the repo 
This is intended to clarify that developers using Vulkan are likely to
need only the header files, not the scripts and other material in the
repository which are used by the SDK and other downstream ecosystem
components.

Closes #407
2023-06-26 17:03:30 -07:00

1.8 KiB
Raw Blame History

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. 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. 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. In particular if you are packaging the headers for inclusion in Linux distributions or similar uses, we advise that you do not include the scripts, and direct potential users of the scripts to their canonical sources in the Vulkan Specification repository.

Contributing

See the CONTRIBUTING.md

Building

See BUILD.md

SDK Support

Vulkan-Headers are shipped as part of the official Vulkan-SDK

C/C++ Package Manager Support

Vulkan-Headers are also supported by both conan & vcpkg.

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.3.255).

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.3.250.0).