VKGETPIPELINECACHEDA(3)

NAME
vkGetPipelineCacheData - Get the data store from a pipeline cache

C SPECIFICATION

    VkResult vkGetPipelineCacheData(
        VkDevice                                    device,
        VkPipelineCache                             pipelineCache,
        size_t*                                     pDataSize,
        void*                                       pData);

PARAMETERS

device
    A handle to the device that is the parent of the pipeline cache.

pipelineCache
    The pipeline cache whose data will be returned.

pDataSize
    A pointer to a variable to receive the size (in bytes) of the data retrieved from the cache.

pData
    A pointer to memory where the cache’s data will be stored.

DESCRIPTION

vkGetPipelineCacheData fills the output buffer pData with a copy of the data store of a pipeline cache, as a step in the process of the application retrieving and saving the cache data. pDataSize points to a variable that, on entry, contains the size of the data area pointed to by pData. If pData is NULL, then the initial value of the variable addressed by pDataSize is ignored and overwritten with the size of the data that would be returned. Otherwise, it is used to determine the size of data that may be written to pData, which should be large enough to receive the entire data blob.

VALID USAGE

    • device must be a valid VkDevice handle

    • pipelineCache must be a valid VkPipelineCache handle

    • pDataSize must be a pointer to a size_t value

    • If the value referenced by pDataSize is not 0, and pData is not NULL, pData must be a pointer to an array of pDataSize bytes

    • pipelineCache must have been created, allocated or retrieved from device

    • Each of device and pipelineCache must have been created, allocated or retrieved from the same VkPhysicalDevice

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

vkCreatePipelineCache, vkMergePipelineCaches

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.