vkCreateDebugReportCallbackEXT - Create a debug report callback object

Parameters

• instance is the instance the callback will be logged on.

• pCreateInfo is a pointer to a DebugReportCallbackCreateInfoEXT structure defining the conditions under which this callback will be called.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.
• pCallback is a pointer to a DebugReportCallbackEXT handle in which the created object is returned.

Valid Usage (Implicit)

• instance must be a valid Instance handle

• pCreateInfo must be a valid pointer to a valid DebugReportCallbackCreateInfoEXT structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pCallback must be a valid pointer to a DebugReportCallbackEXT handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY

See Also

AllocationCallbacks, DebugReportCallbackCreateInfoEXT, DebugReportCallbackEXT, Instance

A convenience wrapper to make a compatible pair of calls to createDebugReportCallbackEXT and destroyDebugReportCallbackEXT

To ensure that destroyDebugReportCallbackEXT is always called: pass bracket (or the allocate function from your favourite resource management library) as the first argument. To just extract the pair pass (,) as the first argument.

vkDestroyDebugReportCallbackEXT - Destroy a debug report callback object

Parameters

• instance is the instance where the callback was created.

• callback is the DebugReportCallbackEXT object to destroy. callback is an externally synchronized object and must not be used on more than one thread at a time. This means that destroyDebugReportCallbackEXT must not be called when a callback is active.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.

Valid Usage

• If AllocationCallbacks were provided when callback was created, a compatible set of callbacks must be provided here

• If no AllocationCallbacks were provided when callback was created, pAllocator must be NULL

Valid Usage (Implicit)

• instance must be a valid Instance handle

• If callback is not NULL_HANDLE, callback must be a valid DebugReportCallbackEXT handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If callback is a valid handle, it must have been created, allocated, or retrieved from instance

Host Synchronization

• Host access to callback must be externally synchronized

See Also

AllocationCallbacks, DebugReportCallbackEXT, Instance

vkDebugReportMessageEXT - Inject a message into a debug stream

Parameters

• instance is the debug stream’s Instance.

• flags specifies the DebugReportFlagBitsEXT classification of this event/message.
• objectType is a DebugReportObjectTypeEXT specifying the type of object being used or created at the time the event was triggered.
• object is the object where the issue was detected. object can be NULL_HANDLE if there is no object associated with the event.
• location is an application defined value.
• messageCode is an application defined value.
• pLayerPrefix is the abbreviation of the component making this event/message.
• pMessage is a null-terminated string detailing the trigger conditions.

Description

The call will propagate through the layers and generate callback(s) as indicated by the message’s flags. The parameters are passed on to the callback in addition to the pUserData value that was defined at the time the callback was registered.

Valid Usage

• object must be a Vulkan object or NULL_HANDLE

• If objectType is not DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT and object is not NULL_HANDLE, object must be a Vulkan object of the corresponding type associated with objectType as defined in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#debug-report-object-types

Valid Usage (Implicit)

• instance must be a valid Instance handle

• flags must be a valid combination of DebugReportFlagBitsEXT values
• flags must not be 0
• objectType must be a valid DebugReportObjectTypeEXT value
• pLayerPrefix must be a null-terminated UTF-8 string
• pMessage must be a null-terminated UTF-8 string

See Also

DebugReportFlagsEXT, DebugReportObjectTypeEXT, Instance

VkDebugReportCallbackCreateInfoEXT - Structure specifying parameters of a newly created debug report callback

Description

For each DebugReportCallbackEXT that is created the DebugReportCallbackCreateInfoEXT::flags determine when that DebugReportCallbackCreateInfoEXT::pfnCallback is called. When an event happens, the implementation will do a bitwise AND of the event’s DebugReportFlagBitsEXT flags to each DebugReportCallbackEXT object’s flags. For each non-zero result the corresponding callback will be called. The callback will come directly from the component that detected the event, unless some other layer intercepts the calls for its own purposes (filter them in a different way, log to a system error log, etc.).

An application may receive multiple callbacks if multiple DebugReportCallbackEXT objects were created. A callback will always be executed in the same thread as the originating Vulkan call.

A callback may be called from multiple threads simultaneously (if the application is making Vulkan calls from multiple threads).

Valid Usage (Implicit)

See Also

PFN_vkDebugReportCallbackEXT, DebugReportFlagsEXT, StructureType, createDebugReportCallbackEXT

VkDebugReportFlagBitsEXT - Bitmask specifying events which cause a debug report callback

See Also

DebugReportFlagsEXT

VkDebugReportObjectTypeEXT - Specify the type of an object handle

Description

'

DebugReportObjectTypeEXT and Vulkan Handle Relationship

Note

The primary expected use of ERROR_VALIDATION_FAILED_EXT is for validation layer testing. It is not expected that an application would see this error code during normal use of the validation layers.

See Also

DebugMarkerObjectNameInfoEXT, DebugMarkerObjectTagInfoEXT, debugReportMessageEXT

PFN_vkDebugReportCallbackEXT - Application-defined debug report callback function

Parameters

• flags specifies the DebugReportFlagBitsEXT that triggered this callback.

• objectType is a DebugReportObjectTypeEXT value specifying the type of object being used or created at the time the event was triggered.
• object is the object where the issue was detected. If objectType is DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, object is undefined.
• location is a component (layer, driver, loader) defined value specifying the location of the trigger. This is an optional value.
• messageCode is a layer-defined value indicating what test triggered this callback.
• pLayerPrefix is a null-terminated string that is an abbreviation of the name of the component making the callback. pLayerPrefix is only valid for the duration of the callback.
• pMessage is a null-terminated string detailing the trigger conditions. pMessage is only valid for the duration of the callback.
• pUserData is the user data given when the DebugReportCallbackEXT was created.

Description

The callback must not call destroyDebugReportCallbackEXT.

The callback returns a Bool32, which is interpreted in a layer-specified manner. The application should always return FALSE. The TRUE value is reserved for use in layer development.

object must be a Vulkan object or NULL_HANDLE. If objectType is not DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT and object is not NULL_HANDLE, object must be a Vulkan object of the corresponding type associated with objectType as defined in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#debug-report-object-types.

See Also

DebugReportCallbackCreateInfoEXT

VkDebugReportCallbackEXT - Opaque handle to a debug report callback object

See Also

createDebugReportCallbackEXT, destroyDebugReportCallbackEXT