Package org.lwjgl.vulkan
Class VkBindSparseInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkBindSparseInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkBindSparseInfo extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes a set of sparse binding operations.
Valid Usage
sType
must beSTRUCTURE_TYPE_BIND_SPARSE_INFO
pNext
must beNULL
- If
waitSemaphoreCount
is not 0,pWaitSemaphores
must be a pointer to an array ofwaitSemaphoreCount
validVkSemaphore
handles - If
bufferBindCount
is not 0,pBufferBinds
must be a pointer to an array ofbufferBindCount
validVkSparseBufferMemoryBindInfo
structures - If
imageOpaqueBindCount
is not 0,pImageOpaqueBinds
must be a pointer to an array ofimageOpaqueBindCount
validVkSparseImageOpaqueMemoryBindInfo
structures - If
imageBindCount
is not 0,pImageBinds
must be a pointer to an array ofimageBindCount
validVkSparseImageMemoryBindInfo
structures - If
signalSemaphoreCount
is not 0,pSignalSemaphores
must be a pointer to an array ofsignalSemaphoreCount
validVkSemaphore
handles - Each of the elements of
pWaitSemaphores
and the elements ofpSignalSemaphores
that are valid handles must have been created, allocated or retrieved from the sameVkDevice
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_BIND_SPARSE_INFO
pNext
– reserved for use by extensionswaitSemaphoreCount
– the number of semaphores upon which to wait before executing the sparse binding operations for the batchpWaitSemaphores
– a pointer to an array of semaphores upon which to wait before executing the sparse binding operations in the batchbufferBindCount
– the number of sparse buffer bindings to performpBufferBinds
– an array ofVkSparseBufferMemoryBindInfo
structures, indicating sparse buffer bindings to performimageOpaqueBindCount
– the number of opaque sparse image bindings to performpImageOpaqueBinds
– an array ofVkSparseImageOpaqueMemoryBindInfo
structures, indicating opaque sparse image bindings to performimageBindCount
– the number of sparse image bindings to performpImageBinds
– an array ofVkSparseImageMemoryBindInfo
structures, indicating sparse image bindings to performsignalSemaphoreCount
– the number of semaphores to be signaled once the sparse binding operations specified by the structure have completed executionpSignalSemaphores
– a pointer to an array of semaphores which will be signaled when the sparse binding operations for this batch have completed execution
Layout
struct VkBindSparseInfo { VkStructureType sType; const void * pNext; uint32_t waitSemaphoreCount; const VkSemaphore * pWaitSemaphores; uint32_t bufferBindCount; const VkSparseBufferMemoryBindInfo * pBufferBinds; uint32_t imageOpaqueBindCount; const VkSparseImageOpaqueMemoryBindInfo * pImageOpaqueBinds; uint32_t imageBindCount; const VkSparseImageMemoryBindInfo * pImageBinds; uint32_t signalSemaphoreCount; const VkSemaphore * pSignalSemaphores; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkBindSparseInfo.Buffer
An array ofVkBindSparseInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkBindSparseInfo(java.nio.ByteBuffer container)
Creates aVkBindSparseInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description int
bufferBindCount()
Returns the value of thebufferBindCount
field.static VkBindSparseInfo
calloc()
Returns a newVkBindSparseInfo
instance allocated withmemCalloc
.static VkBindSparseInfo.Buffer
calloc(int capacity)
Returns a newVkBindSparseInfo.Buffer
instance allocated withmemCalloc
.static VkBindSparseInfo
callocStack()
Returns a newVkBindSparseInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkBindSparseInfo.Buffer
callocStack(int capacity)
Returns a newVkBindSparseInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkBindSparseInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkBindSparseInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBindSparseInfo
callocStack(MemoryStack stack)
Returns a newVkBindSparseInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBindSparseInfo
create()
Returns a newVkBindSparseInfo
instance allocated withBufferUtils
.static VkBindSparseInfo.Buffer
create(int capacity)
Returns a newVkBindSparseInfo.Buffer
instance allocated withBufferUtils
.static VkBindSparseInfo
create(long address)
Returns a newVkBindSparseInfo
instance for the specified memory address ornull
if the address isNULL
.static VkBindSparseInfo.Buffer
create(long address, int capacity)
Create aVkBindSparseInfo.Buffer
instance at the specified memory.int
imageBindCount()
Returns the value of theimageBindCount
field.int
imageOpaqueBindCount()
Returns the value of theimageOpaqueBindCount
field.static VkBindSparseInfo
malloc()
Returns a newVkBindSparseInfo
instance allocated withmemAlloc
.static VkBindSparseInfo.Buffer
malloc(int capacity)
Returns a newVkBindSparseInfo.Buffer
instance allocated withmemAlloc
.static VkBindSparseInfo
mallocStack()
Returns a newVkBindSparseInfo
instance allocated on the thread-localMemoryStack
.static VkBindSparseInfo.Buffer
mallocStack(int capacity)
Returns a newVkBindSparseInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkBindSparseInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkBindSparseInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkBindSparseInfo
mallocStack(MemoryStack stack)
Returns a newVkBindSparseInfo
instance allocated on the specifiedMemoryStack
.VkBindSparseInfo
nset(long struct)
Unsafe version ofset
.VkSparseBufferMemoryBindInfo.Buffer
pBufferBinds()
Returns aVkSparseBufferMemoryBindInfo.Buffer
view of the struct array pointed to by thepBufferBinds
field.VkBindSparseInfo
pBufferBinds(VkSparseBufferMemoryBindInfo.Buffer value)
Sets the address of the specifiedVkSparseBufferMemoryBindInfo.Buffer
to thepBufferBinds
field.VkSparseImageMemoryBindInfo.Buffer
pImageBinds()
Returns aVkSparseImageMemoryBindInfo.Buffer
view of the struct array pointed to by thepImageBinds
field.VkBindSparseInfo
pImageBinds(VkSparseImageMemoryBindInfo.Buffer value)
Sets the address of the specifiedVkSparseImageMemoryBindInfo.Buffer
to thepImageBinds
field.VkSparseImageOpaqueMemoryBindInfo.Buffer
pImageOpaqueBinds()
Returns aVkSparseImageOpaqueMemoryBindInfo.Buffer
view of the struct array pointed to by thepImageOpaqueBinds
field.VkBindSparseInfo
pImageOpaqueBinds(VkSparseImageOpaqueMemoryBindInfo.Buffer value)
Sets the address of the specifiedVkSparseImageOpaqueMemoryBindInfo.Buffer
to thepImageOpaqueBinds
field.long
pNext()
Returns the value of thepNext
field.VkBindSparseInfo
pNext(long value)
Sets the specified value to thepNext
field.java.nio.LongBuffer
pSignalSemaphores()
Returns aLongBuffer
view of the data pointed to by thepSignalSemaphores
field.VkBindSparseInfo
pSignalSemaphores(java.nio.LongBuffer value)
Sets the address of the specifiedLongBuffer
to thepSignalSemaphores
field.java.nio.LongBuffer
pWaitSemaphores()
Returns aLongBuffer
view of the data pointed to by thepWaitSemaphores
field.VkBindSparseInfo
pWaitSemaphores(java.nio.LongBuffer value)
Sets the address of the specifiedLongBuffer
to thepWaitSemaphores
field.VkBindSparseInfo
set(int sType, long pNext, java.nio.LongBuffer pWaitSemaphores, VkSparseBufferMemoryBindInfo.Buffer pBufferBinds, VkSparseImageOpaqueMemoryBindInfo.Buffer pImageOpaqueBinds, VkSparseImageMemoryBindInfo.Buffer pImageBinds, java.nio.LongBuffer pSignalSemaphores)
Initializes this struct with the specified values.VkBindSparseInfo
set(VkBindSparseInfo src)
Copies the specified struct data to this struct.int
signalSemaphoreCount()
Returns the value of thesignalSemaphoreCount
field.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkBindSparseInfo
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
CallsVkBindSparseInfo.validate(long)
for each struct contained in the specified struct array.int
waitSemaphoreCount()
Returns the value of thewaitSemaphoreCount
field.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkBindSparseInfo
public VkBindSparseInfo(java.nio.ByteBuffer container)
Creates aVkBindSparseInfo
instance at the current position of the specifiedByteBuffer
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
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
waitSemaphoreCount
public int waitSemaphoreCount()
Returns the value of thewaitSemaphoreCount
field.
-
pWaitSemaphores
public java.nio.LongBuffer pWaitSemaphores()
Returns aLongBuffer
view of the data pointed to by thepWaitSemaphores
field.
-
bufferBindCount
public int bufferBindCount()
Returns the value of thebufferBindCount
field.
-
pBufferBinds
public VkSparseBufferMemoryBindInfo.Buffer pBufferBinds()
Returns aVkSparseBufferMemoryBindInfo.Buffer
view of the struct array pointed to by thepBufferBinds
field.
-
imageOpaqueBindCount
public int imageOpaqueBindCount()
Returns the value of theimageOpaqueBindCount
field.
-
pImageOpaqueBinds
public VkSparseImageOpaqueMemoryBindInfo.Buffer pImageOpaqueBinds()
Returns aVkSparseImageOpaqueMemoryBindInfo.Buffer
view of the struct array pointed to by thepImageOpaqueBinds
field.
-
imageBindCount
public int imageBindCount()
Returns the value of theimageBindCount
field.
-
pImageBinds
public VkSparseImageMemoryBindInfo.Buffer pImageBinds()
Returns aVkSparseImageMemoryBindInfo.Buffer
view of the struct array pointed to by thepImageBinds
field.
-
signalSemaphoreCount
public int signalSemaphoreCount()
Returns the value of thesignalSemaphoreCount
field.
-
pSignalSemaphores
public java.nio.LongBuffer pSignalSemaphores()
Returns aLongBuffer
view of the data pointed to by thepSignalSemaphores
field.
-
sType
public VkBindSparseInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkBindSparseInfo pNext(long value)
Sets the specified value to thepNext
field.
-
pWaitSemaphores
public VkBindSparseInfo pWaitSemaphores(java.nio.LongBuffer value)
Sets the address of the specifiedLongBuffer
to thepWaitSemaphores
field.
-
pBufferBinds
public VkBindSparseInfo pBufferBinds(VkSparseBufferMemoryBindInfo.Buffer value)
Sets the address of the specifiedVkSparseBufferMemoryBindInfo.Buffer
to thepBufferBinds
field.
-
pImageOpaqueBinds
public VkBindSparseInfo pImageOpaqueBinds(VkSparseImageOpaqueMemoryBindInfo.Buffer value)
Sets the address of the specifiedVkSparseImageOpaqueMemoryBindInfo.Buffer
to thepImageOpaqueBinds
field.
-
pImageBinds
public VkBindSparseInfo pImageBinds(VkSparseImageMemoryBindInfo.Buffer value)
Sets the address of the specifiedVkSparseImageMemoryBindInfo.Buffer
to thepImageBinds
field.
-
pSignalSemaphores
public VkBindSparseInfo pSignalSemaphores(java.nio.LongBuffer value)
Sets the address of the specifiedLongBuffer
to thepSignalSemaphores
field.
-
set
public VkBindSparseInfo set(int sType, long pNext, java.nio.LongBuffer pWaitSemaphores, VkSparseBufferMemoryBindInfo.Buffer pBufferBinds, VkSparseImageOpaqueMemoryBindInfo.Buffer pImageOpaqueBinds, VkSparseImageMemoryBindInfo.Buffer pImageBinds, java.nio.LongBuffer pSignalSemaphores)
Initializes this struct with the specified values.
-
nset
public VkBindSparseInfo nset(long struct)
Unsafe version ofset
.
-
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 newVkBindSparseInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkBindSparseInfo calloc()
Returns a newVkBindSparseInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkBindSparseInfo create()
Returns a newVkBindSparseInfo
instance allocated withBufferUtils
.
-
create
public static VkBindSparseInfo create(long address)
Returns a newVkBindSparseInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkBindSparseInfo.Buffer malloc(int capacity)
Returns a newVkBindSparseInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkBindSparseInfo.Buffer calloc(int capacity)
Returns a newVkBindSparseInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkBindSparseInfo.Buffer create(int capacity)
Returns a newVkBindSparseInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkBindSparseInfo.Buffer create(long address, int capacity)
Create aVkBindSparseInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkBindSparseInfo mallocStack()
Returns a newVkBindSparseInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkBindSparseInfo callocStack()
Returns a newVkBindSparseInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkBindSparseInfo mallocStack(MemoryStack stack)
Returns a newVkBindSparseInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkBindSparseInfo callocStack(MemoryStack stack)
Returns a newVkBindSparseInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkBindSparseInfo.Buffer mallocStack(int capacity)
Returns a newVkBindSparseInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkBindSparseInfo.Buffer callocStack(int capacity)
Returns a newVkBindSparseInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkBindSparseInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkBindSparseInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkBindSparseInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkBindSparseInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
CallsVkBindSparseInfo.validate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-