VkSparseImageOpaqueMemoryBindInfo(3)

# VkSparseImageOpaqueMemoryBindInfo(3) Manual Page

## Name

VkSparseImageOpaqueMemoryBindInfo - Structure specifying sparse image opaque memory bind info

## C Specification

Memory is bound to opaque regions of `VkImage` objects created with the `VK_IMAGE_CREATE_SPARSE_BINDING_BIT` flag using the following structure:

    typedef struct VkSparseImageOpaqueMemoryBindInfo {
        VkImage                      image;
        uint32_t                     bindCount;
        const VkSparseMemoryBind*    pBinds;
    } VkSparseImageOpaqueMemoryBindInfo;

## Members

- `image` is the VkImage object to be bound.

- `bindCount` is the number of VkSparseMemoryBind structures in the `pBinds` array.

- `pBinds` is a pointer to an array of VkSparseMemoryBind structures.

## Description

Valid Usage

- If the `flags` member of any element of `pBinds` contains `VK_SPARSE_MEMORY_BIND_METADATA_BIT`, the binding range defined must be within the mip tail region of the metadata aspect of `image`

Valid Usage (Implicit)

- `image` must be a valid VkImage handle

- `pBinds` must be a valid pointer to an array of `bindCount` valid VkSparseMemoryBind structures

- `bindCount` must be greater than `0`

## See Also

VkBindSparseInfo, VkImage, VkSparseMemoryBind

## 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.

## Copyright

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