Skip to main content

Validation layers

Validation layers enable developers to verify their application's correct use of the Vulkan API. Validation layers can be enabled in both debug and release builds, including in exported projects.

note

Enabling validation layers has a performance impact, so only enable them when you actually need the output to debug the application.

Windows​

Install the Vulkan SDK <https://vulkan.lunarg.com/sdk/home>, which contains validation layers as part of its default installation. No need to enable any optional features in the installer; installing the core Vulkan SDK suffices. You don't need to reboot after installing the SDK, but you may need to close and reopen your current terminal.

After installing the Vulkan SDK, run Redot with the --gpu-validation command line argument. You can also specify --gpu-abort which will make Redot quit as soon as a validation error happens. This can prevent your system from freezing if a validation error occurs.

macOS​

warning

Official Redot macOS builds do not support validation layers, as these are statically linked against the Vulkan SDK. Dynamic linking must be used instead.

In practice, this means that using validation layers on macOS requires you to use a Redot build compiled with the use_volk=yes SCons option. doc_compiling_for_macos. If testing validation layers on an exported project, you must recompile the export template and specify it as a custom export template in your project's macOS export preset.

Install the Vulkan SDK <https://vulkan.lunarg.com/sdk/home>, which contains validation layers as part of its default installation. No need to enable any optional features in the installer; installing the core Vulkan SDK suffices. You don't need to reboot after installing the SDK, but you may need to close and reopen your current terminal.

After installing the Vulkan SDK, run a Redot binary that was compiled with use_volk=yes SCons option. Specify the --gpu-validation command line argument. You can also specify --gpu-abort which will make Redot quit as soon as a validation error happens. This can prevent your system from freezing if a validation error occurs.

Linux, *BSD​

Install Vulkan validation layers from your distribution's repositories:

vulkan-validation-layers

You don't need to reboot after installing the validation layers, but you may need to close and reopen your current terminal.

After installing the package, run Redot with the --gpu-validation command line argument. You can also specify --gpu-abort which will make Redot quit as soon as a validation error happens. This can prevent your system from freezing if a validation error occurs.

Android​

After enabling validation layers on Android, a developer can see errors and warning messages in the adb logcat output.

iOS​

Validation layers are currently not supported on iOS.

Web​

Validation layers are not supported on the web platform, as there is no support for Vulkan there.

Enabling validation layers​

Build validation layers from official sources​

To build Android libraries, follow the instructions on Khronos' repository. After a successful build, the libraries will be located in Vulkan-ValidationLayers/build-android/libs.

Copy libraries​

Copy libraries from Vulkan-ValidationLayers/build-android/libs to Redot/platform/android/java/app/libs/debug/vulkan_validation_layers.

Your Redot source directory tree should look like on the example below

Redot
|-- platform
    |-- android
        |-- java
            |-- app
                |-- libs
                    |-- debug
                        |-- vulkan_validation_layers
                            |-- arm64-v8a
                            |-- armeabi-v7a
                            |-- x86
                            |-- x86_64

If the subdirectory libs/debug/vulkan_validation_layers doesn't exist, create it.

Compile and run the Android app​

Linked validation layers are automatically loaded and enabled in Android debug builds. You can use Redot's doc_one-click_deploy feature to quickly test your project with the validation layers enabled.