java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.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

The VkBindImageMemoryDeviceGroupInfo structure is defined as:
- sType is the type of this structure.
- pNext is NULL or a pointer to an extension-specific structure.
- deviceIndexCount is the number of elements in pDeviceIndices.
- pDeviceIndices is a pointer to an array of device indices.
- splitInstanceBindRegionCount is the number of elements in pSplitInstanceBindRegions.
- pSplitInstanceBindRegions is a pointer to an array of rectangles describing which regions of the image are attached to each instance of memory.
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 an array of N² 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 were 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 width 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;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkBindImageMemoryDeviceGroupInfo.Buffer
An array of VkBindImageMemoryDeviceGroupInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`DEVICEINDEXCOUNT PDEVICEINDICES PNEXT PSPLITINSTANCEBINDREGIONS`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`SPLITINSTANCEBINDREGIONCOUNT STYPE`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`VkBindImageMemoryDeviceGroupInfo(java.nio.ByteBuffer container)`	Creates a `VkBindImageMemoryDeviceGroupInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VkBindImageMemoryDeviceGroupInfo`	`calloc()`	Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated with `memCalloc`.
`static VkBindImageMemoryDeviceGroupInfo.Buffer`	`calloc(int capacity)`	Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated with `memCalloc`.
`static VkBindImageMemoryDeviceGroupInfo`	`callocStack()`	Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBindImageMemoryDeviceGroupInfo.Buffer`	`callocStack(int capacity)`	Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBindImageMemoryDeviceGroupInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBindImageMemoryDeviceGroupInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBindImageMemoryDeviceGroupInfo`	`create()`	Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated with `BufferUtils`.
`static VkBindImageMemoryDeviceGroupInfo.Buffer`	`create(int capacity)`	Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated with `BufferUtils`.
`static VkBindImageMemoryDeviceGroupInfo`	`create(long address)`	Returns a new `VkBindImageMemoryDeviceGroupInfo` instance for the specified memory address.
`static VkBindImageMemoryDeviceGroupInfo.Buffer`	`create(long address, int capacity)`	Create a `VkBindImageMemoryDeviceGroupInfo.Buffer` instance at the specified memory.
`static VkBindImageMemoryDeviceGroupInfo`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkBindImageMemoryDeviceGroupInfo.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`deviceIndexCount()`	Returns the value of the `deviceIndexCount` field.
`static VkBindImageMemoryDeviceGroupInfo`	`malloc()`	Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated with `memAlloc`.
`static VkBindImageMemoryDeviceGroupInfo.Buffer`	`malloc(int capacity)`	Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated with `memAlloc`.
`static VkBindImageMemoryDeviceGroupInfo`	`mallocStack()`	Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated on the thread-local `MemoryStack`.
`static VkBindImageMemoryDeviceGroupInfo.Buffer`	`mallocStack(int capacity)`	Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkBindImageMemoryDeviceGroupInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkBindImageMemoryDeviceGroupInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated on the specified `MemoryStack`.
`static int`	`ndeviceIndexCount(long struct)`	Unsafe version of `deviceIndexCount()`.
`static void`	`ndeviceIndexCount(long struct, int value)`	Sets the specified value to the `deviceIndexCount` field of the specified `struct`.
`static java.nio.IntBuffer`	`npDeviceIndices(long struct)`	Unsafe version of `pDeviceIndices`.
`static void`	`npDeviceIndices(long struct, java.nio.IntBuffer value)`	Unsafe version of `pDeviceIndices`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static VkRect2D.Buffer`	`npSplitInstanceBindRegions(long struct)`	Unsafe version of `pSplitInstanceBindRegions()`.
`static void`	`npSplitInstanceBindRegions(long struct, VkRect2D.Buffer value)`	Unsafe version of `pSplitInstanceBindRegions`.
`static int`	`nsplitInstanceBindRegionCount(long struct)`	Unsafe version of `splitInstanceBindRegionCount()`.
`static void`	`nsplitInstanceBindRegionCount(long struct, int value)`	Sets the specified value to the `splitInstanceBindRegionCount` field of the specified `struct`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`java.nio.IntBuffer`	`pDeviceIndices()`	Returns a `IntBuffer` view of the data pointed to by the `pDeviceIndices` field.
`VkBindImageMemoryDeviceGroupInfo`	`pDeviceIndices(java.nio.IntBuffer value)`	Sets the address of the specified `IntBuffer` to the `pDeviceIndices` field.
`long`	`pNext()`	Returns the value of the `pNext` field.
`VkBindImageMemoryDeviceGroupInfo`	`pNext(long value)`	Sets the specified value to the `pNext` field.
`VkRect2D.Buffer`	`pSplitInstanceBindRegions()`	Returns a `VkRect2D.Buffer` view of the struct array pointed to by the `pSplitInstanceBindRegions` field.
`VkBindImageMemoryDeviceGroupInfo`	`pSplitInstanceBindRegions(VkRect2D.Buffer value)`	Sets the address of the specified `VkRect2D.Buffer` to the `pSplitInstanceBindRegions` field.
`VkBindImageMemoryDeviceGroupInfo`	`set(int sType, long pNext, java.nio.IntBuffer pDeviceIndices, VkRect2D.Buffer pSplitInstanceBindRegions)`	Initializes this struct with the specified values.
`VkBindImageMemoryDeviceGroupInfo`	`set(VkBindImageMemoryDeviceGroupInfo src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`splitInstanceBindRegionCount()`	Returns the value of the `splitInstanceBindRegionCount` field.
`int`	`sType()`	Returns the value of the `sType` field.
`VkBindImageMemoryDeviceGroupInfo`	`sType(int value)`	Sets the specified value to the `sType` field.
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)`	Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, DEVICEINDEXCOUNT, PDEVICEINDICES, SPLITINSTANCEBINDREGIONCOUNT, PSPLITINSTANCEBINDREGIONS
    
    The struct member offsets.
- Constructor Detail
  - VkBindImageMemoryDeviceGroupInfo
```
public VkBindImageMemoryDeviceGroupInfo(java.nio.ByteBuffer container)
```
    Creates a VkBindImageMemoryDeviceGroupInfo instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - deviceIndexCount
```
public int deviceIndexCount()
```
    Returns the value of the deviceIndexCount field.
  - pDeviceIndices
```
@Nullable
public java.nio.IntBuffer pDeviceIndices()
```
    Returns a IntBuffer view of the data pointed to by the pDeviceIndices field.
  - splitInstanceBindRegionCount
```
public int splitInstanceBindRegionCount()
```
    Returns the value of the splitInstanceBindRegionCount field.
  - pSplitInstanceBindRegions
```
@Nullable
public VkRect2D.Buffer pSplitInstanceBindRegions()
```
    Returns a VkRect2D.Buffer view of the struct array pointed to by the pSplitInstanceBindRegions field.
  - sType
```
public VkBindImageMemoryDeviceGroupInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkBindImageMemoryDeviceGroupInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - pDeviceIndices
```
public VkBindImageMemoryDeviceGroupInfo pDeviceIndices(@Nullable
                                                       java.nio.IntBuffer value)
```
    Sets the address of the specified IntBuffer to the pDeviceIndices field.
  - pSplitInstanceBindRegions
```
public VkBindImageMemoryDeviceGroupInfo pSplitInstanceBindRegions(@Nullable
                                                                  VkRect2D.Buffer value)
```
    Sets the address of the specified VkRect2D.Buffer to the pSplitInstanceBindRegions field.
  - set
```
public VkBindImageMemoryDeviceGroupInfo set(int sType,
                                            long pNext,
                                            @Nullable
                                            java.nio.IntBuffer pDeviceIndices,
                                            @Nullable
                                            VkRect2D.Buffer pSplitInstanceBindRegions)
```
    Initializes this struct with the specified values.
  - set
```
public VkBindImageMemoryDeviceGroupInfo set(VkBindImageMemoryDeviceGroupInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkBindImageMemoryDeviceGroupInfo malloc()
```
    Returns a new VkBindImageMemoryDeviceGroupInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkBindImageMemoryDeviceGroupInfo calloc()
```
    Returns a new VkBindImageMemoryDeviceGroupInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkBindImageMemoryDeviceGroupInfo create()
```
    Returns a new VkBindImageMemoryDeviceGroupInfo instance allocated with BufferUtils.
  - create
```
public static VkBindImageMemoryDeviceGroupInfo create(long address)
```
    Returns a new VkBindImageMemoryDeviceGroupInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkBindImageMemoryDeviceGroupInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkBindImageMemoryDeviceGroupInfo.Buffer malloc(int capacity)
