Package org.lwjgl.vulkan

Class VkDeviceGroupBindSparseInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDeviceGroupBindSparseInfo>

org.lwjgl.vulkan.VkDeviceGroupBindSparseInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkDeviceGroupBindSparseInfoKHR

public class VkDeviceGroupBindSparseInfo
extends Struct<VkDeviceGroupBindSparseInfo>
implements 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

Layout

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceGroupBindSparseInfo	calloc(MemoryStack stack)	Returns a new VkDeviceGroupBindSparseInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceGroupBindSparseInfo	callocStack()	Deprecated.
static VkDeviceGroupBindSparseInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkDeviceGroupBindSparseInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDeviceGroupBindSparseInfo	callocStack(MemoryStack stack)	Deprecated.
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDeviceGroupBindSparseInfo.Buffer instance allocated on the specified MemoryStack.
static VkDeviceGroupBindSparseInfo	malloc(MemoryStack stack)	Returns a new VkDeviceGroupBindSparseInfo instance allocated on the specified MemoryStack.
static VkDeviceGroupBindSparseInfo	mallocStack()	Deprecated.
static VkDeviceGroupBindSparseInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkDeviceGroupBindSparseInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDeviceGroupBindSparseInfo	mallocStack(MemoryStack stack)	Deprecated.
int	memoryDeviceIndex()	a device index indicating which instance of the memory the resource instance is bound to.
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()	NULL or a pointer to a structure extending this structure.
VkDeviceGroupBindSparseInfo	pNext(long value)	Sets the specified value to the pNext() field.
int	resourceDeviceIndex()	a device index indicating which instance of the resource is bound.
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()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkDeviceGroupBindSparseInfo	sType(int value)	Sets the specified value to the sType() field.
VkDeviceGroupBindSparseInfo	sType$Default()	Sets the STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

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 Details

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 Details

VkDeviceGroupBindSparseInfo

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDeviceGroupBindSparseInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

resourceDeviceIndex

public int resourceDeviceIndex()

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

memoryDeviceIndex

public int memoryDeviceIndex()

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

sType

public VkDeviceGroupBindSparseInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDeviceGroupBindSparseInfo sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO 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

@Deprecated
public static VkDeviceGroupBindSparseInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceGroupBindSparseInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDeviceGroupBindSparseInfo mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceGroupBindSparseInfo callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkDeviceGroupBindSparseInfo.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceGroupBindSparseInfo.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkDeviceGroupBindSparseInfo.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceGroupBindSparseInfo.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkDeviceGroupBindSparseInfo malloc(MemoryStack stack)

Returns a new VkDeviceGroupBindSparseInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

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.