vkGetGpaSessionResultsAMD(3)

Name

vkGetGpaSessionResultsAMD - Getting the status of a GPA session

C Specification

Once a GPA session’s results are available, they can be obtained by:

// Provided by VK_AMD_gpa_interface
VkResult vkGetGpaSessionResultsAMD(
    VkDevice                                    device,
    VkGpaSessionAMD                             gpaSession,
    uint32_t                                    sampleID,
    size_t*                                     pSizeInBytes,
    void*                                       pData);

Parameters

  • device is the logical device used to create the GPA session.

  • gpaSession is the session whose results are queried.

  • sampleID is the sample ID, returned by vkCmdBeginGpaSampleAMD, whose results are to be queried.

  • pSizeInBytes is a pointer to a size_t value related to the size of the results data, as described below.

  • pData is either NULL or a pointer to an array of pSizeInBytes bytes where the results will be written.

Description

Valid Usage (Implicit)

  • VUID-vkGetGpaSessionResultsAMD-device-parameter
    device must be a valid VkDevice handle

  • VUID-vkGetGpaSessionResultsAMD-gpaSession-parameter
    gpaSession must be a valid VkGpaSessionAMD handle

  • VUID-vkGetGpaSessionResultsAMD-pSizeInBytes-parameter
    pSizeInBytes must be a valid pointer to a size_t value

  • VUID-vkGetGpaSessionResultsAMD-pData-parameter
    If the value referenced by pSizeInBytes is not 0, and pData is not NULL, pData must be a valid pointer to an array of pSizeInBytes bytes

  • VUID-vkGetGpaSessionResultsAMD-gpaSession-parent
    gpaSession must have been created, allocated, or retrieved from device

Return Codes
Success
Failure

See Also

VK_AMD_gpa_interface, VkDevice, VkGpaSessionAMD

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.