search

Neo-Zhixing / vkdoc.net

Better Vulkan Documentation starts here
https://vkdoc.net
MIT License
18 stars 1 forks source link

C++/ vulkan.hpp support #4

Open fschoenberger opened 2 weeks ago

fschoenberger commented 2 weeks ago

The project currently has support for the C and Rust API.

It would be fantastic if there was also a C++ tab for the structs/ enums/ functions/ ... from vulkan.hpp.

I'd be happy to help. For that it would be really useful to understand how the project works (i.e. how the Vulkan spec is transformed into the site).

Neo-Zhixing commented 2 weeks ago

Thanks for creating the issue and offering to help!

This repository contains the frontend code which was written with Nuxt.js

The actual Vulkan spec documents are converted into JSON format as a document tree so that it can be directly consumed by the frontend. The JSON files are hosted here: https://data.vkdoc.net/extensions/VK_KHR_16bit_storage.json

Those JSON files are generated in this repo: https://github.com/Neo-Zhixing/vk-doc-md The code quality isn't the best but it works :-0>

I've just created the README file to explain the transformation pipeline on a high level. Feel free to let me know if you have any questions!

Neo-Zhixing commented 2 weeks ago

If you could create a command line tool that prints the vulkan.hpp header given the struct/fn/enum name, that'd help a lot.