vkCreateShaderInstrumentationARM(3)

Name

vkCreateShaderInstrumentationARM - Create a new shader instrumentation object

C Specification

To create a shader instrumentation object, call:

// Provided by VK_ARM_shader_instrumentation
VkResult vkCreateShaderInstrumentationARM(
    VkDevice                                    device,
    const VkShaderInstrumentationCreateInfoARM* pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkShaderInstrumentationARM*                 pInstrumentation);

Parameters

  • device is the logical device that creates the shader instrumentation object.

  • pCreateInfo is a pointer to a VkShaderInstrumentationCreateInfoARM structure containing information about how the shader instrumentation object is to be created.

  • pAllocator controls host memory allocation as described in the Memory Allocation chapter.

  • pInstrumentation is a pointer to a handle in which the resulting shader instrumentation object is returned.

Description

Valid Usage
Valid Usage (Implicit)

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

  • VUID-vkCreateShaderInstrumentationARM-pCreateInfo-parameter
    pCreateInfo must be a valid pointer to a valid VkShaderInstrumentationCreateInfoARM structure

  • VUID-vkCreateShaderInstrumentationARM-pAllocator-parameter
    If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure

  • VUID-vkCreateShaderInstrumentationARM-pInstrumentation-parameter
    pInstrumentation must be a valid pointer to a VkShaderInstrumentationARM handle

  • VUID-vkCreateShaderInstrumentationARM-device-queuecount
    The device must have been created with at least 1 queue

Return Codes
Success
Failure

See Also

VK_ARM_shader_instrumentation, VkAllocationCallbacks, VkDevice, VkShaderInstrumentationARM, VkShaderInstrumentationCreateInfoARM

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.