Skip to content

ivirtex/vulkan-hover-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Vulkan Hover Docs

This repo consists of 2 projects:

  • vk_docs_generator, which is a small CLI written in Rust for downloading, converting and post-processing Vulkan manual pages from Khronos registry.
  • vscode_ext, which is an VS Code extension that matches Vulkan symbols in your workspace to generated Markdown files from vk_docs_generator.

Example:

preview

Motivation

If you have ever wrote something in Vulkan, you probably know how verbose and extensive this API is.
For me, going back and forth to the documentation was pretty annoying and time consuming, that's why I created this project to help others with learning and using Vulkan.