# VkPipelineBinaryHandlesInfoKHR(3) Manual Page

## Name

VkPipelineBinaryHandlesInfoKHR - Structure containing newly created pipeline binaries

Loading… please wait.

## C Specification

The `VkPipelineBinaryHandlesInfoKHR` structure is defined as:

    // Provided by VK_KHR_pipeline_binary
    typedef struct VkPipelineBinaryHandlesInfoKHR {
        VkStructureType         sType;
        const void*             pNext;
        uint32_t                pipelineBinaryCount;
        VkPipelineBinaryKHR*    pPipelineBinaries;
    } VkPipelineBinaryHandlesInfoKHR;

## Members

- `sType` is a VkStructureType value identifying this structure.

- `pNext` is `NULL` or a pointer to a structure extending this structure.

- `pipelineBinaryCount` is the number of binaries associated with this pipeline or the number of entries in the `pPipelineBinaries` array.

- `pPipelineBinaries` is `NULL` or a pointer to an array of VkPipelineBinaryKHR handles in which the resulting pipeline binaries are returned.

## Description

If `pPipelineBinaries` is `NULL`, the number of binaries that would be created is returned in `pipelineBinaryCount`. Otherwise, `pipelineBinaryCount` must be the number of entries in the `pPipelineBinaries` array, and on return from vkCreatePipelineBinariesKHR `pipelineBinaryCount` is overwritten with the number of handles actually written to `pPipelineBinaries`. If the value of `pipelineBinaryCount` is less than the number of binaries that would have been created, at most `pipelineBinaryCount` handles will be written to `pPipelineBinaries` and `VK_INCOMPLETE` will be returned instead of `VK_SUCCESS`, to indicate that `pPipelineBinaries` was not large enough to create all the binaries.

Valid Usage (Implicit)

- VUID-VkPipelineBinaryHandlesInfoKHR-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR`

- VUID-VkPipelineBinaryHandlesInfoKHR-pNext-pNext
  `pNext` must be `NULL`

- VUID-VkPipelineBinaryHandlesInfoKHR-pPipelineBinaries-parameter
  If `pipelineBinaryCount` is not `0`, and `pPipelineBinaries` is not `NULL`, `pPipelineBinaries` must be a valid pointer to an array of `pipelineBinaryCount` VkPipelineBinaryKHR handles

## See Also

VK_KHR_pipeline_binary, VkPipelineBinaryKHR, VkStructureType, vkCreatePipelineBinariesKHR

## 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-2025 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0