C Specification

To release pipeline resources captured with VK_PIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR, call:

// Provided by VK_KHR_pipeline_binary
VkResult vkReleaseCapturedPipelineDataKHR(
    VkDevice                                    device,
    const VkReleaseCapturedPipelineDataInfoKHR* pInfo,
    const VkAllocationCallbacks*                pAllocator);

Parameters

  • device is the logical device that created the pipeline object.

  • pInfo is a pointer to a VkReleaseCapturedPipelineDataInfoKHR structure which describes the pipeline to release the data from.

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

Description

The implementation may free any resources captured as a result of creating the pipeline with VK_PIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR and put the pipeline into a state as if VK_PIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR had not been provided at pipeline creation time.

Note

Any resources captured as a result of creating the pipeline with VK_PIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR are implicitly freed by vkDestroyPipeline.
Valid Usage

  • VUID-vkReleaseCapturedPipelineDataKHR-pipeline-09611
    If VkAllocationCallbacks were provided when pipeline was created, a compatible set of callbacks must be provided in pAllocator

  • VUID-vkReleaseCapturedPipelineDataKHR-pipeline-09612
    If no VkAllocationCallbacks were provided when pipeline was created, pAllocator must be NULL

Valid Usage (Implicit)

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

  • VUID-vkReleaseCapturedPipelineDataKHR-pInfo-parameter
    pInfo must be a valid pointer to a valid VkReleaseCapturedPipelineDataInfoKHR structure

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

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

See Also

VK_KHR_pipeline_binary, VkAllocationCallbacks, VkDevice, VkReleaseCapturedPipelineDataInfoKHR

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

Copyright 2014-2026 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0