public Class NVDeviceDiagnosticCheckpoints

The extension name.

The extension specification version.

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_CHECKPOINT_DATA_NV
• STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_CHECKPOINT_DATA_NV
• STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_NV

Unsafe version of: GetQueueCheckpointDataNV

Parameters

pCheckpointDataCount:long

a pointer to an integer related to the number of checkpoint markers available or queried, as described below.

Insert diagnostic checkpoint in command stream.

C Specification

Device diagnostic checkpoints are inserted into the command stream by calling CmdSetCheckpointNV.

void vkCmdSetCheckpointNV(
    VkCommandBuffer                             commandBuffer,
    const void*                                 pCheckpointMarker);

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics, compute, or transfer operations
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized
• Host access to the VkCommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

Parameters

commandBuffer:VkCommandBuffer

the command buffer that will receive the marker

pCheckpointMarker:long

an opaque application-provided value that will be associated with the checkpoint.

Retrieve diagnostic checkpoint data.

C Specification

If the device encounters an error during execution, the implementation will return a ERROR_DEVICE_LOST error to the application at a certain point during host execution. When this happens, the application can call GetQueueCheckpointDataNV to retrieve information on the most recent diagnostic checkpoints that were executed by the device.

void vkGetQueueCheckpointDataNV(
    VkQueue                                     queue,
    uint32_t*                                   pCheckpointDataCount,
    VkCheckpointDataNV*                         pCheckpointData);

Description

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 user 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

• The device that queue belongs to must be in the lost state

Valid Usage (Implicit)

• queue must be a valid VkQueue handle
• pCheckpointDataCount must be a valid pointer to a uint32_t value
• 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 VkCheckpointDataNV structures

See Also

VkCheckpointDataNV

Parameters

queue:VkQueue

the VkQueue object the caller would like to retrieve checkpoint data for

pCheckpointDataCount:IntBuffer

a pointer to an integer related to the number of checkpoint markers available or queried, as described below.

pCheckpointData:VkCheckpointDataNV.Buffer

either NULL or a pointer to an array of VkCheckpointDataNV structures.

Array version of: GetQueueCheckpointDataNV