API_Specification » APISpec_Debugging module

Chapter 42: Specification

Contents

Classes

struct VV::V1::DebugUtils::Label
Used in conjunction with labeling queues, and commands.
struct VV::V1::DebugUtils::ObjectInfo
Used for annotating objects with user defined information.
struct VV::V1::DebugUtils::Messenger::CallbackData
Specification
struct VV::V1::DebugUtils::Messenger::CallbackDelegate
The prototype for the CreateInfo::UserCallback function implemented by the application.
struct VV::V1::DebugUtils::Messenger
Vulkan allows an application to register multiple callbacks with any Vulkan component wishing to report debug information. Some callbacks may log the information to a file, others may cause a debug break point or other application defined behavior.
struct VV::V1::DebugUtils
Debug Utilities: Flexible utilities for debugging an application.
struct VV::V2::DebugUtils
Debug Utilities: Flexible utilities for debugging an application.
struct VV::V3::DebugUtils
Debug Utilities: Flexible utilities for debugging an application.

Enums

enum class EDebugUtils_MessageSeverity: ui32 { Verbose = VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT, Info = VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT, Warning = VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT, Error = VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT, VV_SpecifyBitmaskable = VK_DEBUG_UTILS_MESSAGE_SEVERITY_FLAG_BITS_MAX_ENUM_EXT }
Specification
enum class EDebugUtils_MessageType: ui32 { General = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT, Validation = VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT, Performance = VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT, VV_SpecifyBitmaskable = VK_DEBUG_UTILS_MESSAGE_TYPE_FLAG_BITS_MAX_ENUM_EXT }
Specification
enum class EObjectType: ui32 { Unknown = VK_OBJECT_TYPE_UNKNOWN, Instance = VK_OBJECT_TYPE_INSTANCE, PhysicalDevice = VK_OBJECT_TYPE_PHYSICAL_DEVICE, Device = VK_OBJECT_TYPE_DEVICE, Queue = VK_OBJECT_TYPE_QUEUE, Semaphore = VK_OBJECT_TYPE_SEMAPHORE, CommandBuffer = VK_OBJECT_TYPE_COMMAND_BUFFER, Fence = VK_OBJECT_TYPE_FENCE, DeviceMemory = VK_OBJECT_TYPE_DEVICE_MEMORY, Buffer = VK_OBJECT_TYPE_BUFFER, Image = VK_OBJECT_TYPE_IMAGE, Event = VK_OBJECT_TYPE_EVENT, QueryPool = VK_OBJECT_TYPE_QUERY_POOL, BufferView = VK_OBJECT_TYPE_BUFFER_VIEW, ImageView = VK_OBJECT_TYPE_IMAGE_VIEW, ShaderModule = VK_OBJECT_TYPE_SHADER_MODULE, PipelineCache = VK_OBJECT_TYPE_PIPELINE_CACHE, PipelineLayout = VK_OBJECT_TYPE_PIPELINE_LAYOUT, RenderPass = VK_OBJECT_TYPE_RENDER_PASS, Pipeline = VK_OBJECT_TYPE_PIPELINE, DescriptorSetLayout = VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT, Sampler = VK_OBJECT_TYPE_SAMPLER, DescriptorPool = VK_OBJECT_TYPE_DESCRIPTOR_POOL, DescriptorSet = VK_OBJECT_TYPE_DESCRIPTOR_SET, FrameBuffer = VK_OBJECT_TYPE_FRAMEBUFFER, CommandPool = VK_OBJECT_TYPE_COMMAND_POOL, Sampler_YCBCR_Conversion = VK_OBJECT_TYPE_SAMPLER_YCBCR_CONVERSION, DescriptorUpdateTemplate = VK_OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE, Surface_KHR = VK_OBJECT_TYPE_SURFACE_KHR, SwapChain_KHR = VK_OBJECT_TYPE_SWAPCHAIN_KHR, Display_KHR = VK_OBJECT_TYPE_DISPLAY_KHR, DisplayMode_KHR = VK_OBJECT_TYPE_DISPLAY_MODE_KHR, DebugReportCallback_EXT = VK_OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT, DebugUtilsMessenger_EXT = VK_OBJECT_TYPE_DEBUG_UTILS_MESSENGER_EXT, AccelerationStructure_KHR = VK_OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR, ValidationCache_EXT = VK_OBJECT_TYPE_VALIDATION_CACHE_EXT, Intel_PerformanceConfiguration = VK_OBJECT_TYPE_PERFORMANCE_CONFIGURATION_INTEL, DeferredOperation_KHR = VK_OBJECT_TYPE_DEFERRED_OPERATION_KHR, IndirectCommandsLayout = VK_OBJECT_TYPE_INDIRECT_COMMANDS_LAYOUT_NV, PrivateDataSlot_EXT = 1000295000, DescriptorUpdateTemplate_KHR = VK_OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_KHR, Sampler_YCBCR_Conversion_KHR = VK_OBJECT_TYPE_SAMPLER_YCBCR_CONVERSION_KHR, AccelerationStructure = VK_OBJECT_TYPE_ACCELERATION_STRUCTURE_NV }
Specification

Typedefs

using Handle = VkDebugUtilsMessengerEXT
Specification
using FPtr_Create = PFN_vkCreateDebugUtilsMessengerEXT
Pointer to the create debug messenger function.
using FPtr_Destroy = PFN_vkDestroyDebugUtilsMessengerEXT
Pointer to the destroy debug messenger function.
using ServerityFlags = Bitfield<EServerity, VkDebugUtilsMessageSeverityFlagsEXT>
Specification

Enum documentation

Typedef documentation

using Handle = VkDebugUtilsMessengerEXT

Specification

using FPtr_Create = PFN_vkCreateDebugUtilsMessengerEXT

Pointer to the create debug messenger function.

The create messenger function is not provided automatically from the Vulkan API and must be retrieved with AppInstance's GetProcedureAddress function.

using FPtr_Destroy = PFN_vkDestroyDebugUtilsMessengerEXT

Pointer to the destroy debug messenger function.

The destroy messenger function is not provided automatically from the Vulkan API and must be retrieved with AppInstance's GetProcedureAddress function.

using ServerityFlags = Bitfield<EServerity, VkDebugUtilsMessageSeverityFlagsEXT>

Specification