Building

This document describes in detail the layer build process.

Tip

Build step is optional if a prebuilt package has been downloaded from the Releases page.
Packages are available for Windows 10 or later, Ubuntu 22.04 and Ubuntu 24.04.

Dependencies

The layer depends on the following software for building:

Building with CMake

The layer uses CMake build management tool, so building it is straightforward.

  1. Clone the repository.

    git clone --recursive https://github.com/lstalmir/VulkanProfiler
cd VulkanProfiler

  2. Install Python packages.

    python3 -m pip install -r VkLayer_profiler_layer/scripts/requirements.txt

  3. Generate the project files / makefiles in the build directory.

    mkdir cmake_build
cd cmake_build
cmake .. -DCMAKE_BUILD_TYPE=Release

  4. Build the layer.

    cmake --build . --config Release

Building with Visual Studio

The repository depends on CMake to generate Visual Studio project files. Running steps 1-3 from Building with CMake will generate solution file in the build directory for the latest currently installed Visual Studio.

Tip

To select other Visual Studio version, use CMake -G option and specify the generator, e.g., -G "Visual Studio 16 2017".

Building with Make

Unix makefiles is the default CMake generator on Linux systems. Build directory will contain makefiles after running steps 1-3 from Building with CMake.

Once generated, the project can be built by running make:

make all

Building documentation

The documentation is written in reStructuredText and uses Sphinx to generate HTML.

The packages required for building are listed in Docs/requirements.txt:

Docs/requirements.txt
sphinx
sphinx-tabs
sphinx-rtd-theme
sphinx-multiversion

With the packages installed, sphinx-build tool can be used:

sphinx-build -M html ./Docs ./docs_build