Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBindBufferMemoryDeviceGroupInfo

extends Struct<VkBindBufferMemoryDeviceGroupInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkBindBufferMemoryDeviceGroupInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying device within a group to bind to.
Description

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

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
Valid Usage (Implicit)

Layout


struct VkBindBufferMemoryDeviceGroupInfo {
    VkStructureType sType;
    void const * pNext;
    uint32_t deviceIndexCount;
    uint32_t const * pDeviceIndices;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DEVICEINDEXCOUNT

The struct member offsets.

public static final int
PDEVICEINDICES

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkBindBufferMemoryDeviceGroupInfo(ByteBuffer container)

Creates a VkBindBufferMemoryDeviceGroupInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkBindBufferMemoryDeviceGroupInfo
calloc()

Returns a new VkBindBufferMemoryDeviceGroupInfo instance allocated with memCalloc.

public static VkBindBufferMemoryDeviceGroupInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance allocated with memCalloc.

public static VkBindBufferMemoryDeviceGroupInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkBindBufferMemoryDeviceGroupInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkBindBufferMemoryDeviceGroupInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkBindBufferMemoryDeviceGroupInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindBufferMemoryDeviceGroupInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindBufferMemoryDeviceGroupInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindBufferMemoryDeviceGroupInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkBindBufferMemoryDeviceGroupInfo
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkBindBufferMemoryDeviceGroupInfo
create()

Returns a new VkBindBufferMemoryDeviceGroupInfo instance allocated with BufferUtils.

public static VkBindBufferMemoryDeviceGroupInfo
create(long address)

Returns a new VkBindBufferMemoryDeviceGroupInfo instance for the specified memory address.

public static VkBindBufferMemoryDeviceGroupInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance allocated with BufferUtils.

public static VkBindBufferMemoryDeviceGroupInfo.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkBindBufferMemoryDeviceGroupInfo.Buffer instance at the specified memory.

public static VkBindBufferMemoryDeviceGroupInfo
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkBindBufferMemoryDeviceGroupInfo.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
deviceIndexCount()

the number of elements in pDeviceIndices.

public static VkBindBufferMemoryDeviceGroupInfo
malloc()

Returns a new VkBindBufferMemoryDeviceGroupInfo instance allocated with memAlloc.

public static VkBindBufferMemoryDeviceGroupInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance allocated with memAlloc.

public static VkBindBufferMemoryDeviceGroupInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkBindBufferMemoryDeviceGroupInfo instance allocated on the specified MemoryStack.

public static VkBindBufferMemoryDeviceGroupInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance allocated on the specified MemoryStack.

public static VkBindBufferMemoryDeviceGroupInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindBufferMemoryDeviceGroupInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindBufferMemoryDeviceGroupInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindBufferMemoryDeviceGroupInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
ndeviceIndexCount(long struct)

Unsafe version of deviceIndexCount.

public static void
ndeviceIndexCount(long struct, int value)

Sets the specified value to the deviceIndexCount field of the specified struct.

public static IntBuffer
npDeviceIndices(long struct)

Unsafe version of pDeviceIndices.

public static void
npDeviceIndices(long struct, IntBuffer value)

Unsafe version of pDeviceIndices.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public IntBuffer
pDeviceIndices()

a pointer to an array of device indices.

public VkBindBufferMemoryDeviceGroupInfo
pDeviceIndices(IntBuffer value)

Sets the address of the specified IntBuffer to the pDeviceIndices field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkBindBufferMemoryDeviceGroupInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkBindBufferMemoryDeviceGroupInfo
set(int sType, long pNext, IntBuffer pDeviceIndices)

Initializes this struct with the specified values.

public VkBindBufferMemoryDeviceGroupInfo

Returns:

this struct
set
(VkBindBufferMemoryDeviceGroupInfo
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkBindBufferMemoryDeviceGroupInfo
sType(int value)

Sets the specified value to the sType field.

public VkBindBufferMemoryDeviceGroupInfo
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DEVICEINDEXCOUNTback to summary
public static final int DEVICEINDEXCOUNT

The struct member offsets.

PDEVICEINDICESback to summary
public static final int PDEVICEINDICES

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkBindBufferMemoryDeviceGroupInfoback to summary
protected VkBindBufferMemoryDeviceGroupInfo(long address, ByteBuffer container)
VkBindBufferMemoryDeviceGroupInfoback to summary
public VkBindBufferMemoryDeviceGroupInfo(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

callocback to summary
public static VkBindBufferMemoryDeviceGroupInfo calloc()

Returns a new VkBindBufferMemoryDeviceGroupInfo instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkBindBufferMemoryDeviceGroupInfo.Buffer calloc(int capacity)

Returns a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkBindBufferMemoryDeviceGroupInfo calloc(MemoryStack stack)

Returns a new VkBindBufferMemoryDeviceGroupInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkBindBufferMemoryDeviceGroupInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkBindBufferMemoryDeviceGroupInfo callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkBindBufferMemoryDeviceGroupInfo callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkBindBufferMemoryDeviceGroupInfo.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkBindBufferMemoryDeviceGroupInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkBindBufferMemoryDeviceGroupInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkBindBufferMemoryDeviceGroupInfo create()

Returns a new VkBindBufferMemoryDeviceGroupInfo instance allocated with BufferUtils.

createback to summary
public static VkBindBufferMemoryDeviceGroupInfo create(long address)

Returns a new VkBindBufferMemoryDeviceGroupInfo instance for the specified memory address.

createback to summary
public static VkBindBufferMemoryDeviceGroupInfo.Buffer create(int capacity)

Returns a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkBindBufferMemoryDeviceGroupInfo.Buffer create(long address, int capacity)

Create a VkBindBufferMemoryDeviceGroupInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkBindBufferMemoryDeviceGroupInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkBindBufferMemoryDeviceGroupInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
deviceIndexCountback to summary
public int deviceIndexCount()

the number of elements in pDeviceIndices.

Annotations
@NativeType:uint32_t
mallocback to summary
public static VkBindBufferMemoryDeviceGroupInfo malloc()

Returns a new VkBindBufferMemoryDeviceGroupInfo instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkBindBufferMemoryDeviceGroupInfo.Buffer malloc(int capacity)

Returns a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkBindBufferMemoryDeviceGroupInfo malloc(MemoryStack stack)

Returns a new VkBindBufferMemoryDeviceGroupInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkBindBufferMemoryDeviceGroupInfo.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkBindBufferMemoryDeviceGroupInfo mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkBindBufferMemoryDeviceGroupInfo mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkBindBufferMemoryDeviceGroupInfo.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkBindBufferMemoryDeviceGroupInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
ndeviceIndexCountback to summary
public static int ndeviceIndexCount(long struct)

Unsafe version of deviceIndexCount.

ndeviceIndexCountback to summary
public static void ndeviceIndexCount(long struct, int value)

Sets the specified value to the deviceIndexCount field of the specified struct.

npDeviceIndicesback to summary
public static IntBuffer npDeviceIndices(long struct)

Unsafe version of pDeviceIndices.

Annotations
@Nullable
npDeviceIndicesback to summary
public static void npDeviceIndices(long struct, IntBuffer value)

Unsafe version of pDeviceIndices.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pDeviceIndicesback to summary
public IntBuffer pDeviceIndices()

a pointer to an array of device indices.

Annotations
@Nullable
@NativeType:uint32_t const *
pDeviceIndicesback to summary
public VkBindBufferMemoryDeviceGroupInfo pDeviceIndices(IntBuffer value)

Sets the address of the specified IntBuffer to the pDeviceIndices field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkBindBufferMemoryDeviceGroupInfo pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkBindBufferMemoryDeviceGroupInfo set(int sType, long pNext, IntBuffer pDeviceIndices)

Initializes this struct with the specified values.

setback to summary
public VkBindBufferMemoryDeviceGroupInfo set(VkBindBufferMemoryDeviceGroupInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkBindBufferMemoryDeviceGroupInfo

the source struct

Returns:VkBindBufferMemoryDeviceGroupInfo

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkBindBufferMemoryDeviceGroupInfo sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkBindBufferMemoryDeviceGroupInfo sType$Default()

Sets the STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkBindBufferMemoryDeviceGroupInfo.Buffer

extends StructBuffer<VkBindBufferMemoryDeviceGroupInfo, VkBindBufferMemoryDeviceGroupInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkBindBufferMemoryDeviceGroupInfoKHR.Buffer

An array of VkBindBufferMemoryDeviceGroupInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkBindBufferMemoryDeviceGroupInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int
protected VkBindBufferMemoryDeviceGroupInfo
public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the VkBindBufferMemoryDeviceGroupInfo#pDeviceIndices field.
pDeviceIndices
()

public VkBindBufferMemoryDeviceGroupInfo.Buffer
pDeviceIndices(IntBuffer value)

Sets the address of the specified IntBuffer to the VkBindBufferMemoryDeviceGroupInfo#pDeviceIndices field.

public long

Returns:

the value of the VkBindBufferMemoryDeviceGroupInfo#pNext field.
pNext
()

public VkBindBufferMemoryDeviceGroupInfo.Buffer
pNext(long value)

Sets the specified value to the VkBindBufferMemoryDeviceGroupInfo#pNext field.

protected VkBindBufferMemoryDeviceGroupInfo.Buffer
public int

Returns:

the value of the VkBindBufferMemoryDeviceGroupInfo#sType field.
sType
()

public VkBindBufferMemoryDeviceGroupInfo.Buffer
sType(int value)

Sets the specified value to the VkBindBufferMemoryDeviceGroupInfo#sType field.

public VkBindBufferMemoryDeviceGroupInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkBindBufferMemoryDeviceGroupInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkBindBufferMemoryDeviceGroupInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkBindBufferMemoryDeviceGroupInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

deviceIndexCountback to summary
public int deviceIndexCount()
Returns:int

the value of the VkBindBufferMemoryDeviceGroupInfo#deviceIndexCount field.

Annotations
@NativeType:uint32_t
getElementFactoryback to summary
protected VkBindBufferMemoryDeviceGroupInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pDeviceIndicesback to summary
public IntBuffer pDeviceIndices()
Returns:IntBuffer

a IntBuffer view of the data pointed to by the VkBindBufferMemoryDeviceGroupInfo#pDeviceIndices field.

Annotations
@Nullable
@NativeType:uint32_t const *
pDeviceIndicesback to summary
public VkBindBufferMemoryDeviceGroupInfo.Buffer pDeviceIndices(IntBuffer value)

Sets the address of the specified IntBuffer to the VkBindBufferMemoryDeviceGroupInfo#pDeviceIndices field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkBindBufferMemoryDeviceGroupInfo#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkBindBufferMemoryDeviceGroupInfo.Buffer pNext(long value)

Sets the specified value to the VkBindBufferMemoryDeviceGroupInfo#pNext field.

selfback to summary
protected VkBindBufferMemoryDeviceGroupInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkBindBufferMemoryDeviceGroupInfo#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkBindBufferMemoryDeviceGroupInfo.Buffer sType(int value)

Sets the specified value to the VkBindBufferMemoryDeviceGroupInfo#sType field.

sType$Defaultback to summary
public VkBindBufferMemoryDeviceGroupInfo.Buffer sType$Default()

Sets the STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO value to the VkBindBufferMemoryDeviceGroupInfo#sType field.