Package org.lwjgl.vulkan

Class KHRPipelineBinary

java.lang.Object

org.lwjgl.vulkan.KHRPipelineBinary

public class KHRPipelineBinary
extends Object

This extension provides a method to obtain binary data associated with individual pipelines such that applications can manage caching themselves instead of using VkPipelineCache objects.

Name String

VK_KHR_pipeline_binary

Extension Type

Device extension

Registered Extension Number

484

Revision

1

Extension and Version Dependencies

VK_KHR_maintenance5

Contact

• Stu Smith stu-s

Extension Proposal

VK_KHR_pipeline_binary

Other Extension Metadata

Last Modified Date

2024-07-01

Contributors

• Stu Smith, AMD
• Tobias Hector, AMD
• Alan Harrison, AMD
• Maciej Jesionowski, AMD
• Younggwan Kim, Arm
• Jan-Harald Fredriksen, Arm
• Ting Wei, Arm
• Chris Glover, Google
• Shahbaz Youssefi, Google
• Jakub Kuderski, Google
• Piotr Byszewski, Mobica
• Piers Daniell, NVIDIA
• Ralph Potter, Samsung
• Matthew Netsch, Qualcomm
• Hans-Kristian Arntzen, Valve
• Samuel Pitoiset, Valve
• Tatsuyuki Ishi, Valve

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_ERROR_NOT_ENOUGH_SPACE_KHR	Extends VkResult.
static final String	VK_KHR_PIPELINE_BINARY_EXTENSION_NAME	The extension name.
static final int	VK_KHR_PIPELINE_BINARY_SPEC_VERSION	The extension specification version.
static final int	VK_MAX_PIPELINE_BINARY_KEY_SIZE_KHR	VK_MAX_PIPELINE_BINARY_KEY_SIZE_KHR
static final int	VK_OBJECT_TYPE_PIPELINE_BINARY_KHR	Extends VkObjectType.
static final int	VK_PIPELINE_BINARY_MISSING_KHR	Extends VkResult.
static final long	VK_PIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR	Extends VkPipelineCreateFlagBits2.
static final int	VK_STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkCreatePipelineBinariesKHR(org.lwjgl.vulkan.VkDevice device, long pCreateInfo, long pAllocator, long pBinaries)	Unsafe version of: CreatePipelineBinariesKHR
static void	nvkDestroyPipelineBinaryKHR(org.lwjgl.vulkan.VkDevice device, long pipelineBinary, long pAllocator)	Unsafe version of: DestroyPipelineBinaryKHR
static int	nvkGetPipelineBinaryDataKHR(org.lwjgl.vulkan.VkDevice device, long pInfo, long pPipelineBinaryKey, long pPipelineBinaryDataSize, long pPipelineBinaryData)	Unsafe version of: GetPipelineBinaryDataKHR
static int	nvkGetPipelineKeyKHR(org.lwjgl.vulkan.VkDevice device, long pPipelineCreateInfo, long pPipelineKey)	Unsafe version of: GetPipelineKeyKHR
static int	nvkReleaseCapturedPipelineDataKHR(org.lwjgl.vulkan.VkDevice device, long pInfo, long pAllocator)	Unsafe version of: ReleaseCapturedPipelineDataKHR
static int	vkCreatePipelineBinariesKHR(org.lwjgl.vulkan.VkDevice device, VkPipelineBinaryCreateInfoKHR pCreateInfo, @Nullable VkAllocationCallbacks pAllocator, VkPipelineBinaryHandlesInfoKHR pBinaries)	Create pipeline binaries from a pipeline or previously retrieved data.
static void	vkDestroyPipelineBinaryKHR(org.lwjgl.vulkan.VkDevice device, long pipelineBinary, @Nullable VkAllocationCallbacks pAllocator)	Destroy a pipeline binary.
static int	vkGetPipelineBinaryDataKHR(org.lwjgl.vulkan.VkDevice device, VkPipelineBinaryDataInfoKHR pInfo, VkPipelineBinaryKeyKHR pPipelineBinaryKey, org.lwjgl.PointerBuffer pPipelineBinaryDataSize, @Nullable ByteBuffer pPipelineBinaryData)	Get the data store from a pipeline binary.
static int	vkGetPipelineKeyKHR(org.lwjgl.vulkan.VkDevice device, @Nullable VkPipelineCreateInfoKHR pPipelineCreateInfo, VkPipelineBinaryKeyKHR pPipelineKey)	Generate the pipeline key from pipeline creation info.
static int	vkReleaseCapturedPipelineDataKHR(org.lwjgl.vulkan.VkDevice device, VkReleaseCapturedPipelineDataInfoKHR pInfo, @Nullable VkAllocationCallbacks pAllocator)	Release captured pipeline binary data.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_KHR_PIPELINE_BINARY_SPEC_VERSION

