Vulkan-Utility-Libraries/docs/generated_code.md
Juan Ramos 6710b67cde Ensure all header files shipped have the vk_ prefix
CI will fail now if we ship a .h / .hpp file that doesn't use
the correct prefix.

I also documented the precedent for this prefix and the existing
integration testing.
2023-09-08 12:47:09 -06:00

871 B

How to generate the code

  • Linux:
scripts/generate_source.py external/Vulkan-Headers/registry/
  • Windows Powershell:
pwsh -Command { python3 scripts/generate_source.py external/Vulkan-Headers/registry/ }
  • Windows Command:
cmd /C "python3 scripts/generate_source.py external/Vulkan-Headers/registry/"

If only dealing with a single file, run scripts/generate_source.py with --target

# Example - only generates chassis.h
scripts/generate_source.py external/Vulkan-Headers/registry/ --target vk_dispatch_table.h

When making change to the scripts/ folder, make sure to run generate_source.py (Code generation does not happen automatically at build time.)