public Class EXTValidationCache

The extension name.

The extension specification version.

Extends VkObjectType.

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_VALIDATION_CACHE_CREATE_INFO_EXT
• STRUCTURE_TYPE_SHADER_MODULE_VALIDATION_CACHE_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_VALIDATION_CACHE_CREATE_INFO_EXT
• STRUCTURE_TYPE_SHADER_MODULE_VALIDATION_CACHE_CREATE_INFO_EXT

VkValidationCacheHeaderVersionEXT - Encode validation cache version

Description

• VALIDATION_CACHE_HEADER_VERSION_ONE_EXT specifies version one of the validation cache.

See Also

CreateValidationCacheEXT, GetValidationCacheDataEXT

Unsafe version of: CreateValidationCacheEXT

Unsafe version of: DestroyValidationCacheEXT

Unsafe version of: GetValidationCacheDataEXT

Parameters

pDataSize:long

a pointer to a value related to the amount of data in the validation cache, as described below.

Unsafe version of: MergeValidationCachesEXT

Parameters

srcCacheCount:int

the length of the pSrcCaches array.

Creates a new validation cache.

C Specification

To create validation cache objects, call:

VkResult vkCreateValidationCacheEXT(
    VkDevice                                    device,
    const VkValidationCacheCreateInfoEXT*       pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkValidationCacheEXT*                       pValidationCache);

Description

Once created, a validation cache can be passed to the vkCreateShaderModule command by adding this object to the VkShaderModuleCreateInfo structure’s pNext chain. If a VkShaderModuleValidationCacheCreateInfoEXT object is included in the VkShaderModuleCreateInfo::pNext chain, and its validationCache field is not NULL_HANDLE, the implementation will query it for possible reuse opportunities and update it with new content. The use of the validation cache object in these commands is internally synchronized, and the same validation cache object can be used in multiple threads simultaneously.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pCreateInfo must be a valid pointer to a valid VkValidationCacheCreateInfoEXT structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pValidationCache must be a valid pointer to a VkValidationCacheEXT handle

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY

See Also

VkAllocationCallbacks, VkValidationCacheCreateInfoEXT

Parameters

device:VkDevice

the logical device that creates the validation cache object.

pCreateInfo:VkValidationCacheCreateInfoEXT

a pointer to a VkValidationCacheCreateInfoEXT structure containing the initial parameters for the validation cache object.

pAllocator:VkAllocationCallbacks

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

pValidationCache:LongBuffer

a pointer to a VkValidationCacheEXT handle in which the resulting validation cache object is returned.

Annotations

@NativeType:VkResult

Array version of: CreateValidationCacheEXT

Annotations

@NativeType:VkResult

Destroy a validation cache object.

C Specification

To destroy a validation cache, call:

void vkDestroyValidationCacheEXT(
    VkDevice                                    device,
    VkValidationCacheEXT                        validationCache,
    const VkAllocationCallbacks*                pAllocator);

Valid Usage

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

Valid Usage (Implicit)

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

Host Synchronization

• Host access to validationCache must be externally synchronized

See Also

VkAllocationCallbacks

Parameters

device:VkDevice

the logical device that destroys the validation cache object.

validationCache:long

the handle of the validation cache to destroy.

pAllocator:VkAllocationCallbacks

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

Get the data store from a validation cache.

C Specification

Data can be retrieved from a validation cache object using the command:

VkResult vkGetValidationCacheDataEXT(
    VkDevice                                    device,
    VkValidationCacheEXT                        validationCache,
    size_t*                                     pDataSize,
    void*                                       pData);

Description

If pData is NULL, then the maximum size of the data that can be retrieved from the validation cache, in bytes, is returned in pDataSize. Otherwise, pDataSize must point to a variable set by the user 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 validation cache, at most pDataSize bytes will be written to pData, and vkGetValidationCacheDataEXT will return INCOMPLETE instead of SUCCESS, to indicate that not all of the validation cache was returned.

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

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

Applications can store the data retrieved from the validation cache, and use these data, possibly in a future run of the application, to populate new validation cache objects. The results of validation, however, may depend on the vendor ID, device ID, driver version, and other details of the device. To enable applications to detect when previously retrieved data is incompatible with the device, the initial bytes written to pData must be a header consisting of the following members:

Layout for validation cache header version VALIDATION_CACHE_HEADER_VERSION_ONE_EXT

The first four bytes encode the length of the entire validation cache header, in bytes. This value includes all fields in the header including the validation cache version field and the size of the length field.

The next four bytes encode the validation cache version, as described for VkValidationCacheHeaderVersionEXT. A consumer of the validation cache should use the cache version to interpret the remainder of the cache header.

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.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• validationCache must be a valid VkValidationCacheEXT 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
• validationCache must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

Parameters

device:VkDevice

the logical device that owns the validation cache.

validationCache:long

the validation cache to retrieve data from.

pDataSize:PointerBuffer

a pointer to a value related to the amount of data in the validation cache, as described below.

pData:ByteBuffer

either NULL or a pointer to a buffer.

Annotations

@NativeType:VkResult

Combine the data stores of validation caches.

C Specification

Validation cache objects can be merged using the command:

VkResult vkMergeValidationCachesEXT(
    VkDevice                                    device,
    VkValidationCacheEXT                        dstCache,
    uint32_t                                    srcCacheCount,
    const VkValidationCacheEXT*                 pSrcCaches);

Description

Valid Usage

• dstCache must not appear in the list of source caches

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• dstCache must be a valid VkValidationCacheEXT handle
• pSrcCaches must be a valid pointer to an array of srcCacheCount valid VkValidationCacheEXT 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

Host Synchronization

• Host access to dstCache must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

Parameters

device:VkDevice

the logical device that owns the validation cache objects.

dstCache:long

the handle of the validation cache to merge results into.

pSrcCaches:LongBuffer

a pointer to an array of validation cache handles, which will be merged into dstCache. The previous contents of dstCache are included after the merge.

Annotations

@NativeType:VkResult

Array version of: MergeValidationCachesEXT

Annotations

@NativeType:VkResult