VkSparseImageMemoryBindInfo(3)

Name

VkSparseImageMemoryBindInfo - Structure specifying sparse image memory bind information

C Specification

Memory can be bound to sparse image blocks of VkImage objects created with the VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT flag using the following structure:

// Provided by VK_VERSION_1_0
typedef struct VkSparseImageMemoryBindInfo {
    VkImage                           image;
    uint32_t                          bindCount;
    const VkSparseImageMemoryBind*    pBinds;
} VkSparseImageMemoryBindInfo;

Members

Description

Valid Usage

  • VUID-VkSparseImageMemoryBindInfo-subresource-01722
    The subresource.mipLevel member of each element of pBinds must be less than the mipLevels specified in VkImageCreateInfo when image was created

  • VUID-VkSparseImageMemoryBindInfo-subresource-01723
    The subresource.arrayLayer member of each element of pBinds must be less than the arrayLayers specified in VkImageCreateInfo when image was created

  • VUID-VkSparseImageMemoryBindInfo-subresource-01106
    The subresource.aspectMask member of each element of pBinds must be valid for the format specified in VkImageCreateInfo when image was created

  • VUID-VkSparseImageMemoryBindInfo-image-02901
    image must have been created with VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT set

Valid Usage (Implicit)

  • VUID-VkSparseImageMemoryBindInfo-image-parameter
    image must be a valid VkImage handle

  • VUID-VkSparseImageMemoryBindInfo-pBinds-parameter
    pBinds must be a valid pointer to an array of bindCount valid VkSparseImageMemoryBind structures

  • VUID-VkSparseImageMemoryBindInfo-bindCount-arraylength
    bindCount must be greater than 0

See Also

VK_VERSION_1_0, VkBindSparseInfo, VkImage, VkSparseImageMemoryBind

Document Notes

For more information, see the Vulkan Specification.

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