vkCmdEndShaderInstrumentationARM(3)

Name

vkCmdEndShaderInstrumentationARM - End shader instrumentation

C Specification

To end shader instrumentation, call:

// Provided by VK_ARM_shader_instrumentation
void vkCmdEndShaderInstrumentationARM(
    VkCommandBuffer                             commandBuffer);

Parameters

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

Description

Once recorded, shader instrumentation is no longer considered active within the command buffer.

Valid Usage
  • VUID-vkCmdEndShaderInstrumentationARM-commandBuffer-12377
    Shader instrumentation must be active within commandBuffer

  • VUID-vkCmdEndShaderInstrumentationARM-commandBuffer-12378
    commandBuffer must not be a protected command buffer

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

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

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

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

  • VUID-vkCmdEndShaderInstrumentationARM-videocoding
    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
Command Buffer Levels Render Pass Scope Video Coding Scope Supported Queue Types Command Type

Primary
Secondary

Both

Outside

VK_QUEUE_COMPUTE_BIT
VK_QUEUE_DATA_GRAPH_BIT_ARM
VK_QUEUE_GRAPHICS_BIT

Action
State

Conditional Rendering

vkCmdEndShaderInstrumentationARM is not affected by conditional rendering

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.