{"id":20105016,"url":"https://github.com/misyltoad/vkroots","last_synced_at":"2025-04-06T23:17:25.043Z","repository":{"id":135970326,"uuid":"488022269","full_name":"misyltoad/vkroots","owner":"misyltoad","description":"A stupid simple method of making Vulkan layers, at home!","archived":false,"fork":false,"pushed_at":"2024-11-30T01:36:37.000Z","size":293,"stargazers_count":86,"open_issues_count":2,"forks_count":9,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-30T21:11:20.095Z","etag":null,"topics":["framework","graphics-programming","header-only","layer","vklayer","vulkan"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/misyltoad.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2022-05-02T23:38:56.000Z","updated_at":"2025-02-23T20:53:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"12490525-fc7c-43ff-a6ec-f94faa4c42fc","html_url":"https://github.com/misyltoad/vkroots","commit_stats":null,"previous_names":["misyltoad/vkroots"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misyltoad%2Fvkroots","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misyltoad%2Fvkroots/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misyltoad%2Fvkroots/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misyltoad%2Fvkroots/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/misyltoad","download_url":"https://codeload.github.com/misyltoad/vkroots/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247563939,"owners_count":20958971,"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":["framework","graphics-programming","header-only","layer","vklayer","vulkan"],"created_at":"2024-11-13T17:45:36.984Z","updated_at":"2025-04-06T23:17:25.025Z","avatar_url":"https://github.com/misyltoad.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"![vkroots logo](assets/vkroots.png)\n\n# What is vkroots?\n\nvkroots is a framework for writing Vulkan layers that takes **all** the complexity/hastle away from you! It's so simple!\n\n## Example\n\nvkroots is incredibly easy to integrate into your project, it's a single `#include`, and even supports\ndefining multiple layers in a single shared library with `VKROOTS_NEGOTIATION_INTERFACE`.\n\nAll you do is just implement the functions you want, and they are automagically hooked using C++20 concepts magic! Just watch:\n\n```cpp\n#include \"vkroots.h\"\n\n#include \u003ccstdio\u003e\n\nnamespace MyLayer {\n\n  class VkDeviceOverrides {\n  public:\n    static VkResult CreateImage(\n      const vkroots::VkDeviceDispatch* pDispatch,\n            VkDevice                   device,\n      const VkImageCreateInfo*         pCreateInfo,\n      const VkAllocationCallbacks*     pAllocator,\n            VkImage*                   pImage) {\n      printf(\"The app has made an image, I bet it's going to be frogtastically beautiful!\\n\");\n      return pDispatch-\u003eCreateImage(device, pCreateInfo, pAllocator, pImage);\n    }\n  };\n\n}\n\nVKROOTS_DEFINE_LAYER_INTERFACES(vkroots::NoOverrides,\n                                vkroots::NoOverrides,\n                                MyLayer::VkDeviceOverrides);\n```\n\n## How do I pull this into my project?\n\nYou can either add this repo as a git submodule, copy the header from this repo directly, or generate it yourself with `gen/make_vkroots`.\n\nThe vkroots header can be generated from any Vulkan Registry XML (even for unreleased/non-standard extensions).\nThis was used, for example, in the sample [VK_FOOL_printed_surface](https://github.com/Joshua-Ashton/VkLayer_FOOL_printed_surface_cups) implementation using CUPS.\n\n## Dependencies\n\nThere are no dependencies other a C++20-capable compiler.\n\nIf you wish to generate the `vkroots.h` header from a Vulkan Registry XML, you will need Python 3.\n\n## Contributing\n\nIf you find any issues with the project or have any feature requests, please feel free to make an issue or a pull request.\n\n## Projects using vkroots\n\n - [VK_FOOL_printed_surface](https://github.com/Joshua-Ashton/VkLayer_FOOL_printed_surface_cups)\n\n## License\n\nThe python generator scripts: `gen/make_vkroots`, `gen/vulkan_helpers.py`, are\nlicensed under LGPL v2.1 as they take a bunch of code from WineVulkan, see the header of\nmake_vkroots and vulkan_helpers.py for more verbose license info.\n\nEverything else, `vkroots.h` header, other intermediate headers (`inc`), and samples are licensed under Apache-2.0 OR MIT to be compatible\nwith the Vulkan Registry XML.\n\nSee the top of associated files for more information.\n\n# Happy Layering! 🐸✨","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmisyltoad%2Fvkroots","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmisyltoad%2Fvkroots","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmisyltoad%2Fvkroots/lists"}