vkCreateDebugReportCallbackEXT - Create a debug report callback object

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

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

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

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