Package org.lwjgl.vulkan
Class VkSparseBufferMemoryBindInfo
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkSparseBufferMemoryBindInfo
extends Struct<VkSparseBufferMemoryBindInfo>
implements NativeResource
Structure specifying a sparse buffer memory bind operation.
Valid Usage (Implicit)
buffer
must be a validVkBuffer
handlepBinds
must be a valid pointer to an array ofbindCount
validVkSparseMemoryBind
structuresbindCount
must be greater than 0
See Also
VkBindSparseInfo
, VkSparseMemoryBind
Layout
struct VkSparseBufferMemoryBindInfo {
VkBuffer buffer()
;
uint32_t bindCount()
;
VkSparseMemoryBind
const * pBinds()
;
}
-
Nested Class Summary
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
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkSparseBufferMemoryBindInfo
(ByteBuffer container) Creates aVkSparseBufferMemoryBindInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionint
the number ofVkSparseMemoryBind
structures in thepBinds
array.long
buffer()
theVkBuffer
object to be bound.buffer
(long value) Sets the specified value to thebuffer()
field.static VkSparseBufferMemoryBindInfo
calloc()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseBufferMemoryBindInfo
calloc
(MemoryStack stack) Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseBufferMemoryBindInfo
Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.static VkSparseBufferMemoryBindInfo
callocStack
(MemoryStack stack) Deprecated.static VkSparseBufferMemoryBindInfo
create()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withBufferUtils
.static VkSparseBufferMemoryBindInfo
create
(long address) Returns a newVkSparseBufferMemoryBindInfo
instance for the specified memory address.create
(long address, int capacity) Create aVkSparseBufferMemoryBindInfo.Buffer
instance at the specified memory.static VkSparseBufferMemoryBindInfo
createSafe
(long address) createSafe
(long address, int capacity) static VkSparseBufferMemoryBindInfo
malloc()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkSparseBufferMemoryBindInfo
malloc
(MemoryStack stack) Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the specifiedMemoryStack
.static VkSparseBufferMemoryBindInfo
Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkSparseBufferMemoryBindInfo
mallocStack
(MemoryStack stack) Deprecated.static int
nbindCount
(long struct) Unsafe version ofbindCount()
.static void
nbindCount
(long struct, int value) Sets the specified value to thebindCount
field of the specifiedstruct
.static long
nbuffer
(long struct) Unsafe version ofbuffer()
.static void
nbuffer
(long struct, long value) Unsafe version ofbuffer
.static VkSparseMemoryBind.Buffer
npBinds
(long struct) Unsafe version ofpBinds()
.static void
npBinds
(long struct, VkSparseMemoryBind.Buffer value) Unsafe version ofpBinds
.pBinds()
a pointer to an array ofVkSparseMemoryBind
structures.pBinds
(VkSparseMemoryBind.Buffer value) Sets the address of the specifiedVkSparseMemoryBind.Buffer
to thepBinds()
field.set
(long buffer, VkSparseMemoryBind.Buffer pBinds) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.static void
validate
(long struct) Validates pointer members that should not beNULL
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
BUFFER
public static final int BUFFERThe struct member offsets. -
BINDCOUNT
public static final int BINDCOUNTThe struct member offsets. -
PBINDS
public static final int PBINDSThe struct member offsets.
-
-
Constructor Details
-
VkSparseBufferMemoryBindInfo
Creates aVkSparseBufferMemoryBindInfo
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkSparseBufferMemoryBindInfo>
-
buffer
public long buffer()theVkBuffer
object to be bound. -
bindCount
public int bindCount()the number ofVkSparseMemoryBind
structures in thepBinds
array. -
pBinds
a pointer to an array ofVkSparseMemoryBind
structures. -
buffer
Sets the specified value to thebuffer()
field. -
pBinds
Sets the address of the specifiedVkSparseMemoryBind.Buffer
to thepBinds()
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withBufferUtils
. -
create
Returns a newVkSparseBufferMemoryBindInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkSparseBufferMemoryBindInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkSparseBufferMemoryBindInfo.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkSparseBufferMemoryBindInfo.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nbuffer
public static long nbuffer(long struct) Unsafe version ofbuffer()
. -
nbindCount
public static int nbindCount(long struct) Unsafe version ofbindCount()
. -
npBinds
Unsafe version ofpBinds()
. -
nbuffer
public static void nbuffer(long struct, long value) Unsafe version ofbuffer
. -
nbindCount
public static void nbindCount(long struct, int value) Sets the specified value to thebindCount
field of the specifiedstruct
. -
npBinds
Unsafe version ofpBinds
. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-