vkGetExecutionGraphPipelineScratchSizeAMDX(3)

Name

vkGetExecutionGraphPipelineScratchSizeAMDX - Query scratch space required to dispatch an execution graph

C Specification

To query the scratch space required to dispatch an execution graph, call:

// Provided by VK_AMDX_shader_enqueue
VkResult vkGetExecutionGraphPipelineScratchSizeAMDX(
    VkDevice                                    device,
    VkPipeline                                  executionGraph,
    VkExecutionGraphPipelineScratchSizeAMDX*    pSizeInfo);

Parameters

  • device is the logical device that executionGraph was created on.

  • executionGraph is the execution graph pipeline to query the scratch space for.

  • pSizeInfo is a pointer to a VkExecutionGraphPipelineScratchSizeAMDX structure that will contain the required scratch size.

Description

After this function returns, information about the scratch space required will be returned in pSizeInfo.

Valid Usage (Implicit)

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

  • VUID-vkGetExecutionGraphPipelineScratchSizeAMDX-executionGraph-parameter
    executionGraph must be a valid VkPipeline handle

  • VUID-vkGetExecutionGraphPipelineScratchSizeAMDX-pSizeInfo-parameter
    pSizeInfo must be a valid pointer to a VkExecutionGraphPipelineScratchSizeAMDX structure

  • VUID-vkGetExecutionGraphPipelineScratchSizeAMDX-executionGraph-parent
    executionGraph must have been created, allocated, or retrieved from device

Return Codes
Success

  • VK_SUCCESS

Failure

  • VK_ERROR_OUT_OF_HOST_MEMORY

  • VK_ERROR_UNKNOWN

  • VK_ERROR_VALIDATION_FAILED

See Also

VK_AMDX_shader_enqueue, VkDevice, VkExecutionGraphPipelineScratchSizeAMDX, VkPipeline

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.