vkCreatePipelineCache - Creates a new pipeline cache

Description

Applications can track and manage the total host memory size of a pipeline cache object using the pAllocator. Applications can limit the amount of data retrieved from a pipeline cache object in getPipelineCacheData. Implementations should not internally limit the total number of entries added to a pipeline cache object or the total host memory consumed.

Once created, a pipeline cache can be passed to the createGraphicsPipelines createRayTracingPipelinesKHR, createRayTracingPipelinesNV, createDataGraphPipelinesARM, and createComputePipelines commands. If the pipeline cache passed into these commands is not NULL_HANDLE, the implementation will query it for possible reuse opportunities and update it with new content. The use of the pipeline cache object in these commands is internally synchronized, and the same pipeline cache object can be used in multiple threads simultaneously.

If flags of pCreateInfo includes PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT, all commands that modify the returned pipeline cache object must be externally synchronized.

Implementations should make every effort to limit any critical sections to the actual accesses to the cache, which is expected to be significantly shorter than the duration of the vkCreate*Pipelines commands.

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid PipelineCacheCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pPipelineCache must be a valid pointer to a PipelineCache handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, PipelineCache, PipelineCacheCreateInfo

A convenience wrapper to make a compatible pair of calls to createPipelineCache and destroyPipelineCache

To ensure that destroyPipelineCache is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkDestroyPipelineCache - Destroy a pipeline cache object

Valid Usage

• If AllocationCallbacks were provided when pipelineCache was created, a compatible set of callbacks must be provided here

• If no AllocationCallbacks were provided when pipelineCache was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If pipelineCache is not NULL_HANDLE, pipelineCache must be a valid PipelineCache handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If pipelineCache is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to pipelineCache must be externally synchronized

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, PipelineCache

vkGetPipelineCacheData - Get the data store from a pipeline cache

Description

If pData is NULL, then the maximum size of the data that can be retrieved from the pipeline cache, in bytes, is returned in pDataSize. Otherwise, pDataSize must point to a variable set by the application to the size of the buffer, in bytes, pointed to by pData, and on return the variable is overwritten with the amount of data actually written to pData. If pDataSize is less than the maximum size that can be retrieved by the pipeline cache, at most pDataSize bytes will be written to pData, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all of the pipeline cache was returned.

Any data written to pData is valid and can be provided as the pInitialData member of the PipelineCacheCreateInfo structure passed to createPipelineCache.

Two calls to getPipelineCacheData with the same parameters must retrieve the same data unless a command that modifies the contents of the cache is called between them.

The initial bytes written to pData must be a header as described in the Pipeline Cache Header section.

If pDataSize is less than what is necessary to store this header, nothing will be written to pData and zero will be written to pDataSize.

This query does not behave consistently with the behavior described in Opaque Binary Data Results, for historical reasons.

If the amount of data available is larger than the passed pDataSize, the query returns up to the size of the passed buffer, and signals overflow with a INCOMPLETE success status instead of returning a ERROR_NOT_ENOUGH_SPACE_KHR error status.

Valid Usage

• pipelineCache must not have been created with the headerVersion member of PipelineCacheCreateInfo::pInitialData equal to PIPELINE_CACHE_HEADER_VERSION_DATA_GRAPH_QCOM

Valid Usage (Implicit)

• device must be a valid Device handle

• pipelineCache must be a valid PipelineCache handle
• pDataSize must be a valid pointer to a size_t value
• If the value referenced by pDataSize is not 0, and pData is not NULL, pData must be a valid pointer to an array of pDataSize bytes
• pipelineCache must have been created, allocated, or retrieved from device

Return Codes

Success

• INCOMPLETE
• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, Device, PipelineCache

vkMergePipelineCaches - Combine the data stores of pipeline caches

Description

The details of the merge operation are implementation-dependent, but implementations should merge the contents of the specified pipelines and prune duplicate entries.

Valid Usage

• dstCache must not appear in the list of source caches

• Host access to dstCache must be externally synchronized if it was not created with PIPELINE_CACHE_CREATE_INTERNALLY_SYNCHRONIZED_MERGE_BIT_KHR
• dstCache must not have been created with the headerVersion member of PipelineCacheCreateInfo::pInitialData equal to PIPELINE_CACHE_HEADER_VERSION_DATA_GRAPH_QCOM
• Each member of pSrcCaches must not have been created with the headerVersion member of PipelineCacheCreateInfo::pInitialData equal to PIPELINE_CACHE_HEADER_VERSION_DATA_GRAPH_QCOM

Valid Usage (Implicit)

• device must be a valid Device handle

• dstCache must be a valid PipelineCache handle
• pSrcCaches must be a valid pointer to an array of srcCacheCount valid PipelineCache handles
• srcCacheCount must be greater than 0
• dstCache must have been created, allocated, or retrieved from device
• Each element of pSrcCaches must have been created, allocated, or retrieved from device

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, Device, PipelineCache

VkPipelineCacheCreateInfo - Structure specifying parameters of a newly created pipeline cache

Members

• sType is a StructureType value identifying this structure.

• pNext is NULL or a pointer to a structure extending this structure.
• flags is a bitmask of PipelineCacheCreateFlagBits specifying the behavior of the pipeline cache.
• initialDataSize is the number of bytes in pInitialData. If initialDataSize is zero, the pipeline cache will initially be empty.
• pInitialData is a pointer to previously retrieved pipeline cache data. If the pipeline cache data is incompatible (as defined below) with the device, the pipeline cache will be initially empty. If initialDataSize is zero, pInitialData is ignored.

Valid Usage

• If initialDataSize is not 0, it must be equal to the size of pInitialData, as returned by getPipelineCacheData when pInitialData was originally retrieved

• If initialDataSize is not 0, pInitialData must have been retrieved from a previous call to getPipelineCacheData
• If the pipelineCreationCacheControl feature is not enabled, flags must not include PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT
• If the maintenance8 feature is not enabled, flags must not include PIPELINE_CACHE_CREATE_INTERNALLY_SYNCHRONIZED_MERGE_BIT_KHR
• If flags includes PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT, it must not include PIPELINE_CACHE_CREATE_INTERNALLY_SYNCHRONIZED_MERGE_BIT_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO

• pNext must be NULL
• flags must be a valid combination of PipelineCacheCreateFlagBits values
• If initialDataSize is not 0, pInitialData must be a valid pointer to an array of initialDataSize bytes

See Also

VK_VERSION_1_0, PipelineCacheCreateFlags, StructureType, createPipelineCache

VkPipelineCache - Opaque handle to a pipeline cache object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_VERSION_1_0, createComputePipelines, createDataGraphPipelinesARM, createExecutionGraphPipelinesAMDX, createGraphicsPipelines, createPipelineCache, createRayTracingPipelinesKHR, createRayTracingPipelinesNV, destroyPipelineCache, getPipelineCacheData, mergePipelineCaches

VkPipelineCacheCreateFlagBits - Bitmask specifying the behavior of the pipeline cache

Description

• PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT specifies that all commands that modify the created PipelineCache will be externally synchronized. When set, the implementation may skip any unnecessary processing needed to support simultaneous modification from multiple threads where allowed.

• PIPELINE_CACHE_CREATE_INTERNALLY_SYNCHRONIZED_MERGE_BIT_KHR specifies that when the created PipelineCache is used as the dstCache parameter of mergePipelineCaches, it does not need to be externally synchronized. This flag is mutually exclusive with PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT.

See Also

VK_EXT_pipeline_creation_cache_control, VK_KHR_maintenance8, VK_VERSION_1_3, PipelineCacheCreateFlags