C Specification

To begin a GPA session, call:

// Provided by VK_AMD_gpa_interface
VkResult vkCmdBeginGpaSessionAMD(
    VkCommandBuffer                             commandBuffer,
    VkGpaSessionAMD                             gpaSession);

Parameters

  • commandBuffer is the command buffer into which the command will be recorded.

  • gpaSession is the handle of the GPA session to begin.

Description

Valid Usage
  • VUID-vkCmdBeginGpaSessionAMD-gpaSession-12409
    If gpaSession has been used previously to begin and end a session, vkResetGpaSessionAMD must have first been called

  • VUID-vkCmdBeginGpaSessionAMD-commandBuffer-12410
    If another GPA session has been started with vkCmdBeginGpaSessionAMD in commandBuffer, it must have been ended using vkCmdEndGpaSessionAMD before this call

Valid Usage (Implicit)
  • VUID-vkCmdBeginGpaSessionAMD-commandBuffer-parameter
    commandBuffer must be a valid VkCommandBuffer handle

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

  • VUID-vkCmdBeginGpaSessionAMD-commandBuffer-recording
    commandBuffer must be in the recording state

  • VUID-vkCmdBeginGpaSessionAMD-commandBuffer-cmdpool
    The VkCommandPool that commandBuffer was allocated from must support VK_QUEUE_COMPUTE_BIT, or VK_QUEUE_GRAPHICS_BIT operations

  • VUID-vkCmdBeginGpaSessionAMD-suspended
    This command must not be called between suspended render pass instances

  • VUID-vkCmdBeginGpaSessionAMD-videocoding
    This command must only be called outside of a video coding scope

  • VUID-vkCmdBeginGpaSessionAMD-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

Command Properties
Command Buffer Levels Render Pass Scope Video Coding Scope Supported Queue Types Command Type

Primary
Secondary

Both

Outside

VK_QUEUE_COMPUTE_BIT
VK_QUEUE_GRAPHICS_BIT

Action
State

Conditional Rendering

vkCmdBeginGpaSessionAMD is not affected by conditional rendering

Return Codes
On success, this command returns
On failure, this command returns

See Also

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.

Copyright 2014-2026 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0