vkCreatePipelineBinariesKHR(3)

Name

vkCreatePipelineBinariesKHR - Create pipeline binaries from a pipeline or previously retrieved data

C Specification

To create pipeline binary objects, call:

// Provided by VK_KHR_pipeline_binary
VkResult vkCreatePipelineBinariesKHR(
    VkDevice                                    device,
    const VkPipelineBinaryCreateInfoKHR*        pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkPipelineBinaryHandlesInfoKHR*             pBinaries);

Parameters

  • device is the logical device that creates the pipeline binary objects.

  • pCreateInfo is a pointer to a VkPipelineBinaryCreateInfoKHR structure that contains the data to create the pipeline binaries from.

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

  • pBinaries is a pointer to a VkPipelineBinaryHandlesInfoKHR structure in which the resulting pipeline binaries are returned.

Description

The implementation will attempt to create all pipeline binaries. If creation fails for any pipeline binary, then:

Valid Usage (Implicit)

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

  • VUID-vkCreatePipelineBinariesKHR-pCreateInfo-parameter
    pCreateInfo must be a valid pointer to a valid VkPipelineBinaryCreateInfoKHR structure

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

  • VUID-vkCreatePipelineBinariesKHR-pBinaries-parameter
    pBinaries must be a valid pointer to a VkPipelineBinaryHandlesInfoKHR structure

Return Codes
Success
Failure

See Also

VK_KHR_pipeline_binary, VkAllocationCallbacks, VkDevice, VkPipelineBinaryCreateInfoKHR, VkPipelineBinaryHandlesInfoKHR

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.