Package org.lwjgl.vulkan

Class VkBindSparseInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBindSparseInfo>

org.lwjgl.vulkan.VkBindSparseInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkBindSparseInfo
extends Struct<VkBindSparseInfo>
implements NativeResource

 struct VkBindSparseInfo {
     VkStructureType sType;
     void const * pNext;
     uint32_t waitSemaphoreCount;
     VkSemaphore const * pWaitSemaphores;
     uint32_t bufferBindCount;
     VkSparseBufferMemoryBindInfo const * pBufferBinds;
     uint32_t imageOpaqueBindCount;
     VkSparseImageOpaqueMemoryBindInfo const * pImageOpaqueBinds;
     uint32_t imageBindCount;
     VkSparseImageMemoryBindInfo const * pImageBinds;
     uint32_t signalSemaphoreCount;
     VkSemaphore const * pSignalSemaphores;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkBindSparseInfo.Buffer	An array of VkBindSparseInfo 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	BUFFERBINDCOUNT	The struct member offsets.
static final int	IMAGEBINDCOUNT	The struct member offsets.
static final int	IMAGEOPAQUEBINDCOUNT	The struct member offsets.
static final int	PBUFFERBINDS	The struct member offsets.
static final int	PIMAGEBINDS	The struct member offsets.
static final int	PIMAGEOPAQUEBINDS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PSIGNALSEMAPHORES	The struct member offsets.
static final int	PWAITSEMAPHORES	The struct member offsets.
static final int	SIGNALSEMAPHORECOUNT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	WAITSEMAPHORECOUNT	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
VkBindSparseInfo(ByteBuffer container)	Creates a VkBindSparseInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	bufferBindCount()
static VkBindSparseInfo	calloc()	Returns a new VkBindSparseInfo instance allocated with memCalloc.
static VkBindSparseInfo.Buffer	calloc(int capacity)	Returns a new VkBindSparseInfo.Buffer instance allocated with memCalloc.
static VkBindSparseInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkBindSparseInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindSparseInfo	calloc(MemoryStack stack)	Returns a new VkBindSparseInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindSparseInfo	create()	Returns a new VkBindSparseInfo instance allocated with BufferUtils.
static VkBindSparseInfo.Buffer	create(int capacity)	Returns a new VkBindSparseInfo.Buffer instance allocated with BufferUtils.
static VkBindSparseInfo	create(long address)	Returns a new VkBindSparseInfo instance for the specified memory address.
static VkBindSparseInfo.Buffer	create(long address, int capacity)	Create a VkBindSparseInfo.Buffer instance at the specified memory.
static @Nullable VkBindSparseInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkBindSparseInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	imageBindCount()
int	imageOpaqueBindCount()
static VkBindSparseInfo	malloc()	Returns a new VkBindSparseInfo instance allocated with memAlloc.
static VkBindSparseInfo.Buffer	malloc(int capacity)	Returns a new VkBindSparseInfo.Buffer instance allocated with memAlloc.
static VkBindSparseInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkBindSparseInfo.Buffer instance allocated on the specified MemoryStack.
static VkBindSparseInfo	malloc(MemoryStack stack)	Returns a new VkBindSparseInfo instance allocated on the specified MemoryStack.
static int	nbufferBindCount(long struct)	Unsafe version of bufferBindCount().
static void	nbufferBindCount(long struct, int value)	Sets the specified value to the bufferBindCount field of the specified struct.
static int	nimageBindCount(long struct)	Unsafe version of imageBindCount().
static void	nimageBindCount(long struct, int value)	Sets the specified value to the imageBindCount field of the specified struct.
static int	nimageOpaqueBindCount(long struct)	Unsafe version of imageOpaqueBindCount().
static void	nimageOpaqueBindCount(long struct, int value)	Sets the specified value to the imageOpaqueBindCount field of the specified struct.
static @Nullable VkSparseBufferMemoryBindInfo.Buffer	npBufferBinds(long struct)	Unsafe version of pBufferBinds().
static void	npBufferBinds(long struct, @Nullable VkSparseBufferMemoryBindInfo.Buffer value)	Unsafe version of pBufferBinds.
static @Nullable VkSparseImageMemoryBindInfo.Buffer	npImageBinds(long struct)	Unsafe version of pImageBinds().
static void	npImageBinds(long struct, @Nullable VkSparseImageMemoryBindInfo.Buffer value)	Unsafe version of pImageBinds.
static @Nullable VkSparseImageOpaqueMemoryBindInfo.Buffer	npImageOpaqueBinds(long struct)	Unsafe version of pImageOpaqueBinds().
static void	npImageOpaqueBinds(long struct, @Nullable VkSparseImageOpaqueMemoryBindInfo.Buffer value)	Unsafe version of pImageOpaqueBinds.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable LongBuffer	npSignalSemaphores(long struct)	Unsafe version of pSignalSemaphores.
static void	npSignalSemaphores(long struct, @Nullable LongBuffer value)	Unsafe version of pSignalSemaphores.
static @Nullable LongBuffer	npWaitSemaphores(long struct)	Unsafe version of pWaitSemaphores.
static void	npWaitSemaphores(long struct, @Nullable LongBuffer value)	Unsafe version of pWaitSemaphores.
static int	nsignalSemaphoreCount(long struct)	Unsafe version of signalSemaphoreCount().
static void	nsignalSemaphoreCount(long struct, int value)	Sets the specified value to the signalSemaphoreCount field of the specified struct.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nwaitSemaphoreCount(long struct)	Unsafe version of waitSemaphoreCount().
static void	nwaitSemaphoreCount(long struct, int value)	Sets the specified value to the waitSemaphoreCount field of the specified struct.
@Nullable VkSparseBufferMemoryBindInfo.Buffer	pBufferBinds()
VkBindSparseInfo	pBufferBinds(@Nullable VkSparseBufferMemoryBindInfo.Buffer value)	Sets the address of the specified VkSparseBufferMemoryBindInfo.Buffer to the pBufferBinds field.
@Nullable VkSparseImageMemoryBindInfo.Buffer	pImageBinds()
VkBindSparseInfo	pImageBinds(@Nullable VkSparseImageMemoryBindInfo.Buffer value)	Sets the address of the specified VkSparseImageMemoryBindInfo.Buffer to the pImageBinds field.
@Nullable VkSparseImageOpaqueMemoryBindInfo.Buffer	pImageOpaqueBinds()
VkBindSparseInfo	pImageOpaqueBinds(@Nullable VkSparseImageOpaqueMemoryBindInfo.Buffer value)	Sets the address of the specified VkSparseImageOpaqueMemoryBindInfo.Buffer to the pImageOpaqueBinds field.
long	pNext()
VkBindSparseInfo	pNext(long value)	Sets the specified value to the pNext field.
VkBindSparseInfo	pNext(VkDeviceGroupBindSparseInfo value)	Prepends the specified VkDeviceGroupBindSparseInfo value to the pNext chain.
VkBindSparseInfo	pNext(VkDeviceGroupBindSparseInfoKHR value)	Prepends the specified VkDeviceGroupBindSparseInfoKHR value to the pNext chain.
VkBindSparseInfo	pNext(VkFrameBoundaryEXT value)	Prepends the specified VkFrameBoundaryEXT value to the pNext chain.
VkBindSparseInfo	pNext(VkFrameBoundaryTensorsARM value)	Prepends the specified VkFrameBoundaryTensorsARM value to the pNext chain.
VkBindSparseInfo	pNext(VkTimelineSemaphoreSubmitInfo value)	Prepends the specified VkTimelineSemaphoreSubmitInfo value to the pNext chain.
VkBindSparseInfo	pNext(VkTimelineSemaphoreSubmitInfoKHR value)	Prepends the specified VkTimelineSemaphoreSubmitInfoKHR value to the pNext chain.
@Nullable LongBuffer	pSignalSemaphores()
VkBindSparseInfo	pSignalSemaphores(@Nullable LongBuffer value)	Sets the address of the specified LongBuffer to the pSignalSemaphores field.
@Nullable LongBuffer	pWaitSemaphores()
VkBindSparseInfo	pWaitSemaphores(@Nullable LongBuffer value)	Sets the address of the specified LongBuffer to the pWaitSemaphores field.
VkBindSparseInfo	set(int sType, long pNext, @Nullable LongBuffer pWaitSemaphores, @Nullable VkSparseBufferMemoryBindInfo.Buffer pBufferBinds, @Nullable VkSparseImageOpaqueMemoryBindInfo.Buffer pImageOpaqueBinds, @Nullable VkSparseImageMemoryBindInfo.Buffer pImageBinds, @Nullable LongBuffer pSignalSemaphores)	Initializes this struct with the specified values.
VkBindSparseInfo	set(VkBindSparseInfo src)	Copies the specified struct data to this struct.
int	signalSemaphoreCount()
int	sizeof()	Returns sizeof(struct).
int	sType()
VkBindSparseInfo	sType(int value)	Sets the specified value to the sType field.
VkBindSparseInfo	sType$Default()	Sets the STRUCTURE_TYPE_BIND_SPARSE_INFO value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
int	waitSemaphoreCount()

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

WAITSEMAPHORECOUNT

public static final int WAITSEMAPHORECOUNT

The struct member offsets.

PWAITSEMAPHORES

public static final int PWAITSEMAPHORES

The struct member offsets.

BUFFERBINDCOUNT

public static final int BUFFERBINDCOUNT

The struct member offsets.

PBUFFERBINDS

public static final int PBUFFERBINDS

The struct member offsets.

IMAGEOPAQUEBINDCOUNT

public static final int IMAGEOPAQUEBINDCOUNT

The struct member offsets.

PIMAGEOPAQUEBINDS

public static final int PIMAGEOPAQUEBINDS

The struct member offsets.

IMAGEBINDCOUNT

public static final int IMAGEBINDCOUNT

The struct member offsets.

PIMAGEBINDS

public static final int PIMAGEBINDS

The struct member offsets.

SIGNALSEMAPHORECOUNT

public static final int SIGNALSEMAPHORECOUNT

The struct member offsets.

PSIGNALSEMAPHORES

public static final int PSIGNALSEMAPHORES

The struct member offsets.

Constructor Details

VkBindSparseInfo

public VkBindSparseInfo(ByteBuffer container)

Creates a VkBindSparseInfo 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<VkBindSparseInfo>

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

waitSemaphoreCount

public int waitSemaphoreCount()

Returns:

the value of the waitSemaphoreCount field.

pWaitSemaphores

public @Nullable LongBuffer pWaitSemaphores()

Returns:

a LongBuffer view of the data pointed to by the pWaitSemaphores field.

bufferBindCount

public int bufferBindCount()

Returns:

the value of the bufferBindCount field.

pBufferBinds

public @Nullable VkSparseBufferMemoryBindInfo.Buffer pBufferBinds()

Returns:

a VkSparseBufferMemoryBindInfo.Buffer view of the struct array pointed to by the pBufferBinds field.

imageOpaqueBindCount

public int imageOpaqueBindCount()

Returns:

the value of the imageOpaqueBindCount field.

pImageOpaqueBinds

public @Nullable VkSparseImageOpaqueMemoryBindInfo.Buffer pImageOpaqueBinds()

Returns:

a VkSparseImageOpaqueMemoryBindInfo.Buffer view of the struct array pointed to by the pImageOpaqueBinds field.

imageBindCount

public int imageBindCount()

Returns:

the value of the imageBindCount field.

pImageBinds

public @Nullable VkSparseImageMemoryBindInfo.Buffer pImageBinds()

Returns:

a VkSparseImageMemoryBindInfo.Buffer view of the struct array pointed to by the pImageBinds field.

signalSemaphoreCount

public int signalSemaphoreCount()

Returns:

the value of the signalSemaphoreCount field.

pSignalSemaphores

public @Nullable LongBuffer pSignalSemaphores()

Returns:

a LongBuffer view of the data pointed to by the pSignalSemaphores field.

sType

public VkBindSparseInfo sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkBindSparseInfo sType$Default()

Sets the STRUCTURE_TYPE_BIND_SPARSE_INFO value to the sType field.

pNext

public VkBindSparseInfo pNext(long value)

Sets the specified value to the pNext field.

pNext

public VkBindSparseInfo pNext(VkDeviceGroupBindSparseInfo value)

Prepends the specified VkDeviceGroupBindSparseInfo value to the pNext chain.

pNext

public VkBindSparseInfo pNext(VkDeviceGroupBindSparseInfoKHR value)

Prepends the specified VkDeviceGroupBindSparseInfoKHR value to the pNext chain.

pNext

public VkBindSparseInfo pNext(VkFrameBoundaryEXT value)

Prepends the specified VkFrameBoundaryEXT value to the pNext chain.

pNext

public VkBindSparseInfo pNext(VkFrameBoundaryTensorsARM value)

Prepends the specified VkFrameBoundaryTensorsARM value to the pNext chain.

pNext

public VkBindSparseInfo pNext(VkTimelineSemaphoreSubmitInfo value)

Prepends the specified VkTimelineSemaphoreSubmitInfo value to the pNext chain.

pNext

public VkBindSparseInfo pNext(VkTimelineSemaphoreSubmitInfoKHR value)

Prepends the specified VkTimelineSemaphoreSubmitInfoKHR value to the pNext chain.

pWaitSemaphores

public VkBindSparseInfo pWaitSemaphores(@Nullable LongBuffer value)

Sets the address of the specified LongBuffer to the pWaitSemaphores field.

pBufferBinds

public VkBindSparseInfo pBufferBinds(@Nullable VkSparseBufferMemoryBindInfo.Buffer value)

Sets the address of the specified VkSparseBufferMemoryBindInfo.Buffer to the pBufferBinds field.

pImageOpaqueBinds

public VkBindSparseInfo pImageOpaqueBinds(@Nullable VkSparseImageOpaqueMemoryBindInfo.Buffer value)

Sets the address of the specified VkSparseImageOpaqueMemoryBindInfo.Buffer to the pImageOpaqueBinds field.

pImageBinds

public VkBindSparseInfo pImageBinds(@Nullable VkSparseImageMemoryBindInfo.Buffer value)

Sets the address of the specified VkSparseImageMemoryBindInfo.Buffer to the pImageBinds field.

pSignalSemaphores

public VkBindSparseInfo pSignalSemaphores(@Nullable LongBuffer value)

Sets the address of the specified LongBuffer to the pSignalSemaphores field.

set

public VkBindSparseInfo set(int sType,
 long pNext,
 @Nullable LongBuffer pWaitSemaphores,
 @Nullable VkSparseBufferMemoryBindInfo.Buffer pBufferBinds,
 @Nullable VkSparseImageOpaqueMemoryBindInfo.Buffer pImageOpaqueBinds,
 @Nullable VkSparseImageMemoryBindInfo.Buffer pImageBinds,
 @Nullable LongBuffer pSignalSemaphores)

Initializes this struct with the specified values.

set

public VkBindSparseInfo set(VkBindSparseInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBindSparseInfo malloc()

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

calloc

public static VkBindSparseInfo calloc()

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

create

public static VkBindSparseInfo create()

Returns a new VkBindSparseInfo instance allocated with BufferUtils.

create

public static VkBindSparseInfo create(long address)

Returns a new VkBindSparseInfo instance for the specified memory address.

createSafe

public static @Nullable VkBindSparseInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBindSparseInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBindSparseInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBindSparseInfo.Buffer create(int capacity)

Returns a new VkBindSparseInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkBindSparseInfo.Buffer create(long address,
 int capacity)

Create a VkBindSparseInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkBindSparseInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkBindSparseInfo malloc(MemoryStack stack)

Returns a new VkBindSparseInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkBindSparseInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkBindSparseInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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

nwaitSemaphoreCount

public static int nwaitSemaphoreCount(long struct)

Unsafe version of waitSemaphoreCount().

npWaitSemaphores

public static @Nullable LongBuffer npWaitSemaphores(long struct)

Unsafe version of pWaitSemaphores.

nbufferBindCount

public static int nbufferBindCount(long struct)

Unsafe version of bufferBindCount().

npBufferBinds

public static @Nullable VkSparseBufferMemoryBindInfo.Buffer npBufferBinds(long struct)

Unsafe version of pBufferBinds().

nimageOpaqueBindCount

public static int nimageOpaqueBindCount(long struct)

Unsafe version of imageOpaqueBindCount().

npImageOpaqueBinds

public static @Nullable VkSparseImageOpaqueMemoryBindInfo.Buffer npImageOpaqueBinds(long struct)

Unsafe version of pImageOpaqueBinds().

nimageBindCount

public static int nimageBindCount(long struct)

Unsafe version of imageBindCount().

npImageBinds

public static @Nullable VkSparseImageMemoryBindInfo.Buffer npImageBinds(long struct)

Unsafe version of pImageBinds().

nsignalSemaphoreCount

public static int nsignalSemaphoreCount(long struct)

Unsafe version of signalSemaphoreCount().

npSignalSemaphores

public static @Nullable LongBuffer npSignalSemaphores(long struct)

Unsafe version of pSignalSemaphores.

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.

nwaitSemaphoreCount

public static void nwaitSemaphoreCount(long struct,
 int value)

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

npWaitSemaphores

public static void npWaitSemaphores(long struct,
 @Nullable LongBuffer value)

Unsafe version of pWaitSemaphores.

nbufferBindCount

public static void nbufferBindCount(long struct,
 int value)

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

npBufferBinds

public static void npBufferBinds(long struct,
 @Nullable VkSparseBufferMemoryBindInfo.Buffer value)

Unsafe version of pBufferBinds.

nimageOpaqueBindCount

public static void nimageOpaqueBindCount(long struct,
 int value)

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

npImageOpaqueBinds

public static void npImageOpaqueBinds(long struct,
 @Nullable VkSparseImageOpaqueMemoryBindInfo.Buffer value)

Unsafe version of pImageOpaqueBinds.

nimageBindCount

public static void nimageBindCount(long struct,
 int value)

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

npImageBinds

public static void npImageBinds(long struct,
 @Nullable VkSparseImageMemoryBindInfo.Buffer value)

Unsafe version of pImageBinds.

nsignalSemaphoreCount

public static void nsignalSemaphoreCount(long struct,
 int value)

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

npSignalSemaphores

public static void npSignalSemaphores(long struct,
 @Nullable LongBuffer value)

Unsafe version of pSignalSemaphores.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate