Vulkan Research Kit

The Vulkan Research Kit (VRK) is a thin wrapper of the Vulkan API. The project was made for creating quick prototypes of Vulkan applications/demos.

Building

The Vulkan Research Kit requires the following components:

Vulkan-Headers
Vulkan-Loader (Required for libvulkan.so)
GLSLang (Required for compiling GLSL -> SPIR-V)

The following environment variables will be used to build using specified components (the same variables could also be defined when building in cmake):

Vulkan_INCLUDE_DIRS="Vulkan-Headers/build/install/include"
Vulkan_LIBRARIES="Vulkan-Loader/build/install/lib/libvulkan.so"
Vulkan_GLSLANG_VALIDATOR_EXECUTABLE="glslang/build/install/bin/glslangValidator"

Build Steps

Create a build directory and navigate to the new directory.

mkdir build
cd build

Run cmake with the root of the repository as the argument.

cmake ..

Building Examples

An included source file can be used to set up the environment variables required for building the examples.

source tools/setup-vrk-env.sh

Libraries

vrk: Provides the base Vulkan implementation. Can be used alone for a headless Vulkan application.

vrk-wsi: Provides support to the Window System Integration. Required for presenting images to a surface on a window.

vrk-ray-tracing: Provides support to the Vulkan ray tracing extensions.

vrk-dynamic-rendering: Provides support to the Vulkan dynamic rendering extension.

Contributing