Package org.lwjgl.vulkan
Class VkSparseImageMemoryBindInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSparseImageMemoryBindInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkSparseImageMemoryBindInfo extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes a memory binding to a sparse image block of a
VkImageobject.Valid Usage
imagemust be a validVkImagehandlepBindsmust be a pointer to an array ofbindCountvalidVkSparseImageMemoryBindstructuresbindCountmust be greater than 0
Member documentation
image– theVkImageobject to be boundbindCount– the number ofVkSparseImageMemoryBindstructures inpBindsarraypBinds– a pointer to array ofVkSparseImageMemoryBindstructures
Layout
struct VkSparseImageMemoryBindInfo { VkImage image; uint32_t bindCount; const VkSparseImageMemoryBind * pBinds; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkSparseImageMemoryBindInfo.BufferAn array ofVkSparseImageMemoryBindInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkSparseImageMemoryBindInfo(java.nio.ByteBuffer container)Creates aVkSparseImageMemoryBindInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description intbindCount()Returns the value of thebindCountfield.static VkSparseImageMemoryBindInfocalloc()Returns a newVkSparseImageMemoryBindInfoinstance allocated withmemCalloc.static VkSparseImageMemoryBindInfo.Buffercalloc(int capacity)Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withmemCalloc.static VkSparseImageMemoryBindInfocallocStack()Returns a newVkSparseImageMemoryBindInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSparseImageMemoryBindInfo.BuffercallocStack(int capacity)Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSparseImageMemoryBindInfo.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSparseImageMemoryBindInfocallocStack(MemoryStack stack)Returns a newVkSparseImageMemoryBindInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSparseImageMemoryBindInfocreate()Returns a newVkSparseImageMemoryBindInfoinstance allocated withBufferUtils.static VkSparseImageMemoryBindInfo.Buffercreate(int capacity)Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withBufferUtils.static VkSparseImageMemoryBindInfocreate(long address)Returns a newVkSparseImageMemoryBindInfoinstance for the specified memory address ornullif the address isNULL.static VkSparseImageMemoryBindInfo.Buffercreate(long address, int capacity)Create aVkSparseImageMemoryBindInfo.Bufferinstance at the specified memory.longimage()Returns the value of theimagefield.VkSparseImageMemoryBindInfoimage(long value)Sets the specified value to theimagefield.static VkSparseImageMemoryBindInfomalloc()Returns a newVkSparseImageMemoryBindInfoinstance allocated withmemAlloc.static VkSparseImageMemoryBindInfo.Buffermalloc(int capacity)Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withmemAlloc.static VkSparseImageMemoryBindInfomallocStack()Returns a newVkSparseImageMemoryBindInfoinstance allocated on the thread-localMemoryStack.static VkSparseImageMemoryBindInfo.BuffermallocStack(int capacity)Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkSparseImageMemoryBindInfo.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkSparseImageMemoryBindInfomallocStack(MemoryStack stack)Returns a newVkSparseImageMemoryBindInfoinstance allocated on the specifiedMemoryStack.VkSparseImageMemoryBindInfonset(long struct)Unsafe version ofset.VkSparseImageMemoryBind.BufferpBinds()Returns aVkSparseImageMemoryBind.Bufferview of the struct array pointed to by thepBindsfield.VkSparseImageMemoryBindInfopBinds(VkSparseImageMemoryBind.Buffer value)Sets the address of the specifiedVkSparseImageMemoryBind.Bufferto thepBindsfield.VkSparseImageMemoryBindInfoset(long image, VkSparseImageMemoryBind.Buffer pBinds)Initializes this struct with the specified values.VkSparseImageMemoryBindInfoset(VkSparseImageMemoryBindInfo src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)CallsVkSparseImageMemoryBindInfo.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
-
VkSparseImageMemoryBindInfo
public VkSparseImageMemoryBindInfo(java.nio.ByteBuffer container)
Creates aVkSparseImageMemoryBindInfoinstance 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()
Description copied from class:StructReturns thesizeof(struct).
-
image
public long image()
Returns the value of theimagefield.
-
bindCount
public int bindCount()
Returns the value of thebindCountfield.
-
pBinds
public VkSparseImageMemoryBind.Buffer pBinds()
Returns aVkSparseImageMemoryBind.Bufferview of the struct array pointed to by thepBindsfield.
-
image
public VkSparseImageMemoryBindInfo image(long value)
Sets the specified value to theimagefield.
-
pBinds
public VkSparseImageMemoryBindInfo pBinds(VkSparseImageMemoryBind.Buffer value)
Sets the address of the specifiedVkSparseImageMemoryBind.Bufferto thepBindsfield.
-
set
public VkSparseImageMemoryBindInfo set(long image, VkSparseImageMemoryBind.Buffer pBinds)
Initializes this struct with the specified values.
-
nset
public VkSparseImageMemoryBindInfo nset(long struct)
Unsafe version ofset.
-
set
public VkSparseImageMemoryBindInfo set(VkSparseImageMemoryBindInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkSparseImageMemoryBindInfo malloc()
Returns a newVkSparseImageMemoryBindInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkSparseImageMemoryBindInfo calloc()
Returns a newVkSparseImageMemoryBindInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkSparseImageMemoryBindInfo create()
Returns a newVkSparseImageMemoryBindInfoinstance allocated withBufferUtils.
-
create
public static VkSparseImageMemoryBindInfo create(long address)
Returns a newVkSparseImageMemoryBindInfoinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkSparseImageMemoryBindInfo.Buffer malloc(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkSparseImageMemoryBindInfo.Buffer calloc(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkSparseImageMemoryBindInfo.Buffer create(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkSparseImageMemoryBindInfo.Buffer create(long address, int capacity)
Create aVkSparseImageMemoryBindInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkSparseImageMemoryBindInfo mallocStack()
Returns a newVkSparseImageMemoryBindInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkSparseImageMemoryBindInfo callocStack()
Returns a newVkSparseImageMemoryBindInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkSparseImageMemoryBindInfo mallocStack(MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkSparseImageMemoryBindInfo callocStack(MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkSparseImageMemoryBindInfo.Buffer mallocStack(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkSparseImageMemoryBindInfo.Buffer callocStack(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkSparseImageMemoryBindInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkSparseImageMemoryBindInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStackand 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)CallsVkSparseImageMemoryBindInfo.validate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-