Package org.lwjgl.vulkan
Class VkSparseImageMemoryBindInfo
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSparseImageMemoryBindInfo>
org.lwjgl.vulkan.VkSparseImageMemoryBindInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkSparseImageMemoryBindInfo
extends org.lwjgl.system.Struct<VkSparseImageMemoryBindInfo>
implements org.lwjgl.system.NativeResource
Structure specifying sparse image memory bind information.
Valid Usage
- The
subresource.mipLevelmember of each element ofpBindsmust be less than themipLevelsspecified inVkImageCreateInfowhenimagewas created - The
subresource.arrayLayermember of each element ofpBindsmust be less than thearrayLayersspecified inVkImageCreateInfowhenimagewas created - The
subresource.aspectMaskmember of each element ofpBindsmust be valid for theformatspecified inVkImageCreateInfowhenimagewas created imagemust have been created withIMAGE_CREATE_SPARSE_RESIDENCY_BITset
Valid Usage (Implicit)
imagemust be a validVkImagehandlepBindsmust be a valid pointer to an array ofbindCountvalidVkSparseImageMemoryBindstructuresbindCountmust be greater than 0
See Also
VkBindSparseInfo, VkSparseImageMemoryBind
Layout
struct VkSparseImageMemoryBindInfo {
VkImage image();
uint32_t bindCount();
VkSparseImageMemoryBind const * pBinds();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkSparseImageMemoryBindInfo(ByteBuffer container) Creates aVkSparseImageMemoryBindInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionintthe number ofVkSparseImageMemoryBindstructures inpBindsarraystatic VkSparseImageMemoryBindInfocalloc()Returns a newVkSparseImageMemoryBindInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSparseImageMemoryBindInfocalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSparseImageMemoryBindInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSparseImageMemoryBindInfoDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkSparseImageMemoryBindInfocallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkSparseImageMemoryBindInfocreate()Returns a newVkSparseImageMemoryBindInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withBufferUtils.static VkSparseImageMemoryBindInfocreate(long address) Returns a newVkSparseImageMemoryBindInfoinstance for the specified memory address.create(long address, int capacity) Create aVkSparseImageMemoryBindInfo.Bufferinstance at the specified memory.static @Nullable VkSparseImageMemoryBindInfocreateSafe(long address) static @Nullable VkSparseImageMemoryBindInfo.BuffercreateSafe(long address, int capacity) longimage()theVkImageobject to be boundimage(long value) Sets the specified value to theimage()field.static VkSparseImageMemoryBindInfomalloc()Returns a newVkSparseImageMemoryBindInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkSparseImageMemoryBindInfomalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSparseImageMemoryBindInfoinstance allocated on the specifiedMemoryStack.static VkSparseImageMemoryBindInfoDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkSparseImageMemoryBindInfomallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnbindCount(long struct) Unsafe version ofbindCount().static voidnbindCount(long struct, int value) Sets the specified value to thebindCountfield of the specifiedstruct.static longnimage(long struct) Unsafe version ofimage().static voidnimage(long struct, long value) Unsafe version ofimage.npBinds(long struct) Unsafe version ofpBinds().static voidnpBinds(long struct, VkSparseImageMemoryBind.Buffer value) Unsafe version ofpBinds.pBinds()a pointer to an array ofVkSparseImageMemoryBindstructuresSets the address of the specifiedVkSparseImageMemoryBind.Bufferto thepBinds()field.set(long image, VkSparseImageMemoryBind.Buffer pBinds) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods 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. -
IMAGE
public static final int IMAGEThe struct member offsets. -
BINDCOUNT
public static final int BINDCOUNTThe struct member offsets. -
PBINDS
public static final int PBINDSThe struct member offsets.
-
-
Constructor Details
-
VkSparseImageMemoryBindInfo
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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkSparseImageMemoryBindInfo>
-
image
public long image()theVkImageobject to be bound -
bindCount
public int bindCount()the number ofVkSparseImageMemoryBindstructures inpBindsarray -
pBinds
a pointer to an array ofVkSparseImageMemoryBindstructures -
image
Sets the specified value to theimage()field. -
pBinds
Sets the address of the specifiedVkSparseImageMemoryBind.Bufferto 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 newVkSparseImageMemoryBindInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkSparseImageMemoryBindInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkSparseImageMemoryBindInfoinstance allocated withBufferUtils. -
create
Returns a newVkSparseImageMemoryBindInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkSparseImageMemoryBindInfo.Bufferinstance 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 public static VkSparseImageMemoryBindInfo mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkSparseImageMemoryBindInfo callocStack(org.lwjgl.system.MemoryStack stack) 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 VkSparseImageMemoryBindInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkSparseImageMemoryBindInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkSparseImageMemoryBindInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkSparseImageMemoryBindInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkSparseImageMemoryBindInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkSparseImageMemoryBindInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSparseImageMemoryBindInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nimage
public static long nimage(long struct) Unsafe version ofimage(). -
nbindCount
public static int nbindCount(long struct) Unsafe version ofbindCount(). -
npBinds
Unsafe version ofpBinds(). -
nimage
public static void nimage(long struct, long value) Unsafe version ofimage. -
nbindCount
public static void nbindCount(long struct, int value) Sets the specified value to thebindCountfield 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
-