Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDeviceGroupBindSparseInfo

extends Struct<VkDeviceGroupBindSparseInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkDeviceGroupBindSparseInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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
Valid Usage (Implicit)

Layout


struct VkDeviceGroupBindSparseInfo {
    VkStructureType sType;
    void const * pNext;
    uint32_t resourceDeviceIndex;
    uint32_t memoryDeviceIndex;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkDeviceGroupBindSparseInfo.Buffer

An array of VkDeviceGroupBindSparseInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MEMORYDEVICEINDEX

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
RESOURCEDEVICEINDEX

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
VkDeviceGroupBindSparseInfo(long address, ByteBuffer container)

public
VkDeviceGroupBindSparseInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDeviceGroupBindSparseInfo
calloc()

Returns a new VkDeviceGroupBindSparseInfo instance allocated with memCalloc.

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

Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDeviceGroupBindSparseInfo
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkDeviceGroupBindSparseInfo
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 VkDeviceGroupBindSparseInfo
create()

Returns a new VkDeviceGroupBindSparseInfo instance allocated with BufferUtils.

public static VkDeviceGroupBindSparseInfo
create(long address)

Returns a new VkDeviceGroupBindSparseInfo instance for the specified memory address.

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

Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated with BufferUtils.

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

Create a VkDeviceGroupBindSparseInfo.Buffer instance at the specified memory.

public static VkDeviceGroupBindSparseInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkDeviceGroupBindSparseInfo
malloc()

Returns a new VkDeviceGroupBindSparseInfo instance allocated with memAlloc.

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

Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkDeviceGroupBindSparseInfo instance allocated on the specified MemoryStack.

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

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

public static VkDeviceGroupBindSparseInfo
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public int
memoryDeviceIndex()

a device index indicating which instance of the memory the resource instance is bound to.

public VkDeviceGroupBindSparseInfo
memoryDeviceIndex(int value)

Sets the specified value to the memoryDeviceIndex field.

public static int
nmemoryDeviceIndex(long struct)

Unsafe version of memoryDeviceIndex.

public static void
nmemoryDeviceIndex(long struct, int value)

Unsafe version of memoryDeviceIndex.

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
nresourceDeviceIndex(long struct)

Unsafe version of resourceDeviceIndex.

public static void
nresourceDeviceIndex(long struct, int value)

Unsafe version of resourceDeviceIndex.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDeviceGroupBindSparseInfo
pNext(long value)

Sets the specified value to the pNext field.

public int
resourceDeviceIndex()

a device index indicating which instance of the resource is bound.

public VkDeviceGroupBindSparseInfo
resourceDeviceIndex(int value)

Sets the specified value to the resourceDeviceIndex field.

public VkDeviceGroupBindSparseInfo
set(int sType, long pNext, int resourceDeviceIndex, int memoryDeviceIndex)

Initializes this struct with the specified values.

public VkDeviceGroupBindSparseInfo

Returns:

this struct
set(VkDeviceGroupBindSparseInfo
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 VkDeviceGroupBindSparseInfo
sType(int value)

Sets the specified value to the sType field.

public VkDeviceGroupBindSparseInfo
sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO value to the sType field.

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.

MEMORYDEVICEINDEXback to summary
public static final int MEMORYDEVICEINDEX

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

RESOURCEDEVICEINDEXback to summary
public static final int RESOURCEDEVICEINDEX

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

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

callocback to summary
public static VkDeviceGroupBindSparseInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDeviceGroupBindSparseInfo calloc(MemoryStack stack)

Returns a new VkDeviceGroupBindSparseInfo 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 VkDeviceGroupBindSparseInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkDeviceGroupBindSparseInfo.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 VkDeviceGroupBindSparseInfo callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDeviceGroupBindSparseInfo.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 VkDeviceGroupBindSparseInfo 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 VkDeviceGroupBindSparseInfo create()

Returns a new VkDeviceGroupBindSparseInfo instance allocated with BufferUtils.

createback to summary
public static VkDeviceGroupBindSparseInfo create(long address)

Returns a new VkDeviceGroupBindSparseInfo instance for the specified memory address.

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

Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDeviceGroupBindSparseInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDeviceGroupBindSparseInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkDeviceGroupBindSparseInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDeviceGroupBindSparseInfo malloc(MemoryStack stack)

Returns a new VkDeviceGroupBindSparseInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkDeviceGroupBindSparseInfo.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 VkDeviceGroupBindSparseInfo mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
memoryDeviceIndexback to summary
public int memoryDeviceIndex()

a device index indicating which instance of the memory the resource instance is bound to.

Annotations
@NativeType:uint32_t
memoryDeviceIndexback to summary
public VkDeviceGroupBindSparseInfo memoryDeviceIndex(int value)

Sets the specified value to the memoryDeviceIndex field.

nmemoryDeviceIndexback to summary
public static int nmemoryDeviceIndex(long struct)

Unsafe version of memoryDeviceIndex.

nmemoryDeviceIndexback to summary
public static void nmemoryDeviceIndex(long struct, int value)

Unsafe version of memoryDeviceIndex.

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.

nresourceDeviceIndexback to summary
public static int nresourceDeviceIndex(long struct)

Unsafe version of resourceDeviceIndex.

nresourceDeviceIndexback to summary
public static void nresourceDeviceIndex(long struct, int value)

Unsafe version of resourceDeviceIndex.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

resourceDeviceIndexback to summary
public int resourceDeviceIndex()

a device index indicating which instance of the resource is bound.

Annotations
@NativeType:uint32_t
resourceDeviceIndexback to summary
public VkDeviceGroupBindSparseInfo resourceDeviceIndex(int value)

Sets the specified value to the resourceDeviceIndex field.

setback to summary
public VkDeviceGroupBindSparseInfo set(int sType, long pNext, int resourceDeviceIndex, int memoryDeviceIndex)

Initializes this struct with the specified values.

setback to summary
public VkDeviceGroupBindSparseInfo set(VkDeviceGroupBindSparseInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkDeviceGroupBindSparseInfo

the source struct

Returns:VkDeviceGroupBindSparseInfo

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 VkDeviceGroupBindSparseInfo sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDeviceGroupBindSparseInfo.Buffer

extends StructBuffer<VkDeviceGroupBindSparseInfo, VkDeviceGroupBindSparseInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkDeviceGroupBindSparseInfoKHR.Buffer
An array of VkDeviceGroupBindSparseInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkDeviceGroupBindSparseInfo
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDeviceGroupBindSparseInfo.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
protected VkDeviceGroupBindSparseInfo
getElementFactory()

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

public int

Returns:

the value of the VkDeviceGroupBindSparseInfo#memoryDeviceIndex field.
memoryDeviceIndex()

public VkDeviceGroupBindSparseInfo.Buffer
memoryDeviceIndex(int value)

Sets the specified value to the VkDeviceGroupBindSparseInfo#memoryDeviceIndex field.

public long

Returns:

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

public VkDeviceGroupBindSparseInfo.Buffer
pNext(long value)

Sets the specified value to the VkDeviceGroupBindSparseInfo#pNext field.

public int

Returns:

the value of the VkDeviceGroupBindSparseInfo#resourceDeviceIndex field.
resourceDeviceIndex()

public VkDeviceGroupBindSparseInfo.Buffer
resourceDeviceIndex(int value)

Sets the specified value to the VkDeviceGroupBindSparseInfo#resourceDeviceIndex field.

protected VkDeviceGroupBindSparseInfo.Buffer
self()

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

public int

Returns:

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

public VkDeviceGroupBindSparseInfo.Buffer
sType(int value)

Sets the specified value to the VkDeviceGroupBindSparseInfo#sType field.

public VkDeviceGroupBindSparseInfo.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO value to the VkDeviceGroupBindSparseInfo#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDeviceGroupBindSparseInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDeviceGroupBindSparseInfo.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 VkDeviceGroupBindSparseInfo#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

getElementFactoryback to summary
protected VkDeviceGroupBindSparseInfo getElementFactory()

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

Annotations
@Override
memoryDeviceIndexback to summary
public int memoryDeviceIndex()
Returns:int

the value of the VkDeviceGroupBindSparseInfo#memoryDeviceIndex field.

Annotations
@NativeType:uint32_t
memoryDeviceIndexback to summary
public VkDeviceGroupBindSparseInfo.Buffer memoryDeviceIndex(int value)

Sets the specified value to the VkDeviceGroupBindSparseInfo#memoryDeviceIndex field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkDeviceGroupBindSparseInfo#pNext field.

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

Sets the specified value to the VkDeviceGroupBindSparseInfo#pNext field.

resourceDeviceIndexback to summary
public int resourceDeviceIndex()
Returns:int

the value of the VkDeviceGroupBindSparseInfo#resourceDeviceIndex field.

Annotations
@NativeType:uint32_t
resourceDeviceIndexback to summary
public VkDeviceGroupBindSparseInfo.Buffer resourceDeviceIndex(int value)

Sets the specified value to the VkDeviceGroupBindSparseInfo#resourceDeviceIndex field.

selfback to summary
protected VkDeviceGroupBindSparseInfo.Buffer self()

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

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

the value of the VkDeviceGroupBindSparseInfo#sType field.

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

Sets the specified value to the VkDeviceGroupBindSparseInfo#sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO value to the VkDeviceGroupBindSparseInfo#sType field.