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,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkSparseBufferMemoryBindInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying a sparse buffer memory bind operation.Valid Usage (Implicit)
buffermust be a validVkBufferhandlepBindsmust be a valid pointer to an array ofbindCountvalidVkSparseMemoryBindstructuresbindCountmust be greater than 0
See Also
VkBindSparseInfo,VkSparseMemoryBindMember documentation
buffer– theVkBufferobject to be bound.bindCount– the number ofVkSparseMemoryBindstructures in thepBindsarray.pBinds– a pointer to array ofVkSparseMemoryBindstructures.
Layout
struct VkSparseBufferMemoryBindInfo { VkBuffer buffer; uint32_t bindCount;VkSparseMemoryBindconst * pBinds; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkSparseBufferMemoryBindInfo.BufferAn array ofVkSparseBufferMemoryBindInfostructs.
-
Constructor Summary
Constructors Constructor Description VkSparseBufferMemoryBindInfo(java.nio.ByteBuffer container)Creates aVkSparseBufferMemoryBindInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intbindCount()Returns the value of thebindCountfield.longbuffer()Returns the value of thebufferfield.VkSparseBufferMemoryBindInfobuffer(long value)Sets the specified value to thebufferfield.static VkSparseBufferMemoryBindInfocalloc()Returns a newVkSparseBufferMemoryBindInfoinstance allocated withmemCalloc.static VkSparseBufferMemoryBindInfo.Buffercalloc(int capacity)Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated withmemCalloc.static VkSparseBufferMemoryBindInfocallocStack()Returns a newVkSparseBufferMemoryBindInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSparseBufferMemoryBindInfo.BuffercallocStack(int capacity)Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSparseBufferMemoryBindInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSparseBufferMemoryBindInfocallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkSparseBufferMemoryBindInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSparseBufferMemoryBindInfocreate()Returns a newVkSparseBufferMemoryBindInfoinstance allocated withBufferUtils.static VkSparseBufferMemoryBindInfo.Buffercreate(int capacity)Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated withBufferUtils.static VkSparseBufferMemoryBindInfocreate(long address)Returns a newVkSparseBufferMemoryBindInfoinstance for the specified memory address.static VkSparseBufferMemoryBindInfo.Buffercreate(long address, int capacity)Create aVkSparseBufferMemoryBindInfo.Bufferinstance at the specified memory.static VkSparseBufferMemoryBindInfocreateSafe(long address)static VkSparseBufferMemoryBindInfo.BuffercreateSafe(long address, int capacity)static VkSparseBufferMemoryBindInfomalloc()Returns a newVkSparseBufferMemoryBindInfoinstance allocated withmemAlloc.static VkSparseBufferMemoryBindInfo.Buffermalloc(int capacity)Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated withmemAlloc.static VkSparseBufferMemoryBindInfomallocStack()Returns a newVkSparseBufferMemoryBindInfoinstance allocated on the thread-localMemoryStack.static VkSparseBufferMemoryBindInfo.BuffermallocStack(int capacity)Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkSparseBufferMemoryBindInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkSparseBufferMemoryBindInfomallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkSparseBufferMemoryBindInfoinstance allocated on the specifiedMemoryStack.static intnbindCount(long struct)Unsafe version ofbindCount().static voidnbindCount(long struct, int value)Sets the specified value to thebindCountfield of the specifiedstruct.static longnbuffer(long struct)Unsafe version ofbuffer().static voidnbuffer(long struct, long value)Unsafe version ofbuffer.static VkSparseMemoryBind.BuffernpBinds(long struct)Unsafe version ofpBinds().static voidnpBinds(long struct, VkSparseMemoryBind.Buffer value)Unsafe version ofpBinds.VkSparseMemoryBind.BufferpBinds()Returns aVkSparseMemoryBind.Bufferview of the struct array pointed to by thepBindsfield.VkSparseBufferMemoryBindInfopBinds(VkSparseMemoryBind.Buffer value)Sets the address of the specifiedVkSparseMemoryBind.Bufferto thepBindsfield.VkSparseBufferMemoryBindInfoset(long buffer, VkSparseMemoryBind.Buffer pBinds)Initializes this struct with the specified values.VkSparseBufferMemoryBindInfoset(VkSparseBufferMemoryBindInfo src)Copies the specified struct data to this struct.intsizeof()static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkSparseBufferMemoryBindInfo
public VkSparseBufferMemoryBindInfo(java.nio.ByteBuffer container)
Creates aVkSparseBufferMemoryBindInfoinstance at the current position of the specifiedByteBuffercontainer. 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()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
buffer
public long buffer()
Returns the value of thebufferfield.
-
bindCount
public int bindCount()
Returns the value of thebindCountfield.
-
pBinds
public VkSparseMemoryBind.Buffer pBinds()
Returns aVkSparseMemoryBind.Bufferview of the struct array pointed to by thepBindsfield.
-
buffer
public VkSparseBufferMemoryBindInfo buffer(long value)
Sets the specified value to thebufferfield.
-
pBinds
public VkSparseBufferMemoryBindInfo pBinds(VkSparseMemoryBind.Buffer value)
Sets the address of the specifiedVkSparseMemoryBind.Bufferto thepBindsfield.
-
set
public VkSparseBufferMemoryBindInfo set(long buffer, VkSparseMemoryBind.Buffer pBinds)
Initializes this struct with the specified values.
-
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 newVkSparseBufferMemoryBindInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkSparseBufferMemoryBindInfo calloc()
Returns a newVkSparseBufferMemoryBindInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkSparseBufferMemoryBindInfo create()
Returns a newVkSparseBufferMemoryBindInfoinstance allocated withBufferUtils.
-
create
public static VkSparseBufferMemoryBindInfo create(long address)
Returns a newVkSparseBufferMemoryBindInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkSparseBufferMemoryBindInfo createSafe(long address)
-
malloc
public static VkSparseBufferMemoryBindInfo.Buffer malloc(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkSparseBufferMemoryBindInfo.Buffer calloc(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkSparseBufferMemoryBindInfo.Buffer create(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkSparseBufferMemoryBindInfo.Buffer create(long address, int capacity)
Create aVkSparseBufferMemoryBindInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkSparseBufferMemoryBindInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkSparseBufferMemoryBindInfo mallocStack()
Returns a newVkSparseBufferMemoryBindInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkSparseBufferMemoryBindInfo callocStack()
Returns a newVkSparseBufferMemoryBindInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkSparseBufferMemoryBindInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkSparseBufferMemoryBindInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfoinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkSparseBufferMemoryBindInfo.Buffer callocStack(int capacity)
Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkSparseBufferMemoryBindInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkSparseBufferMemoryBindInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseBufferMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nbuffer
public static long nbuffer(long struct)
Unsafe version ofbuffer().
-
nbindCount
public static int nbindCount(long struct)
Unsafe version ofbindCount().
-
npBinds
public static VkSparseMemoryBind.Buffer npBinds(long struct)
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 thebindCountfield of the specifiedstruct.
-
npBinds
public static void npBinds(long struct, VkSparseMemoryBind.Buffer value)Unsafe version ofpBinds.
-
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)Callsvalidate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-