vkCmdBeginGpaSampleAMD(3)

C Specification

To begin a GPA sample, call:

// Provided by VK_AMD_gpa_interface
VkResult vkCmdBeginGpaSampleAMD(
    VkCommandBuffer                             commandBuffer,
    VkGpaSessionAMD                             gpaSession,
    const VkGpaSampleBeginInfoAMD*              pGpaSampleBeginInfo,
    uint32_t*                                   pSampleID);

Parameters

commandBuffer is the command buffer into which the command will be recorded.
gpaSession is the handle of the GPA session to record the sample.
pGpaSampleBeginInfo is a pointer to a VkGpaSampleBeginInfoAMD structure describing the sample parameters.
pSampleID is the unique sample ID returned for this sample.

Description

Valid Usage (Implicit)

VUID-vkCmdBeginGpaSampleAMD-commandBuffer-parameter
commandBuffer must be a valid VkCommandBuffer handle
VUID-vkCmdBeginGpaSampleAMD-gpaSession-parameter
gpaSession must be a valid VkGpaSessionAMD handle
VUID-vkCmdBeginGpaSampleAMD-pGpaSampleBeginInfo-parameter
pGpaSampleBeginInfo must be a valid pointer to a valid VkGpaSampleBeginInfoAMD structure
VUID-vkCmdBeginGpaSampleAMD-pSampleID-parameter
pSampleID must be a valid pointer to a uint32_t value
VUID-vkCmdBeginGpaSampleAMD-commandBuffer-recording
commandBuffer must be in the recording state
VUID-vkCmdBeginGpaSampleAMD-commandBuffer-cmdpool
The VkCommandPool that commandBuffer was allocated from must support VK_QUEUE_COMPUTE_BIT, or VK_QUEUE_GRAPHICS_BIT operations
VUID-vkCmdBeginGpaSampleAMD-suspended
This command must not be called between suspended render pass instances
VUID-vkCmdBeginGpaSampleAMD-videocoding
This command must only be called outside of a video coding scope
VUID-vkCmdBeginGpaSampleAMD-commonparent
Both of commandBuffer, and gpaSession must have been created, allocated, or retrieved from the same VkDevice

Host Synchronization

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