VkBindBufferMemoryDeviceGroupInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkBindBufferMemoryDeviceGroupInfoKHR
```
public class VkBindBufferMemoryDeviceGroupInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying device within a group to bind to.
Description

The VkBindBufferMemoryDeviceGroupInfo 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.
If deviceIndexCount is greater than zero, then on device index i the buffer is attached to the instance of memory on the physical device with device index pDeviceIndices[i].

If deviceIndexCount is zero and 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 memory.

If deviceIndexCount is zero and 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
- 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
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO
- If deviceIndexCount is not 0, pDeviceIndices must be a valid pointer to an array of deviceIndexCount uint32_t values
Layout
```
 struct VkBindBufferMemoryDeviceGroupInfo {
     VkStructureType sType;
     void const * pNext;
     uint32_t deviceIndexCount;
     uint32_t const * pDeviceIndices;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkBindBufferMemoryDeviceGroupInfo.Buffer
An array of VkBindBufferMemoryDeviceGroupInfo 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`	`VkBindBufferMemoryDeviceGroupInfo.Buffer` An array of `VkBindBufferMemoryDeviceGroupInfo` structs.

Field Summary

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

Description

Valid Usage

Valid Usage (Implicit)

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

DEVICEINDEXCOUNT

PDEVICEINDICES

Constructor Detail

VkBindBufferMemoryDeviceGroupInfo

Method Detail

sizeof

sType

pNext

deviceIndexCount

pDeviceIndices

sType

pNext

pDeviceIndices

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

ndeviceIndexCount

npDeviceIndices

nsType

npNext

ndeviceIndexCount

npDeviceIndices

validate

validate