vkGetQueueCheckpointData2NV
If the device encounters an error during execution, the implementation will
return a VK_ERROR_DEVICE_LOST
error to the application at some point
during host execution.
When this happens, the application can call
vkGetQueueCheckpointData2NV to retrieve information on the most recent
diagnostic checkpoints that were executed by the device.
void vkGetQueueCheckpointData2NV(
VkQueue queue,
uint32_t* pCheckpointDataCount,
VkCheckpointData2NV* pCheckpointData);
queue
is the VkQueue object the caller would like to retrieve checkpoint data forpCheckpointDataCount
is a pointer to an integer related to the number of checkpoint markers available or queried, as described below.pCheckpointData
is eitherNULL
or a pointer to an array ofVkCheckpointData2NV
structures.
If pCheckpointData
is NULL
, then the number of checkpoint markers
available is returned in pCheckpointDataCount
.
Otherwise, pCheckpointDataCount
must point to a variable set by the
application to the number of elements in the pCheckpointData
array,
and on return the variable is overwritten with the number of structures
actually written to pCheckpointData
.
If pCheckpointDataCount
is less than the number of checkpoint markers
available, at most pCheckpointDataCount
structures will be written.
Valid Usage
VUID-vkGetQueueCheckpointData2NV-queue-03892
The device that queue
belongs to must be in the lost state
Valid Usage (Implicit)
VUID-vkGetQueueCheckpointData2NV-queue-parameter
queue
must be a valid VkQueue handle
VUID-vkGetQueueCheckpointData2NV-pCheckpointDataCount-parameter
pCheckpointDataCount
must be a valid pointer to a uint32_t
value
VUID-vkGetQueueCheckpointData2NV-pCheckpointData-parameter
If the value referenced by pCheckpointDataCount
is not 0
, and pCheckpointData
is not NULL
, pCheckpointData
must be a valid pointer to an array of pCheckpointDataCount
VkCheckpointData2NV structures