VkDeviceGroupBindSparseInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkDeviceGroupBindSparseInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkDeviceGroupBindSparseInfoKHR
```
public class VkDeviceGroupBindSparseInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure indicating which instances are bound.
Description

These device indices apply to all buffer and image memory binds included in the batch pointing to this structure. The semaphore waits and signals for the batch are executed only by the physical device specified by the resourceDeviceIndex.

If this structure is not present, resourceDeviceIndex and memoryDeviceIndex are assumed to be zero.

Valid Usage
- resourceDeviceIndex and memoryDeviceIndex must both be valid device indices.
- Each memory allocation bound in this batch must have allocated an instance for memoryDeviceIndex.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- resourceDeviceIndex – a device index indicating which instance of the resource is bound.
- memoryDeviceIndex – a device index indicating which instance of the memory the resource instance is bound to.
Layout
```
 struct VkDeviceGroupBindSparseInfo {
     VkStructureType sType;
     void const * pNext;
     uint32_t resourceDeviceIndex;
     uint32_t memoryDeviceIndex;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkDeviceGroupBindSparseInfo.Buffer` An array of `VkDeviceGroupBindSparseInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`MEMORYDEVICEINDEX` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`RESOURCEDEVICEINDEX` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`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 and Description
`VkDeviceGroupBindSparseInfo(java.nio.ByteBuffer container)` Creates a `VkDeviceGroupBindSparseInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkDeviceGroupBindSparseInfo`	`calloc()` Returns a new `VkDeviceGroupBindSparseInfo` instance allocated with `memCalloc`.
`static VkDeviceGroupBindSparseInfo.Buffer`	`calloc(int capacity)` Returns a new `VkDeviceGroupBindSparseInfo.Buffer` instance allocated with `memCalloc`.
`static VkDeviceGroupBindSparseInfo`	`callocStack()` Returns a new `VkDeviceGroupBindSparseInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupBindSparseInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkDeviceGroupBindSparseInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupBindSparseInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupBindSparseInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupBindSparseInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupBindSparseInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupBindSparseInfo`	`create()` Returns a new `VkDeviceGroupBindSparseInfo` instance allocated with `BufferUtils`.
`static VkDeviceGroupBindSparseInfo.Buffer`	`create(int capacity)` Returns a new `VkDeviceGroupBindSparseInfo.Buffer` instance allocated with `BufferUtils`.
`static VkDeviceGroupBindSparseInfo`	`create(long address)` Returns a new `VkDeviceGroupBindSparseInfo` instance for the specified memory address.
`static VkDeviceGroupBindSparseInfo.Buffer`	`create(long address, int capacity)` Create a `VkDeviceGroupBindSparseInfo.Buffer` instance at the specified memory.
`static VkDeviceGroupBindSparseInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDeviceGroupBindSparseInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDeviceGroupBindSparseInfo`	`malloc()` Returns a new `VkDeviceGroupBindSparseInfo` instance allocated with `memAlloc`.
`static VkDeviceGroupBindSparseInfo.Buffer`	`malloc(int capacity)` Returns a new `VkDeviceGroupBindSparseInfo.Buffer` instance allocated with `memAlloc`.
`static VkDeviceGroupBindSparseInfo`	`mallocStack()` Returns a new `VkDeviceGroupBindSparseInfo` instance allocated on the thread-local `MemoryStack`.
`static VkDeviceGroupBindSparseInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkDeviceGroupBindSparseInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDeviceGroupBindSparseInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupBindSparseInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDeviceGroupBindSparseInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupBindSparseInfo` instance allocated on the specified `MemoryStack`.
`int`	`memoryDeviceIndex()` Returns the value of the `memoryDeviceIndex` field.
`VkDeviceGroupBindSparseInfo`	`memoryDeviceIndex(int value)` Sets the specified value to the `memoryDeviceIndex` field.
`static int`	`nmemoryDeviceIndex(long struct)` Unsafe version of `memoryDeviceIndex()`.
`static void`	`nmemoryDeviceIndex(long struct, int value)` Unsafe version of `memoryDeviceIndex`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nresourceDeviceIndex(long struct)` Unsafe version of `resourceDeviceIndex()`.
`static void`	`nresourceDeviceIndex(long struct, int value)` Unsafe version of `resourceDeviceIndex`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkDeviceGroupBindSparseInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`int`	`resourceDeviceIndex()` Returns the value of the `resourceDeviceIndex` field.
`VkDeviceGroupBindSparseInfo`	`resourceDeviceIndex(int value)` Sets the specified value to the `resourceDeviceIndex` field.
`VkDeviceGroupBindSparseInfo`	`set(int sType, long pNext, int resourceDeviceIndex, int memoryDeviceIndex)` Initializes this struct with the specified values.
`VkDeviceGroupBindSparseInfo`	`set(VkDeviceGroupBindSparseInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkDeviceGroupBindSparseInfo`	`sType(int value)` Sets the specified value to the `sType` field.

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

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

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - RESOURCEDEVICEINDEX
```
public static final int RESOURCEDEVICEINDEX
```
    The struct member offsets.
  - MEMORYDEVICEINDEX
```
public static final int MEMORYDEVICEINDEX
```
    The struct member offsets.
- Constructor Detail
  - VkDeviceGroupBindSparseInfo
```
public VkDeviceGroupBindSparseInfo(java.nio.ByteBuffer container)
```
    Creates a VkDeviceGroupBindSparseInfo 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.
  - resourceDeviceIndex
```
public int resourceDeviceIndex()
```
    Returns the value of the resourceDeviceIndex field.
  - memoryDeviceIndex
```
public int memoryDeviceIndex()
```
    Returns the value of the memoryDeviceIndex field.
  - sType
```
public VkDeviceGroupBindSparseInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkDeviceGroupBindSparseInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - resourceDeviceIndex
```
public VkDeviceGroupBindSparseInfo resourceDeviceIndex(int value)
```
    Sets the specified value to the resourceDeviceIndex field.
  - memoryDeviceIndex
```
public VkDeviceGroupBindSparseInfo memoryDeviceIndex(int value)
```
    Sets the specified value to the memoryDeviceIndex field.
  - set
```
public VkDeviceGroupBindSparseInfo set(int sType,
                                       long pNext,
                                       int resourceDeviceIndex,
                                       int memoryDeviceIndex)
```
    Initializes this struct with the specified values.
  - set
```
public VkDeviceGroupBindSparseInfo set(VkDeviceGroupBindSparseInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkDeviceGroupBindSparseInfo malloc()
```
    Returns a new VkDeviceGroupBindSparseInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDeviceGroupBindSparseInfo calloc()
```
    Returns a new VkDeviceGroupBindSparseInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDeviceGroupBindSparseInfo create()
```
    Returns a new VkDeviceGroupBindSparseInfo instance allocated with BufferUtils.
  - create
```
public static VkDeviceGroupBindSparseInfo create(long address)
```
    Returns a new VkDeviceGroupBindSparseInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkDeviceGroupBindSparseInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkDeviceGroupBindSparseInfo.Buffer malloc(int capacity)
```
    Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDeviceGroupBindSparseInfo.Buffer calloc(int capacity)
```
    Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDeviceGroupBindSparseInfo.Buffer create(int capacity)
```
    Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDeviceGroupBindSparseInfo.Buffer create(long address,
                                                        int capacity)
```
    Create a VkDeviceGroupBindSparseInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkDeviceGroupBindSparseInfo.Buffer createSafe(long address,
                                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkDeviceGroupBindSparseInfo mallocStack()
```
    Returns a new VkDeviceGroupBindSparseInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDeviceGroupBindSparseInfo callocStack()
```
    Returns a new VkDeviceGroupBindSparseInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDeviceGroupBindSparseInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDeviceGroupBindSparseInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDeviceGroupBindSparseInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDeviceGroupBindSparseInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkDeviceGroupBindSparseInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDeviceGroupBindSparseInfo.Buffer callocStack(int capacity)
```
    Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDeviceGroupBindSparseInfo.Buffer mallocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDeviceGroupBindSparseInfo.Buffer callocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDeviceGroupBindSparseInfo.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().
  - nresourceDeviceIndex
```
public static int nresourceDeviceIndex(long struct)
```
    Unsafe version of resourceDeviceIndex().
  - nmemoryDeviceIndex
```
public static int nmemoryDeviceIndex(long struct)
```
    Unsafe version of memoryDeviceIndex().
  - 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.
  - nresourceDeviceIndex
```
public static void nresourceDeviceIndex(long struct,
                                        int value)
```
    Unsafe version of resourceDeviceIndex.
  - nmemoryDeviceIndex
```
public static void nmemoryDeviceIndex(long struct,
                                      int value)
```
    Unsafe version of memoryDeviceIndex.

Class VkDeviceGroupBindSparseInfo

Description

Valid Usage

Valid Usage (Implicit)

Member documentation

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 class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

RESOURCEDEVICEINDEX

MEMORYDEVICEINDEX

Constructor Detail

VkDeviceGroupBindSparseInfo

Method Detail

sizeof

sType

pNext

resourceDeviceIndex

memoryDeviceIndex

sType

pNext

resourceDeviceIndex

memoryDeviceIndex

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nresourceDeviceIndex

nmemoryDeviceIndex

nsType

npNext

nresourceDeviceIndex

nmemoryDeviceIndex