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. If you need to run the scripts, please use them from their canonical source in the Vulkan Specification repository.

Installation

Run:

$ npm i vulkan.c

And then include vulkan.h as follows:

// main.c
#include <vulkan/vulkan.h>

int main() { /* ... */ }

Finally, compile while adding the path node_modules/vulkan.c to your compiler's include paths.

$ clang -I./node_modules/vulkan.c main.c  # or, use gcc
$ gcc   -I./node_modules/vulkan.c main.c

You may also use a simpler approach with the cpoach tool, which automatically adds the necessary include paths of all the installed dependencies for your project.

$ cpoach clang main.c  # or, use gcc
$ cpoach gcc   main.c

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