Package org.lwjgl.vulkan
Class VkSparseBufferMemoryBindInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSparseBufferMemoryBindInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkSparseBufferMemoryBindInfo extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes a memory binding to a
VkBuffer
object.Valid Usage
buffer
must be a validVkBuffer
handlepBinds
must be a pointer to an array ofbindCount
validVkSparseMemoryBind
structuresbindCount
must be greater than 0
Member documentation
buffer
– theVkBuffer
object to be boundbindCount
– the number ofVkSparseMemoryBind
structures in thepBinds
arraypBinds
– a pointer to array ofVkSparseMemoryBind
structures
Layout
struct VkSparseBufferMemoryBindInfo { VkBuffer buffer; uint32_t bindCount; const VkSparseMemoryBind * pBinds; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkSparseBufferMemoryBindInfo.Buffer
An array ofVkSparseBufferMemoryBindInfo
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 VkSparseBufferMemoryBindInfo(java.nio.ByteBuffer container)
Creates aVkSparseBufferMemoryBindInfo
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
bindCount()
Returns the value of thebindCount
field.long
buffer()
Returns the value of thebuffer
field.VkSparseBufferMemoryBindInfo
buffer(long value)
Sets the specified value to thebuffer
field.static VkSparseBufferMemoryBindInfo
calloc()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withmemCalloc
.static VkSparseBufferMemoryBindInfo.Buffer
calloc(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withmemCalloc
.static VkSparseBufferMemoryBindInfo
callocStack()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSparseBufferMemoryBindInfo.Buffer
callocStack(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSparseBufferMemoryBindInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseBufferMemoryBindInfo
callocStack(MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseBufferMemoryBindInfo
create()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withBufferUtils
.static VkSparseBufferMemoryBindInfo.Buffer
create(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withBufferUtils
.static VkSparseBufferMemoryBindInfo
create(long address)
Returns a newVkSparseBufferMemoryBindInfo
instance for the specified memory address ornull
if the address isNULL
.static VkSparseBufferMemoryBindInfo.Buffer
create(long address, int capacity)
Create aVkSparseBufferMemoryBindInfo.Buffer
instance at the specified memory.static VkSparseBufferMemoryBindInfo
malloc()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withmemAlloc
.static VkSparseBufferMemoryBindInfo.Buffer
malloc(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withmemAlloc
.static VkSparseBufferMemoryBindInfo
mallocStack()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the thread-localMemoryStack
.static VkSparseBufferMemoryBindInfo.Buffer
mallocStack(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkSparseBufferMemoryBindInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkSparseBufferMemoryBindInfo
mallocStack(MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the specifiedMemoryStack
.VkSparseBufferMemoryBindInfo
nset(long struct)
Unsafe version ofset
.VkSparseMemoryBind.Buffer
pBinds()
Returns aVkSparseMemoryBind.Buffer
view of the struct array pointed to by thepBinds
field.VkSparseBufferMemoryBindInfo
pBinds(VkSparseMemoryBind.Buffer value)
Sets the address of the specifiedVkSparseMemoryBind.Buffer
to thepBinds
field.VkSparseBufferMemoryBindInfo
set(long buffer, VkSparseMemoryBind.Buffer pBinds)
Initializes this struct with the specified values.VkSparseBufferMemoryBindInfo
set(VkSparseBufferMemoryBindInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
CallsVkSparseBufferMemoryBindInfo.validate(long)
for each struct contained in the specified struct array.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkSparseBufferMemoryBindInfo
public VkSparseBufferMemoryBindInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
buffer
public long buffer()
Returns the value of thebuffer
field.
-
bindCount
public int bindCount()
Returns the value of thebindCount
field.
-
pBinds
public VkSparseMemoryBind.Buffer pBinds()
Returns aVkSparseMemoryBind.Buffer
view of the struct array pointed to by thepBinds
field.
-
buffer
public VkSparseBufferMemoryBindInfo buffer(long value)
Sets the specified value to thebuffer
field.
-
pBinds
public VkSparseBufferMemoryBindInfo pBinds(VkSparseMemoryBind.Buffer value)
Sets the address of the specifiedVkSparseMemoryBind.Buffer
to thepBinds
field.
-
set
public VkSparseBufferMemoryBindInfo set(long buffer, VkSparseMemoryBind.Buffer pBinds)
Initializes this struct with the specified values.
-
nset
public VkSparseBufferMemoryBindInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkSparseBufferMemoryBindInfo set(VkSparseBufferMemoryBindInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkSparseBufferMemoryBindInfo malloc()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkSparseBufferMemoryBindInfo calloc()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkSparseBufferMemoryBindInfo create()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated withBufferUtils
.
-
create
public static VkSparseBufferMemoryBindInfo create(long address)
Returns a newVkSparseBufferMemoryBindInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkSparseBufferMemoryBindInfo.Buffer malloc(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkSparseBufferMemoryBindInfo.Buffer calloc(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSparseBufferMemoryBindInfo.Buffer create(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSparseBufferMemoryBindInfo.Buffer create(long address, int capacity)
Create aVkSparseBufferMemoryBindInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkSparseBufferMemoryBindInfo mallocStack()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkSparseBufferMemoryBindInfo callocStack()
Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkSparseBufferMemoryBindInfo mallocStack(MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkSparseBufferMemoryBindInfo callocStack(MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkSparseBufferMemoryBindInfo.Buffer mallocStack(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkSparseBufferMemoryBindInfo.Buffer callocStack(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkSparseBufferMemoryBindInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkSparseBufferMemoryBindInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfo.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)
CallsVkSparseBufferMemoryBindInfo.validate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-