Top Description Inners Fields Constructors Methods
org.lwjgl.util.vma

public Class VmaDefragmentationStats

extends Struct<VmaDefragmentationStats>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Statistics returned for defragmentation process in function EndDefragmentation.

Layout


struct VmaDefragmentationStats {
    VkDeviceSize bytesMoved;
    VkDeviceSize bytesFreed;
    uint32_t allocationsMoved;
    uint32_t deviceMemoryBlocksFreed;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ALLOCATIONSMOVED

The struct member offsets.

public static final int
BYTESFREED

The struct member offsets.

public static final int
BYTESMOVED

The struct member offsets.

public static final int
DEVICEMEMORYBLOCKSFREED

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VmaDefragmentationStats(long address, ByteBuffer container)

public
VmaDefragmentationStats(ByteBuffer container)

Creates a VmaDefragmentationStats instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
allocationsMoved()

number of allocations that have been moved to different places

public long
bytesFreed()

total number of bytes that have been released to the system by freeing empty VkDeviceMemory objects

public long
bytesMoved()

total number of bytes that have been copied while moving allocations to different places

public static VmaDefragmentationStats
calloc()

Returns a new VmaDefragmentationStats instance allocated with memCalloc.

public static VmaDefragmentationStats.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VmaDefragmentationStats.Buffer instance allocated with memCalloc.

public static VmaDefragmentationStats
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VmaDefragmentationStats instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VmaDefragmentationStats.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VmaDefragmentationStats.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VmaDefragmentationStats
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDefragmentationStats
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDefragmentationStats.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDefragmentationStats.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VmaDefragmentationStats
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VmaDefragmentationStats
create()

Returns a new VmaDefragmentationStats instance allocated with BufferUtils.

public static VmaDefragmentationStats
create(long address)

Returns a new VmaDefragmentationStats instance for the specified memory address.

public static VmaDefragmentationStats.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VmaDefragmentationStats.Buffer instance allocated with BufferUtils.

public static VmaDefragmentationStats.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VmaDefragmentationStats.Buffer instance at the specified memory.

public static VmaDefragmentationStats
createSafe(long address)

Like create, but returns null if address is NULL.

public static VmaDefragmentationStats.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
deviceMemoryBlocksFreed()

number of empty VkDeviceMemory objects that have been released to the system

public static VmaDefragmentationStats
malloc()

Returns a new VmaDefragmentationStats instance allocated with memAlloc.

public static VmaDefragmentationStats.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VmaDefragmentationStats.Buffer instance allocated with memAlloc.

public static VmaDefragmentationStats
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VmaDefragmentationStats instance allocated on the specified MemoryStack.

public static VmaDefragmentationStats.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VmaDefragmentationStats.Buffer instance allocated on the specified MemoryStack.

public static VmaDefragmentationStats
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDefragmentationStats
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDefragmentationStats.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaDefragmentationStats.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nallocationsMoved(long struct)

Unsafe version of allocationsMoved.

public static long
nbytesFreed(long struct)

Unsafe version of bytesFreed.

public static long
nbytesMoved(long struct)

Unsafe version of bytesMoved.

public static int
ndeviceMemoryBlocksFreed(long struct)

Unsafe version of deviceMemoryBlocksFreed.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

ALLOCATIONSMOVEDback to summary
public static final int ALLOCATIONSMOVED

The struct member offsets.

BYTESFREEDback to summary
public static final int BYTESFREED

The struct member offsets.

BYTESMOVEDback to summary
public static final int BYTESMOVED

The struct member offsets.

DEVICEMEMORYBLOCKSFREEDback to summary
public static final int DEVICEMEMORYBLOCKSFREED

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VmaDefragmentationStatsback to summary
protected VmaDefragmentationStats(long address, ByteBuffer container)
VmaDefragmentationStatsback to summary
public VmaDefragmentationStats(ByteBuffer container)

Creates a VmaDefragmentationStats instance at the current position of the specified ByteBuffer 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

allocationsMovedback to summary
public int allocationsMoved()

number of allocations that have been moved to different places

Annotations
@NativeType:uint32_t
bytesFreedback to summary
public long bytesFreed()

total number of bytes that have been released to the system by freeing empty VkDeviceMemory objects

Annotations
@NativeType:VkDeviceSize
bytesMovedback to summary
public long bytesMoved()

total number of bytes that have been copied while moving allocations to different places

Annotations
@NativeType:VkDeviceSize
callocback to summary
public static VmaDefragmentationStats calloc()

Returns a new VmaDefragmentationStats instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VmaDefragmentationStats.Buffer calloc(int capacity)

Returns a new VmaDefragmentationStats.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VmaDefragmentationStats calloc(MemoryStack stack)

Returns a new VmaDefragmentationStats instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VmaDefragmentationStats.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VmaDefragmentationStats.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VmaDefragmentationStats callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VmaDefragmentationStats callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VmaDefragmentationStats.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VmaDefragmentationStats.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VmaDefragmentationStats create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VmaDefragmentationStats create()

Returns a new VmaDefragmentationStats instance allocated with BufferUtils.

createback to summary
public static VmaDefragmentationStats create(long address)

Returns a new VmaDefragmentationStats instance for the specified memory address.

createback to summary
public static VmaDefragmentationStats.Buffer create(int capacity)

Returns a new VmaDefragmentationStats.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VmaDefragmentationStats.Buffer create(long address, int capacity)

Create a VmaDefragmentationStats.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VmaDefragmentationStats createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VmaDefragmentationStats.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
deviceMemoryBlocksFreedback to summary
public int deviceMemoryBlocksFreed()

number of empty VkDeviceMemory objects that have been released to the system

Annotations
@NativeType:uint32_t
mallocback to summary
public static VmaDefragmentationStats malloc()

Returns a new VmaDefragmentationStats instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VmaDefragmentationStats.Buffer malloc(int capacity)

Returns a new VmaDefragmentationStats.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VmaDefragmentationStats malloc(MemoryStack stack)

Returns a new VmaDefragmentationStats instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VmaDefragmentationStats.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VmaDefragmentationStats.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VmaDefragmentationStats mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VmaDefragmentationStats mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VmaDefragmentationStats.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VmaDefragmentationStats.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nallocationsMovedback to summary
public static int nallocationsMoved(long struct)

Unsafe version of allocationsMoved.

nbytesFreedback to summary
public static long nbytesFreed(long struct)

Unsafe version of bytesFreed.

nbytesMovedback to summary
public static long nbytesMoved(long struct)

Unsafe version of bytesMoved.

ndeviceMemoryBlocksFreedback to summary
public static int ndeviceMemoryBlocksFreed(long struct)

Unsafe version of deviceMemoryBlocksFreed.

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.util.vma back to summary

public Class VmaDefragmentationStats.Buffer

extends StructBuffer<VmaDefragmentationStats, VmaDefragmentationStats.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VmaDefragmentationStats structs.

Field Summary

Modifier and TypeField and Description
private static final VmaDefragmentationStats

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VmaDefragmentationStats.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int
public long

Returns:

the value of the VmaDefragmentationStats#bytesFreed field.
bytesFreed
()

public long

Returns:

the value of the VmaDefragmentationStats#bytesMoved field.
bytesMoved
()

public int
protected VmaDefragmentationStats
protected VmaDefragmentationStats.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VmaDefragmentationStats ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VmaDefragmentationStats.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VmaDefragmentationStats#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

allocationsMovedback to summary
public int allocationsMoved()
Returns:int

the value of the VmaDefragmentationStats#allocationsMoved field.

Annotations
@NativeType:uint32_t
bytesFreedback to summary
public long bytesFreed()
Returns:long

the value of the VmaDefragmentationStats#bytesFreed field.

Annotations
@NativeType:VkDeviceSize
bytesMovedback to summary
public long bytesMoved()
Returns:long

the value of the VmaDefragmentationStats#bytesMoved field.

Annotations
@NativeType:VkDeviceSize
deviceMemoryBlocksFreedback to summary
public int deviceMemoryBlocksFreed()
Returns:int

the value of the VmaDefragmentationStats#deviceMemoryBlocksFreed field.

Annotations
@NativeType:uint32_t
getElementFactoryback to summary
protected VmaDefragmentationStats getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
selfback to summary
protected VmaDefragmentationStats.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override