public static final int VK_KHR_PIPELINE_BINARY_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_KHR_PIPELINE_BINARY_EXTENSION_NAME

public static final String VK_KHR_PIPELINE_BINARY_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_MAX_PIPELINE_BINARY_KEY_SIZE_KHR

public static final int VK_MAX_PIPELINE_BINARY_KEY_SIZE_KHR

VK_MAX_PIPELINE_BINARY_KEY_SIZE_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR
• STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR
• STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR
• STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR

public static final int VK_STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR
• STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR
• STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR

public static final int VK_STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR
• STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR
• STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR
• STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR

public static final int VK_STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR
• STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_KEY_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_BINARY_PROPERTIES_KHR
• STRUCTURE_TYPE_RELEASE_CAPTURED_PIPELINE_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_DATA_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_PIPELINE_BINARY_INTERNAL_CACHE_CONTROL_KHR
• STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR

See Also:

• Constant Field Values

VK_OBJECT_TYPE_PIPELINE_BINARY_KHR

public static final int VK_OBJECT_TYPE_PIPELINE_BINARY_KHR

Extends VkObjectType.

See Also:

• Constant Field Values

VK_PIPELINE_BINARY_MISSING_KHR

public static final int VK_PIPELINE_BINARY_MISSING_KHR

Extends VkResult.

Enum values:

• PIPELINE_BINARY_MISSING_KHR
• ERROR_NOT_ENOUGH_SPACE_KHR

See Also:

• Constant Field Values

VK_ERROR_NOT_ENOUGH_SPACE_KHR

public static final int VK_ERROR_NOT_ENOUGH_SPACE_KHR

Extends VkResult.

Enum values:

• PIPELINE_BINARY_MISSING_KHR
• ERROR_NOT_ENOUGH_SPACE_KHR

See Also:

• Constant Field Values

VK_PIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR

public static final long VK_PIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR

Extends VkPipelineCreateFlagBits2.

See Also:

• Constant Field Values

Method Details

nvkCreatePipelineBinariesKHR

public static int nvkCreatePipelineBinariesKHR(org.lwjgl.vulkan.VkDevice device,
 long pCreateInfo,
 long pAllocator,
 long pBinaries)

Unsafe version of: CreatePipelineBinariesKHR

vkCreatePipelineBinariesKHR

public static int vkCreatePipelineBinariesKHR(org.lwjgl.vulkan.VkDevice device,
 VkPipelineBinaryCreateInfoKHR pCreateInfo,
 @Nullable VkAllocationCallbacks pAllocator,
 VkPipelineBinaryHandlesInfoKHR pBinaries)

Create pipeline binaries from a pipeline or previously retrieved data.

C Specification

To create pipeline binary objects, call:

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

Description

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

• The corresponding entry in the pPipelineBinaries output array will be filled with NULL_HANDLE.
• The VkResult returned by CreatePipelineBinariesKHR will contain the error value for the first entry in the output array in pBinaries containing NULL_HANDLE.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pCreateInfo must be a valid pointer to a valid VkPipelineBinaryCreateInfoKHR structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pBinaries must be a valid pointer to a VkPipelineBinaryHandlesInfoKHR structure

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE
• PIPELINE_BINARY_MISSING_KHR

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INITIALIZATION_FAILED

See Also

VkAllocationCallbacks, VkPipelineBinaryCreateInfoKHR, VkPipelineBinaryHandlesInfoKHR

Parameters:

device - the logical device that creates the pipeline binary objects.

pCreateInfo - 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 - a pointer to a VkPipelineBinaryHandlesInfoKHR structure in which the resulting pipeline binaries are returned.

nvkDestroyPipelineBinaryKHR

public static void nvkDestroyPipelineBinaryKHR(org.lwjgl.vulkan.VkDevice device,
 long pipelineBinary,
 long pAllocator)

Unsafe version of: DestroyPipelineBinaryKHR

