{"id":23594096,"url":"https://github.com/storterald/documented-vulkan-headers","last_synced_at":"2025-10-27T15:39:09.959Z","repository":{"id":252527943,"uuid":"812214578","full_name":"Storterald/Documented-Vulkan-Headers","owner":"Storterald","description":"Replacements for the original Vulkan C headers with documentation for various IDEs and Text Editors.","archived":false,"fork":false,"pushed_at":"2025-09-24T19:11:29.000Z","size":7661,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-24T21:14:22.556Z","etag":null,"topics":["c","c-plus-plus","clion","cmake","cpp","documentation","header-only","headers","python","resharper","script","vscode","vulkan"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Storterald.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-06-08T09:02:14.000Z","updated_at":"2025-09-24T19:11:33.000Z","dependencies_parsed_at":"2025-02-27T17:25:53.589Z","dependency_job_id":"2ff734b4-f831-4d9d-9ab4-a0d7d959c359","html_url":"https://github.com/Storterald/Documented-Vulkan-Headers","commit_stats":null,"previous_names":["storterald/vulkanwithdocumentation"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/Storterald/Documented-Vulkan-Headers","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Storterald%2FDocumented-Vulkan-Headers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Storterald%2FDocumented-Vulkan-Headers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Storterald%2FDocumented-Vulkan-Headers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Storterald%2FDocumented-Vulkan-Headers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Storterald","download_url":"https://codeload.github.com/Storterald/Documented-Vulkan-Headers/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Storterald%2FDocumented-Vulkan-Headers/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281294918,"owners_count":26476755,"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","status":"online","status_checked_at":"2025-10-27T02:00:05.855Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["c","c-plus-plus","clion","cmake","cpp","documentation","header-only","headers","python","resharper","script","vscode","vulkan"],"created_at":"2024-12-27T09:15:12.540Z","updated_at":"2025-10-27T15:39:09.954Z","avatar_url":"https://github.com/Storterald.png","language":"Python","readme":"# Documented Vulkan Headers\n\n\u003e 🔴**IMPORTANT**🔴\u003cbr\u003e\n\u003e **Python** `3.12` is **required** (mainly due to [**PEP 701**](https://docs.python.org/3/whatsnew/3.12.html#whatsnew312-pep701)).\n\nAutomatically generated headers meant to *replace* the original Vulkan headers with\n***documentation*** added to every `definition`, `function`, `struct`, `enum`, `flag`,\n`handle` and `typedef` with an available description in the\n[Vulkan Registry](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/).\n\nEverything has the original Vulkan generated signature and can be used with the ***default*** vulkan library.\nThe script fetches the [Vulkan Headers](https://github.com/KhronosGroup/Vulkan-Headers) and the\n[Vulkan Registry](https://github.com/KhronosGroup/Vulkan-Registry) using **git**.\n\nThe `generate.py` script can be run with the `-N` **flag** to generate an alias in the namespace `vk`. \nThis is what an alias may look like:\n\n```c++\nVK_DEFINE_NON_DISPATCHABLE_HANDLE(VkCommandPool)\nnamespace vk {\n        /** Full documentation\n         */\n        using CommandPool = VkCommandPool;\n}\n```\n\n## Script arguments\n\n#### Required Arguments\n - `output_path` Where the **vulkan/** and **vk_video/** directories will be put.\n\n#### Optional Arguments\n - `-S`, `--style` The documentation style.\n - `-V`, `--version` The vulkan headers version to clone (must be a **valid git tag**).\n\n#### Boolean Flags\n - `-N`, `--namespace` If the script should generate a *namespace* alias, like shown above.\n - `-F`, `--force` Forces the script to **regenerate** the headers.\n\n#### Style Flags\n\n`-S`, `--style` Flag options:\n - `CL` **CLion**.\n - `CL_NV` **CLion Nova**.\n - `RS` **Visual Studio ReSharper**.\n - `VSC` **Visual Studio Code**.\n - `TXT` **Plain text**.\n\n## CMake integration\n\nAlong the python script, a `generate.cmake` file is provided, with the function `generate_headers`.\nThese are the arguments of the function:\n\n```cmake\ninclude(generate.cmake)\n\n# Important! The flags must be a list, not a string:\n# This is valid: set(YOUR_FLAGS_HERE -CL -N)\n# This is not: set(YOUR_FLAGS_HERE \"-CL -N\")\ngenerate_headers(\n        OUTPUT_DIRECTORY ${YOUR_DIRECTORY_HERE}\n        # Flags is a multi-argument parameter, it's not necessary to\n        # declare a list outside the function call\n        FLAGS ${YOUR_FLAGS_HERE}\n)\n```\n\n## CMake Vulkan-Loader support\n\nIf the [Vulkan-Loader](https://github.com/KhronosGroup/Vulkan-Loader) library is\n**built** together with the headers, `DEFINE_VULKAN_TARGET ON` should be passed\nto the `generate_headers` function, this will define the `Vulkan::Headers` target\n**required** by the **loader**.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstorterald%2Fdocumented-vulkan-headers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstorterald%2Fdocumented-vulkan-headers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstorterald%2Fdocumented-vulkan-headers/lists"}