```
    Returns a new VkBindImageMemoryDeviceGroupInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkBindImageMemoryDeviceGroupInfo.Buffer calloc(int capacity)
```
    Returns a new VkBindImageMemoryDeviceGroupInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBindImageMemoryDeviceGroupInfo.Buffer create(int capacity)
```
    Returns a new VkBindImageMemoryDeviceGroupInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBindImageMemoryDeviceGroupInfo.Buffer create(long address,
                                                             int capacity)
```
    Create a VkBindImageMemoryDeviceGroupInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkBindImageMemoryDeviceGroupInfo.Buffer createSafe(long address,
                                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkBindImageMemoryDeviceGroupInfo mallocStack()
```
    Returns a new VkBindImageMemoryDeviceGroupInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkBindImageMemoryDeviceGroupInfo callocStack()
```
    Returns a new VkBindImageMemoryDeviceGroupInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkBindImageMemoryDeviceGroupInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindImageMemoryDeviceGroupInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkBindImageMemoryDeviceGroupInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindImageMemoryDeviceGroupInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkBindImageMemoryDeviceGroupInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkBindImageMemoryDeviceGroupInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBindImageMemoryDeviceGroupInfo.Buffer callocStack(int capacity)
```
    Returns a new VkBindImageMemoryDeviceGroupInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkBindImageMemoryDeviceGroupInfo.Buffer mallocStack(int capacity,
                                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindImageMemoryDeviceGroupInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBindImageMemoryDeviceGroupInfo.Buffer callocStack(int capacity,
                                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindImageMemoryDeviceGroupInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - ndeviceIndexCount
```
public static int ndeviceIndexCount(long struct)
```
    Unsafe version of deviceIndexCount().
  - npDeviceIndices
```
@Nullable
public static java.nio.IntBuffer npDeviceIndices(long struct)
```
    Unsafe version of pDeviceIndices.
  - nsplitInstanceBindRegionCount
```
public static int nsplitInstanceBindRegionCount(long struct)
```
    Unsafe version of splitInstanceBindRegionCount().
  - npSplitInstanceBindRegions
```
@Nullable
public static VkRect2D.Buffer npSplitInstanceBindRegions(long struct)
```
    Unsafe version of pSplitInstanceBindRegions().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - ndeviceIndexCount
```
public static void ndeviceIndexCount(long struct,
                                     int value)
```
    Sets the specified value to the deviceIndexCount field of the specified struct.
  - npDeviceIndices
```
public static void npDeviceIndices(long struct,
                                   @Nullable
                                   java.nio.IntBuffer value)
```
    Unsafe version of pDeviceIndices.
  - nsplitInstanceBindRegionCount
```
public static void nsplitInstanceBindRegionCount(long struct,
                                                 int value)
```
    Sets the specified value to the splitInstanceBindRegionCount field of the specified struct.
  - npSplitInstanceBindRegions
```
public static void npSplitInstanceBindRegions(long struct,
                                              @Nullable
                                              VkRect2D.Buffer value)
```
    Unsafe version of pSplitInstanceBindRegions.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkBindImageMemoryDeviceGroupInfo

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, DEVICEINDEXCOUNT, PDEVICEINDICES, SPLITINSTANCEBINDREGIONCOUNT, PSPLITINSTANCEBINDREGIONS

Constructor Detail

VkBindImageMemoryDeviceGroupInfo

Method Detail

sizeof

sType

pNext

deviceIndexCount

pDeviceIndices

splitInstanceBindRegionCount

pSplitInstanceBindRegions

sType

pNext

pDeviceIndices

pSplitInstanceBindRegions

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

ndeviceIndexCount

npDeviceIndices

nsplitInstanceBindRegionCount

npSplitInstanceBindRegions

nsType

npNext

ndeviceIndexCount

npDeviceIndices

nsplitInstanceBindRegionCount

npSplitInstanceBindRegions

validate

validate