vkDestroyPipelineBinaryKHR

public static void vkDestroyPipelineBinaryKHR(org.lwjgl.vulkan.VkDevice device,
 long pipelineBinary,
 @Nullable VkAllocationCallbacks pAllocator)

Destroy a pipeline binary.

C Specification

To destroy a VkPipelineBinaryKHR, call:

 void vkDestroyPipelineBinaryKHR(
     VkDevice                                    device,
     VkPipelineBinaryKHR                         pipelineBinary,
     const VkAllocationCallbacks*                pAllocator);

Valid Usage

• If VkAllocationCallbacks were provided when pipelineBinary was created, a compatible set of callbacks must be provided here
• If no VkAllocationCallbacks were provided when pipelineBinary was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• If pipelineBinary is not NULL_HANDLE, pipelineBinary must be a valid VkPipelineBinaryKHR handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• If pipelineBinary is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to pipelineBinary must be externally synchronized

See Also

VkAllocationCallbacks

Parameters:

device - the logical device that created the pipeline binary object.

pipelineBinary - the handle of the pipeline binary object to destroy.

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

nvkGetPipelineKeyKHR

public static int nvkGetPipelineKeyKHR(org.lwjgl.vulkan.VkDevice device,
 long pPipelineCreateInfo,
 long pPipelineKey)

Unsafe version of: GetPipelineKeyKHR

vkGetPipelineKeyKHR

public static int vkGetPipelineKeyKHR(org.lwjgl.vulkan.VkDevice device,
 @Nullable VkPipelineCreateInfoKHR pPipelineCreateInfo,
 VkPipelineBinaryKeyKHR pPipelineKey)

Generate the pipeline key from pipeline creation info.

C Specification

To generate the key for a particular pipeline creation info, call:

 VkResult vkGetPipelineKeyKHR(
     VkDevice                                    device,
     const VkPipelineCreateInfoKHR*              pPipelineCreateInfo,
     VkPipelineBinaryKeyKHR*                     pPipelineKey);

Description

If pPipelineCreateInfo is NULL, then the implementation must return the global key that applies to all pipelines. If the key obtained in this way changes between saving and restoring data obtained from GetPipelineBinaryDataKHR in a different VkDevice, then the application must assume that the restored data is invalid and cannot be passed to CreatePipelineBinariesKHR. Otherwise the application can assume the data is still valid.

If pPipelineCreateInfo is not NULL, the key obtained functions as a method to compare two pipeline creation info structures. Implementations may not compare parts of a pipeline creation info which would not contribute to the final binary output. If a shader module identifier is used instead of a shader module, the pPipelineKey generated must be equal to the key generated when using the shader module from which the identifier was queried. If the content of two pPipelineKey are equal, pipelines created with the two pPipelineCreateInfo→pname:pNext create infos must produce the same VkPipelineBinaryKHR contents.

The pipeline key is distinct from pipeline binary key. Pipeline binary keys can only be obtained after compilation. The pipeline key is intended to optionally allow associating pipeline create info with multiple pipeline binary keys.

Valid Usage

• The pNext chain of pPipelineCreateInfo must not set VkPipelineBinaryInfoKHR::binaryCount to a value greater than 0

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• If pPipelineCreateInfo is not NULL, pPipelineCreateInfo must be a valid pointer to a valid VkPipelineCreateInfoKHR structure
• pPipelineKey must be a valid pointer to a VkPipelineBinaryKeyKHR structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkPipelineBinaryKeyKHR, VkPipelineCreateInfoKHR

Parameters:

device - the logical device that creates the pipeline object.

pPipelineCreateInfo - NULL or a pointer to a VkPipelineCreateInfoKHR structure.

pPipelineKey - a pointer to a VkPipelineBinaryKeyKHR structure in which the resulting key is returned.

nvkGetPipelineBinaryDataKHR

public static int nvkGetPipelineBinaryDataKHR(org.lwjgl.vulkan.VkDevice device,
 long pInfo,
 long pPipelineBinaryKey,
 long pPipelineBinaryDataSize,
 long pPipelineBinaryData)

Unsafe version of: GetPipelineBinaryDataKHR

Parameters:

pPipelineBinaryDataSize - a pointer to a size_t value related to the amount of data in the pipeline binary, as described below.

vkGetPipelineBinaryDataKHR

