vkcheck logo vkcheck

Latest release Flathub Pipeline status REUSE status

vkcheck is an application that presents a window with information about your device's Vulkan support. This includes a table of extensions both supported and unsupported, Vulkan version compliance measurements, and Vulkan profile support. It can also be built as a static library that can be embedded into other Vulkan applications.

vkcheck is developed in a Linux-first manner. Windows is supported on a best-effort basis.

Features

vkcheck shows the following information:

• Known Vulkan instance extensions, with system-supported extensions marked
• Per-device Vulkan device information:
  • Basic information such as the type of device and the running driver
  • Known Vulkan device extensions, with device-supported extensions marked
  • Extension-level conformance to Vulkan API versions
• Vulkan profile support on both an instance and device level with detailed logs for profile incompatibility

Additionally, as previously mentioned, vkcheck is separated into both a static library and an executable. The static library can be embedded into existing Vulkan applications - see the source code for more information.

Installation

Linux

Distribution packaging status

Download on Flathub

Windows

You can download vkcheck from the Releases page.

Building

Requirements

vkcheck can be compiled with either GCC or clang. MSVC is not currently supported - vkcheck must be compiled using a mingw-w64-derived toolchain on Windows. This may change in the future if MSVC adds full support for C++23.

Dependencies

In addition to your distribution's base development packages, vkcheck requires the following build dependencies:

• meson
• cmake
• vulkan-headers
• vulkan-icd-loader
• vulkan-utility-libraries
• vulkan-profiles OR a copy of the Vulkan SDK, see below
• glfw3 OR sdl3
• volk (optional)

When compiling for Windows, glfw3 is automatically vendored to make compilation easier.

Options

By default, vkcheck will automatically select a backend for imgui - glfw3 will be selected if available, with sdl3 as a fallback. This can be overridden by passing the -Dimgui-backend= argument to meson setup.

While vulkan-icd-loader must be present on the system for vkcheck to build, volk may be linked in its place. To enable this, pass -Duse-volk=true to meson setup.

If vulkan-profiles is unavailable in your distribution's package repositories, you may instead download a copy of the Vulkan SDK and use its version of vulkan-profiles. To do this, pass to meson setup the complete absolute path to the Vulkan SDK's architecture directory as the value of -Dvulkan-sdk-path=, e.g. -Dvulkan-sdk-path=/home/serebit/Downloads/1.4.341.1/x86_64. The SDK version MUST match the system Vulkan version. When compiling on Windows, this argument is required.

By default, only the profiles contained in the system copy of vulkan-profiles are checked by vkcheck. Additional profiles may be added at build time - see the README.md in the profiles/json directory for details.

Copyright

vkcheck's source is owned by Campbell Jones (serebit) and licensed under the Apache-2.0 open-source license. Assets such as the resource files and scripts in the resources and scripts directories, respectively, are dual-licensed under either the Apache-2.0 or CC0-1.0 licenses, at your option. vkcheck supports the REUSE specification.