Building
This document describes in detail the layer build process.
Tip
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.
Clone the repository.
git clone --recursive https://github.com/lstalmir/VulkanProfiler cd VulkanProfiler
Install Python packages.
python3 -m pip install -r VkLayer_profiler_layer/scripts/requirements.txt
Generate the project files / makefiles in the build directory.
mkdir cmake_build cd cmake_build cmake .. -DCMAKE_BUILD_TYPE=Release
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
Packaging
CMake install step can be used to collect all files into a single directory:
cmake --install . --config Release --prefix <install_dir>
The layer files will be placed in <install_dir>/bin on Windows, <install_dir>/lib on Linux, or in <install_dir>/lib/<arch> on multiarch Linux distributions (e.g., <install_dir>/lib/x86_64-linux-gnu).
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:
sphinx<=8.2.3
sphinx-tabs
sphinx-rtd-theme
sphinx-multiversion
With the packages installed, sphinx-build tool can be used:
sphinx-build -M html ./Docs ./docs_build