public static int vkGetPipelineBinaryDataKHR(org.lwjgl.vulkan.VkDevice device,
 VkPipelineBinaryDataInfoKHR pInfo,
 VkPipelineBinaryKeyKHR pPipelineBinaryKey,
 org.lwjgl.PointerBuffer pPipelineBinaryDataSize,
 @Nullable ByteBuffer pPipelineBinaryData)

Get the data store from a pipeline binary.

C Specification

Data can be retrieved from a pipeline binary object using the command:

 VkResult vkGetPipelineBinaryDataKHR(
     VkDevice                                    device,
     const VkPipelineBinaryDataInfoKHR*          pInfo,
     VkPipelineBinaryKeyKHR*                     pPipelineBinaryKey,
     size_t*                                     pPipelineBinaryDataSize,
     void*                                       pPipelineBinaryData);

Description

If pPipelineBinaryData is NULL, then the size of the data, in bytes, that is required to store the binary is returned in pPipelineBinaryDataSize. Otherwise, pPipelineBinaryDataSize must contain the size of the buffer, in bytes, pointed to by pPipelineBinaryData, and on return pPipelineBinaryDataSize is overwritten with the size of the data, in bytes, that is required to store the binary. If pPipelineBinaryDataSize is less than the size that is required to store the binary, nothing is written to pPipelineBinaryData and ERROR_NOT_ENOUGH_SPACE_KHR will be returned, instead of SUCCESS.

If the call returns one of the success return codes, the pipeline binary key is written to pPipelineBinaryKey, regardless of whether pPipelineBinaryData is NULL or not.

If pipelineBinaryCompressedData is FALSE, implementations should not return compressed pipeline binary data to the application.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pInfo must be a valid pointer to a valid VkPipelineBinaryDataInfoKHR structure
• pPipelineBinaryKey must be a valid pointer to a VkPipelineBinaryKeyKHR structure
• pPipelineBinaryDataSize must be a valid pointer to a size_t value
• If the value referenced by pPipelineBinaryDataSize is not 0, and pPipelineBinaryData is not NULL, pPipelineBinaryData must be a valid pointer to an array of pPipelineBinaryDataSize bytes

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_NOT_ENOUGH_SPACE_KHR

See Also

VkPipelineBinaryDataInfoKHR, VkPipelineBinaryKeyKHR

Parameters:

device - the logical device that created the pipeline binary.

pInfo - a pointer to a VkPipelineBinaryDataInfoKHR structure which describes the pipeline binary to get data from.

pPipelineBinaryKey - a pointer to a VkPipelineBinaryKeyKHR structure where the key for this binary will be written.

pPipelineBinaryDataSize - a pointer to a size_t value related to the amount of data in the pipeline binary, as described below.

pPipelineBinaryData - either NULL or a pointer to a buffer.

nvkReleaseCapturedPipelineDataKHR

public static int nvkReleaseCapturedPipelineDataKHR(org.lwjgl.vulkan.VkDevice device,
 long pInfo,
 long pAllocator)

Unsafe version of: ReleaseCapturedPipelineDataKHR

vkReleaseCapturedPipelineDataKHR

public static int vkReleaseCapturedPipelineDataKHR(org.lwjgl.vulkan.VkDevice device,
 VkReleaseCapturedPipelineDataInfoKHR pInfo,
 @Nullable VkAllocationCallbacks pAllocator)

Release captured pipeline binary data.

C Specification

To release pipeline resources captured with PIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR, call:

 VkResult vkReleaseCapturedPipelineDataKHR(
     VkDevice                                    device,
     const VkReleaseCapturedPipelineDataInfoKHR* pInfo,
     const VkAllocationCallbacks*                pAllocator);

Description

The implementation may free any resources captured as a result of creating the pipeline with PIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR and put the pipeline into a state as if 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 PIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR are implicitly freed by DestroyPipeline.

Valid Usage

• If VkAllocationCallbacks were provided when pipeline was created, a compatible set of callbacks must be provided in pAllocator
• If no VkAllocationCallbacks were provided when pipeline was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pInfo must be a valid pointer to a valid VkReleaseCapturedPipelineDataInfoKHR structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure

Host Synchronization

• Host access to pInfo→pipeline must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

See Also

VkAllocationCallbacks, VkReleaseCapturedPipelineDataInfoKHR

Parameters:

device - the logical device that created the pipeline object.

pInfo - 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.