sndels / vulkan-api-docs

Vulkan API documentation action to the vscode editor context menu (C, C++).

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

vulkan-api-docs

Adds a VSCode editor context menu action that tries to open the Vulkan API doc url for the symbol under the cursor in C and C++ files.

Features

The action tries opening docs for both the raw symbol and simple mappings assuming a preceding vk::-namespace or object. for a method call like in vulkan-hpp. Opens all potentially matching docs: running on e.g. the method call in cmd.buildAccelerationStructuresKHR(...) opens both vkCmdBuildAccelerationStructuresKHR and vkBuildAccelerationStructuresKHR.

Known Issues

Lag between docs opening if more than one are opened. Seems like an intentional feature in vscode.env.openExternal().

Release Notes

0.1.1

Readme cleanup

0.1.0

Initial release

About

Vulkan API documentation action to the vscode editor context menu (C, C++).

License:MIT License


Languages

Language:TypeScript 100.0%