Class VmaAllocationInfo
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
VmaAllocation
objects, that can be retrieved using function GetAllocationInfo
.
Layout
struct VmaAllocationInfo {
uint32_t memoryType()
;
VkDeviceMemory deviceMemory()
;
VkDeviceSize offset()
;
VkDeviceSize size()
;
void * pMappedData()
;
void * pUserData()
;
char const * pName()
;
}
-
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 member offsets.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
ConstructorDescriptionVmaAllocationInfo
(ByteBuffer container) Creates aVmaAllocationInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VmaAllocationInfo
calloc()
Returns a newVmaAllocationInfo
instance allocated withmemCalloc
.static VmaAllocationInfo.Buffer
calloc
(int capacity) Returns a newVmaAllocationInfo.Buffer
instance allocated withmemCalloc
.static VmaAllocationInfo.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVmaAllocationInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VmaAllocationInfo
calloc
(MemoryStack stack) Returns a newVmaAllocationInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VmaAllocationInfo
Deprecated.static VmaAllocationInfo.Buffer
callocStack
(int capacity) Deprecated.static VmaAllocationInfo.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static VmaAllocationInfo
callocStack
(MemoryStack stack) Deprecated.static VmaAllocationInfo
create()
Returns a newVmaAllocationInfo
instance allocated withBufferUtils
.static VmaAllocationInfo.Buffer
create
(int capacity) Returns a newVmaAllocationInfo.Buffer
instance allocated withBufferUtils
.static VmaAllocationInfo
create
(long address) Returns a newVmaAllocationInfo
instance for the specified memory address.static VmaAllocationInfo.Buffer
create
(long address, int capacity) Create aVmaAllocationInfo.Buffer
instance at the specified memory.static VmaAllocationInfo
createSafe
(long address) static VmaAllocationInfo.Buffer
createSafe
(long address, int capacity) long
handle to Vulkan memory object.static VmaAllocationInfo
malloc()
Returns a newVmaAllocationInfo
instance allocated withmemAlloc
.static VmaAllocationInfo.Buffer
malloc
(int capacity) Returns a newVmaAllocationInfo.Buffer
instance allocated withmemAlloc
.static VmaAllocationInfo.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVmaAllocationInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VmaAllocationInfo
malloc
(MemoryStack stack) Returns a newVmaAllocationInfo
instance allocated on the specifiedMemoryStack
.static VmaAllocationInfo
Deprecated.static VmaAllocationInfo.Buffer
mallocStack
(int capacity) Deprecated.static VmaAllocationInfo.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static VmaAllocationInfo
mallocStack
(MemoryStack stack) Deprecated.int
memory type index that this allocation was allocated from.static long
ndeviceMemory
(long struct) Unsafe version ofdeviceMemory()
.static int
nmemoryType
(long struct) Unsafe version ofmemoryType()
.static long
noffset
(long struct) Unsafe version ofoffset()
.static long
npMappedData
(long struct) Unsafe version ofpMappedData()
.static ByteBuffer
npName
(long struct) Unsafe version ofpName()
.static String
npNameString
(long struct) Unsafe version ofpNameString()
.static long
npUserData
(long struct) Unsafe version ofpUserData()
.static long
nsize
(long struct) Unsafe version ofsize()
.long
offset()
offset inVkDeviceMemory
object to the beginning of this allocation, in bytes.long
pointer to the beginning of this allocation as mapped data.pName()
Custom allocation name that was set withSetAllocationName
.Custom allocation name that was set withSetAllocationName
.long
custom general-purpose pointer that was passed asVmaAllocationCreateInfo
::pUserData
or set usingSetAllocationUserData
.long
size()
size of this allocation, in bytes.int
sizeof()
Returnssizeof(struct)
.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. -
MEMORYTYPE
public static final int MEMORYTYPEThe struct member offsets. -
DEVICEMEMORY
public static final int DEVICEMEMORYThe struct member offsets. -
OFFSET
public static final int OFFSETThe struct member offsets. -
SIZE
public static final int SIZEThe struct member offsets. -
PMAPPEDDATA
public static final int PMAPPEDDATAThe struct member offsets. -
PUSERDATA
public static final int PUSERDATAThe struct member offsets. -
PNAME
public static final int PNAMEThe struct member offsets.
-
-
Constructor Details
-
VmaAllocationInfo
Creates aVmaAllocationInfo
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<VmaAllocationInfo>
-
memoryType
public int memoryType()memory type index that this allocation was allocated from.It never changes.
-
deviceMemory
public long deviceMemory()handle to Vulkan memory object.Same memory object can be shared by multiple allocations.
It can change after the allocation is moved during defragmentation.
-
offset
public long offset()offset inVkDeviceMemory
object to the beginning of this allocation, in bytes.(deviceMemory, offset)
pair is unique to this allocation.You usually don't need to use this offset. If you create a buffer or an image together with the allocation using e.g. function
CreateBuffer
,CreateImage
, functions that operate on these resources refer to the beginning of the buffer or image, not entire device memory block. Functions likeMapMemory
,BindBufferMemory
also refer to the beginning of the allocation and apply this offset automatically.It can change after the allocation is moved during defragmentation.
-
size
public long size()size of this allocation, in bytes.It never changes.
Note
Allocation size returned in this variable may be greater than the size requested for the resource e.g. as
VkBufferCreateInfo::size
. Whole size of the allocation is accessible for operations on memory e.g. using a pointer after mapping withMapMemory
, but operations on the resource e.g. usingvkCmdCopyBuffer
must be limited to the size of the resource. -
pMappedData
public long pMappedData()pointer to the beginning of this allocation as mapped data.If the allocation hasn't been mapped using
MapMemory
and hasn't been created withALLOCATION_CREATE_MAPPED_BIT
flag, this value is null.It can change after call to
MapMemory
,UnmapMemory
. It can also change after the allocation is moved during defragmentation. -
pUserData
public long pUserData()custom general-purpose pointer that was passed asVmaAllocationCreateInfo
::pUserData
or set usingSetAllocationUserData
.It can change after call to
SetAllocationUserData
for this allocation. -
pName
Custom allocation name that was set withSetAllocationName
.It can change after call to
vmaSetAllocationName()
for this allocation.Another way to set custom name is to pass it in
VmaAllocationCreateInfo
::pUserData
with additional flagALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT
set (DEPRECATED). -
pNameString
Custom allocation name that was set withSetAllocationName
.It can change after call to
vmaSetAllocationName()
for this allocation.Another way to set custom name is to pass it in
VmaAllocationCreateInfo
::pUserData
with additional flagALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT
set (DEPRECATED). -
malloc
Returns a newVmaAllocationInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVmaAllocationInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVmaAllocationInfo
instance allocated withBufferUtils
. -
create
Returns a newVmaAllocationInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVmaAllocationInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVmaAllocationInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVmaAllocationInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVmaAllocationInfo.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.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVmaAllocationInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVmaAllocationInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVmaAllocationInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVmaAllocationInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nmemoryType
public static int nmemoryType(long struct) Unsafe version ofmemoryType()
. -
ndeviceMemory
public static long ndeviceMemory(long struct) Unsafe version ofdeviceMemory()
. -
noffset
public static long noffset(long struct) Unsafe version ofoffset()
. -
nsize
public static long nsize(long struct) Unsafe version ofsize()
. -
npMappedData
public static long npMappedData(long struct) Unsafe version ofpMappedData()
. -
npUserData
public static long npUserData(long struct) Unsafe version ofpUserData()
. -
npName
Unsafe version ofpName()
. -
npNameString
Unsafe version ofpNameString()
.
-