Package org.lwjgl.vulkan

Class EXTToolingInfo

java.lang.Object
org.lwjgl.vulkan.EXTToolingInfo
public class EXTToolingInfo extends Object
When an error occurs during application development, a common question is "What tools are actually running right now?" This extension adds the ability to query that information directly from the Vulkan implementation.

Outdated versions of one tool might not play nicely with another, or perhaps a tool is not actually running when it should have been. Trying to figure that out can cause headaches as it is necessary to consult each known tool to figure out what is going on — in some cases the tool might not even be known.

Typically, the expectation is that developers will simply print out this information for visual inspection when an issue occurs, however a small amount of semantic information about what the tool is doing is provided to help identify it programmatically. For example, if the advertised limits or features of an implementation are unexpected, is there a tool active which modifies these limits? Or if an application is providing debug markers, but the implementation is not actually doing anything with that information, this can quickly point that out.

Promotion to Vulkan 1.3

Vulkan APIs in this extension are included in core Vulkan 1.3, with the EXT suffix omitted. External interactions defined by this extension, such as SPIR-V token names, retain their original names. The original Vulkan API names are still available as aliases of the core functionality.

Examples

 uint32_t num_tools;
 VkPhysicalDeviceToolPropertiesEXT *pToolProperties;
 vkGetPhysicalDeviceToolPropertiesEXT(physicalDevice, &num_tools, NULL);
 
 pToolProperties = (VkPhysicalDeviceToolPropertiesEXT*)malloc(sizeof(VkPhysicalDeviceToolPropertiesEXT) * num_tools);
 
 vkGetPhysicalDeviceToolPropertiesEXT(physicalDevice, &num_tools, pToolProperties);
 
 for (int i = 0; i < num_tools; ++i) {
     printf("%s:\n", pToolProperties[i].name);
     printf("Version:\n");
     printf("%s:\n", pToolProperties[i].version);
     printf("Description:\n");
     printf("\t%s\n", pToolProperties[i].description);
     printf("Purposes:\n");
     printf("\t%s\n", VkToolPurposeFlagBitsEXT_to_string(pToolProperties[i].purposes));
     if (strnlen_s(pToolProperties[i].layer,VK_MAX_EXTENSION_NAME_SIZE) > 0) {
         printf("Corresponding Layer:\n");
         printf("\t%s\n", pToolProperties[i].layer);
     }
 }
Name String
VK_EXT_tooling_info
Extension Type
Device extension
Registered Extension Number
246
Revision
1
API Interactions
  • Interacts with VK_EXT_debug_marker
  • Interacts with VK_EXT_debug_report
  • Interacts with VK_EXT_debug_utils
Deprecation State
Contact
Other Extension Metadata
Last Modified Date
2018-11-05
Contributors
  • Rolando Caloca
  • Matthaeus Chajdas
  • Baldur Karlsson
  • Daniel Rakos