C Specification
The definition of VkDebugUtilsMessengerCallbackDataEXT
is:
// Provided by VK_EXT_debug_utils
typedef struct VkDebugUtilsMessengerCallbackDataEXT {
VkStructureType sType;
const void* pNext;
VkDebugUtilsMessengerCallbackDataFlagsEXT flags;
const char* pMessageIdName;
int32_t messageIdNumber;
const char* pMessage;
uint32_t queueLabelCount;
const VkDebugUtilsLabelEXT* pQueueLabels;
uint32_t cmdBufLabelCount;
const VkDebugUtilsLabelEXT* pCmdBufLabels;
uint32_t objectCount;
const VkDebugUtilsObjectNameInfoEXT* pObjects;
} VkDebugUtilsMessengerCallbackDataEXT;
Members
-
sType
is a VkStructureType value identifying this structure. -
pNext
isNULL
or a pointer to a structure extending this structure. -
flags
is0
and is reserved for future use. -
pMessageIdName
is a null-terminated string that identifies the particular message ID that is associated with the provided message. If the message corresponds to a validation layer message, then this string may contain the portion of the Vulkan specification that is believed to have been violated. -
messageIdNumber
is the ID number of the triggering message. If the message corresponds to a validation layer message, then this number is related to the internal number associated with the message being triggered. -
pMessage
is a null-terminated string detailing the trigger conditions. -
queueLabelCount
is a count of items contained in thepQueueLabels
array. -
pQueueLabels
isNULL
or a pointer to an array of VkDebugUtilsLabelEXT active in the currentVkQueue
at the time the callback was triggered. Refer to Queue Labels for more information. -
cmdBufLabelCount
is a count of items contained in thepCmdBufLabels
array. -
pCmdBufLabels
isNULL
or a pointer to an array of VkDebugUtilsLabelEXT active in the currentVkCommandBuffer
at the time the callback was triggered. Refer to Command Buffer Labels for more information. -
objectCount
is a count of items contained in thepObjects
array. -
pObjects
is a pointer to an array of VkDebugUtilsObjectNameInfoEXT objects related to the detected issue. The array is roughly in order or importance, but the 0th element is always guaranteed to be the most important object for this message.
Description
Note
This structure should only be considered valid during the lifetime of the triggered callback. |
Since adding queue and command buffer labels behaves like pushing and
popping onto a stack, the order of both pQueueLabels
and
pCmdBufLabels
is based on the order the labels were defined.
The result is that the first label in either pQueueLabels
or
pCmdBufLabels
will be the first defined (and therefore the oldest)
while the last label in each list will be the most recent.
Note
Likewise, |
Document Notes
For more information, see the Vulkan Specification
This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.