VKMERGEPIPELINECACHE(3)

NAME
vkMergePipelineCaches - Combine the data stores of pipeline caches.

C SPECIFICATION

Pipeline cache objects can be merged using the command:

    VkResult vkMergePipelineCaches(
        VkDevice                                    device,
        VkPipelineCache                             dstCache,
        uint32_t                                    srcCacheCount,
        const VkPipelineCache*                      pSrcCaches);

PARAMETERS

    • device is the logical device that owns the pipeline cache objects.

    • dstCache is the handle of the pipeline cache to merge results into.

    • srcCacheCount is the length of the pSrcCaches array.

    • pSrcCaches is an array of pipeline cache handles, which will be merged into dstCache. The previous contents of dstCache are included after the merge.

DESCRIPTION

    Note

    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

    • device must be a valid VkDevice handle

    • dstCache must be a valid VkPipelineCache handle

    • pSrcCaches must be a pointer to an array of srcCacheCount valid VkPipelineCache 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

    • dstCache must not appear in the list of source caches

HOST SYNCHRONIZATION

    • Host access to dstCache must be externally synchronized

RETURN CODES

On success, this command returns

        • VK_SUCCESS

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

SEE ALSO

VkDevice, VkPipelineCache

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkMergePipelineCaches

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification,not directly.

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.