Skip to content

legacy_detection.md

Latest commit

 

History

History
62 lines (40 loc) · 3.05 KB

legacy_detection.md

File metadata and controls

62 lines (40 loc) · 3.05 KB

Khronos Vulkan

Legacy Detection

The Vulkan Working Group plans to continue to grow the list of what is legacy functionality. These are things that will not be removed from the API, but have a "newer" way to use that developers should try to use instead.

This all works by first marking things with a <deprecate> tags in the vk.xml. From here the Validation Layers can generated the legacy.cpp file.

The was before the working group decided to give the name "Legacy" instead to prevent confusion.

What does it do

When the Legacy Detection setting is enabled, it will report warnings when using superseded functionality of the API in Vulkan.

  • It will only report if the developer has explicitly enabled the version/extensions that superseded the functionality.
  • It will only report the first usage of the functionality.
    • This is to prevent getting spammed with duplicate error messages
  • These act like any other VUID, which can be muted.
    • They will always start with WARNING-legacy-*

⚠️ If you have your own callback, make sure the VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT flag is not being ignored. If turning on warnings is a concern, we suggest turning off Core Validation and only have Legacy Detection on.

Enabling

The Legacy Detection is just a normal layer setting that can be turned on.

The main 3 ways to turn on Legacy Detection

  1. We highly suggest people to use VkConfig. There is a preset as well to only turn on Legacy Detection.

  2. Use VK_EXT_layer_settings

const VkBool32 verbose_value = true;
const VkLayerSettingEXT layer_setting = {"VK_LAYER_KHRONOS_validation", "legacy_detection", VK_LAYER_SETTING_TYPE_BOOL32_EXT, 1, &verbose_value};
VkLayerSettingsCreateInfoEXT layer_settings_create_info = {VK_STRUCTURE_TYPE_LAYER_SETTINGS_CREATE_INFO_EXT, nullptr, 1, &layer_setting};

VkInstanceCreateInfo instance_ci = GetYourCreateInfo();
instance_ci.pNext = &layer_settings_create_info;
  1. Set as an environment variable (will turn on as an additional setting with core validation)
# Windows
set VK_VALIDATION_LEGACY_DETECTION=1

# Linux
export VK_VALIDATION_LEGACY_DETECTION=1

# Android
adb shell setprop debug.vulkan.khronos_validation.legacy_detection=1

Extra reference

There is a Vulkan Guide chapter that will go more into depth how to replace older superseded code.