vkGetDeviceFaultDebugInfoKHR(3)

Name

vkGetDeviceFaultDebugInfoKHR - Retrieve vendor-specific crash dump data for the specified logical device

C Specification

To retrieve a vendor-specific binary crash dump call:

// Provided by VK_KHR_device_fault
VkResult vkGetDeviceFaultDebugInfoKHR(
    VkDevice                                    device,
    VkDeviceFaultDebugInfoKHR*                  pDebugInfo);

Parameters

device is the logical device from which to query the crash dump.
pDebugInfo is a pointer to a VkDeviceFaultDebugInfoKHR structure which will be populated with the vendor binary data crash dump binary, as described below.

Description

If pDebugInfo->pVendorBinaryData is NULL, then the size of any vendor-specific binary crash dump is returned in pDebugInfo->vendorBinarySize.

If the pDebugInfo->pVendorBinaryData is not NULL then it must point to a buffer of size pDebugInfo->vendorBinarySize bytes.

On return, pDebugInfo->vendorBinarySize will be overwritten with the number of bytes actually written to the pDebugInfo->pVendorBinaryData.

If pDebugInfo->vendorBinaryData is not NULL, then subsequent calls to vkGetDeviceFaultDebugInfoKHR for the same device must return identical binary values in the pDebugInfo->pVendorBinaryData buffer up to the limit defined by pDebugInfo->vendorBinarySize.

If the vendor-specific crash dumps feature is not enabled, then implementations must set pDebugInfo->vendorBinarySize to zero and must not modify pDebugInfo->pVendorBinaryData.

Valid Usage

VUID-vkGetDeviceFaultDebugInfoKHR-device-12383
device must be lost

Valid Usage (Implicit)

VUID-vkGetDeviceFaultDebugInfoKHR-device-parameter
device must be a valid VkDevice handle
VUID-vkGetDeviceFaultDebugInfoKHR-pDebugInfo-parameter
pDebugInfo must be a valid pointer to a VkDeviceFaultDebugInfoKHR structure

Return Codes

Success

Failure

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.