Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBindSparseInfo

extends Struct<VkBindSparseInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying a sparse binding operation.
Valid Usage
Valid Usage (Implicit)
See Also

VkSparseBufferMemoryBindInfo, VkSparseImageMemoryBindInfo, VkSparseImageOpaqueMemoryBindInfo, QueueBindSparse

Layout


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 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
BUFFERBINDCOUNT

The struct member offsets.

public static final int
IMAGEBINDCOUNT

The struct member offsets.

public static final int
IMAGEOPAQUEBINDCOUNT

The struct member offsets.

public static final int
PBUFFERBINDS

The struct member offsets.

public static final int
PIMAGEBINDS

The struct member offsets.

public static final int
PIMAGEOPAQUEBINDS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PSIGNALSEMAPHORES

The struct member offsets.

public static final int
PWAITSEMAPHORES

The struct member offsets.

public static final int
SIGNALSEMAPHORECOUNT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
WAITSEMAPHORECOUNT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkBindSparseInfo(long address, ByteBuffer container)

public
VkBindSparseInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
bufferBindCount()

the number of sparse buffer bindings to perform in the batch.

public static VkBindSparseInfo
calloc()

Returns a new VkBindSparseInfo instance allocated with memCalloc.

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

Returns a new VkBindSparseInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkBindSparseInfo
callocStack()

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

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

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

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

Returns a new VkBindSparseInfo instance allocated with BufferUtils.

public static VkBindSparseInfo
create(long address)

Returns a new VkBindSparseInfo instance for the specified memory address.

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

Returns a new VkBindSparseInfo.Buffer instance allocated with BufferUtils.

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

Create a VkBindSparseInfo.Buffer instance at the specified memory.

public static VkBindSparseInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
imageBindCount()

the number of sparse image bindings to perform.

public int
imageOpaqueBindCount()

the number of opaque sparse image bindings to perform.

public static VkBindSparseInfo
malloc()

Returns a new VkBindSparseInfo instance allocated with memAlloc.

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

Returns a new VkBindSparseInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkBindSparseInfo instance allocated on the specified MemoryStack.

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

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

public static VkBindSparseInfo
mallocStack()

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

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

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

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

Unsafe version of bufferBindCount.

public static void
nbufferBindCount(long struct, int value)

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

public static int
nimageBindCount(long struct)

Unsafe version of imageBindCount.

public static void
nimageBindCount(long struct, int value)

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

public static int
nimageOpaqueBindCount(long struct)

Unsafe version of imageOpaqueBindCount.

public static void
nimageOpaqueBindCount(long struct, int value)

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

public static VkSparseBufferMemoryBindInfo.Buffer
npBufferBinds(long struct)

Unsafe version of pBufferBinds.

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

Unsafe version of pBufferBinds.

public static VkSparseImageMemoryBindInfo.Buffer
npImageBinds(long struct)

Unsafe version of pImageBinds.

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

Unsafe version of pImageBinds.

public static VkSparseImageOpaqueMemoryBindInfo.Buffer
npImageOpaqueBinds(long struct)

Unsafe version of pImageOpaqueBinds.

public static void
public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static LongBuffer
npSignalSemaphores(long struct)

Unsafe version of pSignalSemaphores.

public static void
npSignalSemaphores(long struct, LongBuffer value)

Unsafe version of pSignalSemaphores.

public static LongBuffer
npWaitSemaphores(long struct)

Unsafe version of pWaitSemaphores.

public static void
npWaitSemaphores(long struct, LongBuffer value)

Unsafe version of pWaitSemaphores.

public static int
nsignalSemaphoreCount(long struct)

Unsafe version of signalSemaphoreCount.

public static void
nsignalSemaphoreCount(long struct, int value)

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

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nwaitSemaphoreCount(long struct)

Unsafe version of waitSemaphoreCount.

public static void
nwaitSemaphoreCount(long struct, int value)

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

public VkSparseBufferMemoryBindInfo.Buffer
pBufferBinds()

a pointer to an array of VkSparseBufferMemoryBindInfo structures.

public VkBindSparseInfo
public VkSparseImageMemoryBindInfo.Buffer
pImageBinds()

a pointer to an array of VkSparseImageMemoryBindInfo structures, indicating sparse image bindings to perform.

public VkBindSparseInfo
public VkSparseImageOpaqueMemoryBindInfo.Buffer
pImageOpaqueBinds()

a pointer to an array of VkSparseImageOpaqueMemoryBindInfo structures, indicating opaque sparse image bindings to perform.

public VkBindSparseInfo
public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkBindSparseInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkBindSparseInfo
pNext(VkDeviceGroupBindSparseInfo value)

Prepends the specified VkDeviceGroupBindSparseInfo value to the pNext chain.

public VkBindSparseInfo
pNext(VkDeviceGroupBindSparseInfoKHR value)

Prepends the specified VkDeviceGroupBindSparseInfoKHR value to the pNext chain.

public VkBindSparseInfo
pNext(VkFrameBoundaryEXT value)

Prepends the specified VkFrameBoundaryEXT value to the pNext chain.

public VkBindSparseInfo
pNext(VkTimelineSemaphoreSubmitInfo value)

Prepends the specified VkTimelineSemaphoreSubmitInfo value to the pNext chain.

public VkBindSparseInfo
pNext(VkTimelineSemaphoreSubmitInfoKHR value)

Prepends the specified VkTimelineSemaphoreSubmitInfoKHR value to the pNext chain.

public LongBuffer
pSignalSemaphores()

a pointer to an array of semaphores which will be signaled when the sparse binding operations for this batch have completed execution.

public VkBindSparseInfo
pSignalSemaphores(LongBuffer value)

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

public LongBuffer
pWaitSemaphores()

a pointer to an array of semaphores upon which to wait on before the sparse binding operations for this batch begin execution.

public VkBindSparseInfo
pWaitSemaphores(LongBuffer value)

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

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

Initializes this struct with the specified values.

public VkBindSparseInfo

Returns:

this struct
set
(VkBindSparseInfo
the source struct
src
)

Copies the specified struct data to this struct.

public int
signalSemaphoreCount()

the number of semaphores to be signaled once the sparse binding operations specified by the structure have completed execution.

public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkBindSparseInfo
sType(int value)

Sets the specified value to the sType field.

public VkBindSparseInfo
sType$Default()

Sets the STRUCTURE_TYPE_BIND_SPARSE_INFO value to the sType field.

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

Validates pointer members that should not be NULL.

public int
waitSemaphoreCount()

the number of semaphores upon which to wait before executing the sparse binding operations for the batch.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate