VKCREATEPIPELINECACH(3)

NAME
vkCreatePipelineCache - Creates a new pipeline cache

C SPECIFICATION

    VkResult vkCreatePipelineCache(
        VkDevice                                    device,
        const VkPipelineCacheCreateInfo*            pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkPipelineCache*                            pPipelineCache);

PARAMETERS

device
    A handle to the device that will create the pipeline cache.

pCreateInfo
    A pointer to a VkPipelineCacheCreateInfo object describing the pipeline cache to be created.

pPipelineCache
    A pointer that will receive the handle to the newly created pipeline cache.

DESCRIPTION

    typedef struct VkPipelineCacheCreateInfo {
        VkStructureType               sType;
        const void*                   pNext;
        VkPipelineCacheCreateFlags    flags;
        size_t                        initialDataSize;
        const void*                   pInitialData;
    } VkPipelineCacheCreateInfo;

Create Info Details

    • initialDataSize is the size of the initial data to populate the cache.

    • pInitialData is a pointer to the initial data to populate the cache.

    • maxSize specifies an upper bound on the size the cache will grow to, with -1 indicating that the cache may grow without bound.

VALID USAGE

    • device must be a valid VkDevice handle

    • pCreateInfo must be a pointer to a valid VkPipelineCacheCreateInfo structure

    • If pAllocator is not NULL, pAllocator must be a pointer to a valid VkAllocationCallbacks structure

    • pPipelineCache must be a pointer to a VkPipelineCache handle

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

vkCreateGraphicsPipelines, vkCreateComputePipelines, vkGetPipelineCacheData, 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.