https://github.com/storterald/vulkanwithdocumentation

https://github.com/storterald/vulkanwithdocumentation

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/storterald/vulkanwithdocumentation
• Owner: Storterald
• Created: 2024-06-08T09:02:14.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-11-12T18:05:38.000Z (6 months ago)
• Last Synced: 2024-11-12T19:18:47.046Z (6 months ago)
• Language: Python
• Size: 7.17 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vulkan With Documentation

Automatically generated headers meant to *replace* the original Vulkan headers with ***documentation*** added to 

every `function`, `struct`, `enum`, `flag`, `handle` and `typedef`. 

Everything has the original Vulkan generated signature and can be used with the ***default*** vulkan library.

The script fetches the [Vulkan Headers](https://github.com/KhronosGroup/Vulkan-Headers) using **git**.

`Visual Studio` is only supported with the `-RS` flag with `ReSharper` extension or with the `-TXT` flag, as it does not support neither **markdown** nor **html**

styled documentation.

The `generate.py` script can be run with the `-N` **flag** to generate an alias in the namespace `vk`. 

This is what an alias may look like:

```c++

VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkCommandPool)

namespace vk {

        /** Full documentation

         */

        using CommandPool = VkCommandPool;

}

```

## Script arguments

#### Required Arguments

 - `output path` The first script argument **must** be the output directory where the `vulkan` and `vk_video` folder

   will be generated.

#### Style Flags

 - `-CL` Uses **CLion** styled documentation.

 - `-RS` Uses **ReSharper** *(Visual Studio Extension)* styled documentation.

 - `-VSC` Uses **Visual Studio Code** styled documentation.

 - `-TXT` Uses plain text documentation

#### Boolean Flags

 - `-N` If the script should generate a *namespace* alias, like shown above.

## CMake integration

Along the python script, a `generate.cmake` file is provided, with the function `generate_headers`.

These are the arguments of the function:

```cmake

include(generate.cmake)

# Important! The flags must be a list, not a string:

# This is valid: set(YOUR_FLAGS_HERE -CL -N)

# This is not: set(YOUR_FLAGS_HERE "-CL -N")

generate_headers(

        OUTPUT_DIRECTORY ${YOUR_DIRECTORY_HERE}

        # Flags is a multi-argument parameter, it's not necessary to

        # declare a list outside the function call

        FLAGS ${YOUR_FLAGS_HERE}

)

```