Skip to content

Building.md

Latest commit

 

History

History
67 lines (50 loc) · 2.81 KB

Building.md

File metadata and controls

67 lines (50 loc) · 2.81 KB

Building

Minimum requirements

The generator requires a toolchain that supports C++20; the samples and tests may be compiled using at least C++11 with higher versions enabling wider test coverage at up to C++23. The following compilers are known to work, and tested during releases:

  • Visual Studio ≥ 2015
  • GCC ≥ 4.8.2
  • Clang ≥ 3.3

Note

Compiling the C++ named module requires the most recent compiler toolchains possible. This is detailed in the corresponding section.

Build steps

  1. Install dependencies:

    • Install CMake and git; ensure both are available from a shell.

    • Optionally install clang-format with version at least 11.0 so that any generated headers can be correctly formatted.

    • Additional dependencies are required to build the samples on Linux. On Ubuntu, install them with:

      sudo apt update && sudo apt install install lsb-release gpg software-properties-common wget

  2. In a shell, clone the repository:

    git clone --recurse-submodules https://github.com/KhronosGroup/Vulkan-Hpp.git

  3. Change the shell's working directory to the newly created Vulkan-Hpp directory.

    cd Vulkan-Hpp

  4. Create a build environment with CMake:

    cmake -B build --preset samples-tests

    You may need to specify a generator via -G; for a full list of generators execute cmake -G.

    To compile samples and tests using freshly generated headers from the vk.xml XML registry:

    cmake -B build --preset generator-samples-tests

  5. To actually start building, run the following:

    cmake --build build --parallel

    The tests are run via:

    ctest -j --output-on-failure --test-dir build

Additional notes

Formatting

If a clang-format executable is found by CMake, the variable CLANG_FORMAT_EXECUTABLE is set accordingly. In that case, the generated headers are formatted using the .clang-format file located in the root directory of this project; otherwise, the formatting is left as hard-coded in the generator.

When submitting merge requests that modify the generated files in vulkan, ensure clang-format version 21.1.0 is in the PATH or specify its location at configure time (command-line, preset file, or shell script) with CLANG_FORMAT_EXECUTABLE. This ensures that the generated headers and module interfaces are consistently formatted.

Custom views of Vulkan-Hpp objects in Visual Studio

VulkanHpp.natvis provides a custom view over vk::Flags for Visual Studio. Add this file to the directory of your Visual Studio installation (%USERPROFILE%\Documents\Visual Studio 2022\Visualizers). vk::Flags will be appropriately formatted in the debugger.