{"id":15108695,"url":"https://github.com/khronosgroup/vulkan-hpp","last_synced_at":"2026-04-01T19:41:57.382Z","repository":{"id":37396593,"uuid":"61292682","full_name":"KhronosGroup/Vulkan-Hpp","owner":"KhronosGroup","description":"Open-Source Vulkan C++ API","archived":false,"fork":false,"pushed_at":"2025-05-13T09:28:35.000Z","size":74185,"stargazers_count":3331,"open_issues_count":19,"forks_count":323,"subscribers_count":114,"default_branch":"main","last_synced_at":"2025-05-13T09:41:19.064Z","etag":null,"topics":["cpp","vulkan"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KhronosGroup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-06-16T12:51:55.000Z","updated_at":"2025-05-13T09:28:40.000Z","dependencies_parsed_at":"2023-02-16T05:45:45.040Z","dependency_job_id":"b9277f5b-83f1-499c-90e2-9cdda42f333a","html_url":"https://github.com/KhronosGroup/Vulkan-Hpp","commit_stats":{"total_commits":1396,"total_committers":84,"mean_commits":16.61904761904762,"dds":0.2593123209169055,"last_synced_commit":"1055cb5e780c12fb2aab98949cc5a0d45f6ed0a1"},"previous_names":[],"tags_count":156,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FVulkan-Hpp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FVulkan-Hpp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FVulkan-Hpp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FVulkan-Hpp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KhronosGroup","download_url":"https://codeload.github.com/KhronosGroup/Vulkan-Hpp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254029002,"owners_count":22002283,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cpp","vulkan"],"created_at":"2024-09-25T22:22:12.507Z","updated_at":"2026-04-01T19:41:57.367Z","avatar_url":"https://github.com/KhronosGroup.png","language":"C++","readme":"\n# Vulkan-Hpp: C++ bindings for Vulkan\n\n- [Overview](#overview)\n- [CI/CD status](#cicd-status)\n- [Documentation](#documentation)\n- [Installation and usage](#installation-and-usage)\n  - [Vulkan SDK](#vulkan-sdk)\n  - [vcpkg](#vcpkg)\n  - [Conan](#conan)\n- [Breaking Changes](#breaking-changes)\n  - [v1.4.334](#v14334)\n  - [v1.4.324](#v14324)\n  - [v1.4.329](#v14329)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Overview\n\nVulkan-Hpp provides header-only C++ bindings for the Vulkan C API to improve the developer experience with Vulkan without introducing run-time CPU costs.\nIt adds features like type safety for enumerations and bit-fields, STL container support, exception support, and several varieties of RAII-capable types.\n\nThis repository contains the [generators](VulkanHppGenerator.hpp) for Vulkan-Hpp, which accept the [XML specification of Vulkan](https://raw.githubusercontent.com/KhronosGroup/Vulkan-Docs/refs/heads/main/xml/vk.xml) and emit C++ bindings, which are documented further below.\n\n## CI/CD status\n\n\u003c!-- TODO: This table is now broken with the recent changes to CI/CD. --\u003e\n| Platform | Build Status |\n|:--------|:------------|\n| **Windows**  | [![CI Windows Clang](https://github.com/KhronosGroup/Vulkan-Hpp/actions/workflows/ci-windows-clang.yml/badge.svg)](https://github.com/KhronosGroup/Vulkan-Hpp/actions/workflows/ci-windows-clang.yml) \u003cbr\u003e [![CI Windows MSVC](https://github.com/KhronosGroup/Vulkan-Hpp/actions/workflows/ci-windows-msvc.yml/badge.svg)](https://github.com/KhronosGroup/Vulkan-Hpp/actions/workflows/ci-windows-msvc.yml) |\n| **Linux**    | [![CI Ubuntu 22](https://github.com/KhronosGroup/Vulkan-Hpp/actions/workflows/ci-ubuntu-22.yml/badge.svg)](https://github.com/KhronosGroup/Vulkan-Hpp/actions/workflows/ci-ubuntu-22.yml) \u003cbr\u003e [![CI Ubuntu 24](https://github.com/KhronosGroup/Vulkan-Hpp/actions/workflows/ci-ubuntu-24.yml/badge.svg)](https://github.com/KhronosGroup/Vulkan-Hpp/actions/workflows/ci-ubuntu-24.yml) |\n| **macOS**    | [![CI MacOS](https://github.com/KhronosGroup/Vulkan-Hpp/actions/workflows/ci-macos.yml/badge.svg)](https://github.com/KhronosGroup/Vulkan-Hpp/actions/workflows/ci-macos.yml) |\n\n## Documentation\n\nAll other documentation is in [`docs`](./docs/):\n\n1. [Building](./docs/Building.md) describes how to configure, build, and generate new headers.\n2. [Usage](./docs/Usage.md) explains how to use the various features of Vulkan-Hpp with detailed examples.\n3. [Configuration](./docs/Configuration.md) lists all the options available to configure the behaviour and features of Vulkan-Hpp.\n4. [Handles](./docs/Handles.md) is an overview of the three different families of handles provided by Vulkan-Hpp. These allow semantics similar to `std::unique_ptr`, `std::shared_ptr`, and also `vk::raii` types, which are [RAII](https://en.cppreference.com/w/cpp/language/raii.html) (resource acquisition is initialisation) handles that offer object-oriented semantics for Vulkan handles.\n\n\u003e [!NOTE]\n\u003e\n\u003e All macro configuration options [available in the C API](https://docs.vulkan.org/spec/latest/appendices/boilerplate.html) are also available and used in Vulkan-Hpp.\n\n## Installation and usage\n\n### Vulkan SDK\n\nVulkan-Hpp has been part of the [LunarG Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) since version 1.0.24; this remains the recommended installation method.\nIf you need a more recent version than the SDK supports, then Vulkan-Hpp is also distributed as part of the [Khronos Group Vulkan-Headers repository](https://github.com/KhronosGroup/Vulkan-Headers).\n\n### vcpkg\n\nAs above, Vulkan-Hpp is provided in the [`vulkan-headers`](https://vcpkg.io/en/package/vulkan-headers) port in [vcpkg](https://github.com/Microsoft/vcpkg).\nOtherwise, you can also install the [`vulkan-sdk-components`](https://vcpkg.io/en/package/vulkan-sdk-components) port, which is a vcpkg equivalent to the LunarG-distributed Vulkan SDK.\n\n```bash\ngit clone https://github.com/Microsoft/vcpkg.git\ncd vcpkg\n./bootstrap-vcpkg.sh\n./vcpkg integrate install\n./vcpkg install vulkan-headers\n```\n\nFor support, [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.\n\n### Conan\n\nSimilar to vcpkg, Vulkan-Hpp can be installed as part of the [`vulkan-headers`](https://conan.io/center/recipes/vulkan-headers) recipe.\n\nThe vcpkg and Conan packages are kept up to date by Microsoft and members of the community.\nRequests for updates and issues with these packages should be directed to their respective repositories rather than here.\n\n## Breaking Changes\n\nWe try to keep the API for all flavours of Vulkan-Hpp constant or backwards compatible. However, we may introduce unavoidable breaking changes, usually to fix bugs. Following is a list of those changes, arranged by version.\n\n### v1.4.334\n\nThe `vulkan_hpp` C++ named module has been renamed to `vulkan`.\n\n### v1.4.324\n\nWith PR [#2226](https://github.com/KhronosGroup/Vulkan-Hpp/pull/2226), the return type of `vk::raii::Device::acquireNextImage2KHR` and `vk::raii::SwapchainKHR::acquireNextImage` has changed from `std::pair\u003cvk::Result,uint32_t\u003e` to the equivalent `vk::ResultValue\u003cuint32_t\u003e`\n\n### v1.4.329\n\nWith PR [#2303](https://github.com/KhronosGroup/Vulkan-Hpp/pull/2303), `import std` was made mandatory when using the C++ named module.\n\n## Contributing\n\nFeel free to submit a PR to add to this list.\nYou should use clang-format version 22.1.1 to format the generated files.\n\n- [Examples](https://github.com/jherico/vulkan) A port of Sascha Willems [examples](https://github.com/SaschaWillems/Vulkan) to Vulkan-Hpp\n- [Vookoo](https://github.com/andy-thomason/Vookoo/) Stateful helper classes for Vulkan-Hpp, [Introduction Article](https://accu.org/journals/overload/25/139/overload139.pdf#page=14).\n\n## License\n\nCopyright 2015-2026 The Khronos Group Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhronosgroup%2Fvulkan-hpp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhronosgroup%2Fvulkan-hpp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhronosgroup%2Fvulkan-hpp/lists"}