Package org.lwjgl.vulkan

Class VkBindImageMemoryDeviceGroupInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    Direct Known Subclasses:
    VkBindImageMemoryDeviceGroupInfoKHR
    public class VkBindImageMemoryDeviceGroupInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure specifying device within a group to bind to.
    Description

    If the pNext chain of VkBindImageMemoryInfo includes a VkBindImageMemoryDeviceGroupInfo structure, then that structure determines how memory is bound to images across multiple devices in a device group.

    If deviceIndexCount is greater than zero, then on device index i image is attached to the instance of the memory on the physical device with device index pDeviceIndices[i].

    Let N be the number of physical devices in the logical device. If splitInstanceBindRegionCount is greater than zero, then pSplitInstanceBindRegions is a pointer to an array of N2 rectangles, where the image region specified by the rectangle at element i*N+j in resource instance i is bound to the memory instance j. The blocks of the memory that are bound to each sparse image block region use an offset in memory, relative to memoryOffset, computed as if the whole image was being bound to a contiguous range of memory. In other words, horizontally adjacent image blocks use consecutive blocks of memory, vertically adjacent image blocks are separated by the number of bytes per block multiplied by the width in blocks of image, and the block at (0,0) corresponds to memory starting at memoryOffset.

    If splitInstanceBindRegionCount and deviceIndexCount are zero and the memory comes from a memory heap with the MEMORY_HEAP_MULTI_INSTANCE_BIT bit set, then it is as if pDeviceIndices contains consecutive indices from zero to the number of physical devices in the logical device, minus one. In other words, by default each physical device attaches to its own instance of the memory.

    If splitInstanceBindRegionCount and deviceIndexCount are zero and the memory comes from a memory heap without the MEMORY_HEAP_MULTI_INSTANCE_BIT bit set, then it is as if pDeviceIndices contains an array of zeros. In other words, by default each physical device attaches to instance zero.

    Valid Usage
    • At least one of deviceIndexCount and splitInstanceBindRegionCount must be zero
    • deviceIndexCount must either be zero or equal to the number of physical devices in the logical device
    • All elements of pDeviceIndices must be valid device indices
    • splitInstanceBindRegionCount must either be zero or equal to the number of physical devices in the logical device squared
    • Elements of pSplitInstanceBindRegions that correspond to the same instance of an image must not overlap
    • The offset.x member of any element of pSplitInstanceBindRegions must be a multiple of the sparse image block width (VkSparseImageFormatProperties::imageGranularity.width) of all non-metadata aspects of the image
    • The offset.y member of any element of pSplitInstanceBindRegions must be a multiple of the sparse image block height (VkSparseImageFormatProperties::imageGranularity.height) of all non-metadata aspects of the image
    • The extent.width member of any element of pSplitInstanceBindRegions must either be a multiple of the sparse image block width of all non-metadata aspects of the image, or else extent.width + offset.x must equal the width of the image subresource
    • The extent.height member of any element of pSplitInstanceBindRegions must either be a multiple of the sparse image block height of all non-metadata aspects of the image, or else extent.height + offset.y must equal the height of the image subresource
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO
    • If deviceIndexCount is not 0, pDeviceIndices must be a valid pointer to an array of deviceIndexCount uint32_t values
    • If splitInstanceBindRegionCount is not 0, pSplitInstanceBindRegions must be a valid pointer to an array of splitInstanceBindRegionCount VkRect2D structures
    See Also

    VkRect2D

    Layout

    
 struct VkBindImageMemoryDeviceGroupInfo {
     VkStructureType sType();
     void const * pNext();
     uint32_t deviceIndexCount();
     uint32_t const * pDeviceIndices();
     uint32_t splitInstanceBindRegionCount();
     VkRect2D const * pSplitInstanceBindRegions();
 }