Package org.lwjgl.util.vma

Class VmaTotalStatistics

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VmaTotalStatistics>

org.lwjgl.util.vma.VmaTotalStatistics

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VmaTotalStatistics
extends org.lwjgl.system.Struct<VmaTotalStatistics>
implements org.lwjgl.system.NativeResource

General statistics from current state of the Allocator - total memory usage across all memory heaps and types.

These are slower to calculate. Use for debugging purposes.

Layout

 struct VmaTotalStatistics {
     VmaDetailedStatistics memoryType[32];
     VmaDetailedStatistics memoryHeap[16];
     VmaDetailedStatistics total;
 }

See Also:

• Vma.vmaCalculateStatistics(long, org.lwjgl.util.vma.VmaTotalStatistics)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VmaTotalStatistics.Buffer	An array of VmaTotalStatistics structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	MEMORYHEAP	The struct member offsets.
static final int	MEMORYTYPE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TOTAL	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VmaTotalStatistics(ByteBuffer container)	Creates a VmaTotalStatistics instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VmaTotalStatistics	calloc()	Returns a new VmaTotalStatistics instance allocated with memCalloc.
static VmaTotalStatistics.Buffer	calloc(int capacity)	Returns a new VmaTotalStatistics.Buffer instance allocated with memCalloc.
static VmaTotalStatistics.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VmaTotalStatistics.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaTotalStatistics	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VmaTotalStatistics instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaTotalStatistics	create()	Returns a new VmaTotalStatistics instance allocated with BufferUtils.
static VmaTotalStatistics.Buffer	create(int capacity)	Returns a new VmaTotalStatistics.Buffer instance allocated with BufferUtils.
static VmaTotalStatistics	create(long address)	Returns a new VmaTotalStatistics instance for the specified memory address.
static VmaTotalStatistics.Buffer	create(long address, int capacity)	Create a VmaTotalStatistics.Buffer instance at the specified memory.
static @Nullable VmaTotalStatistics	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VmaTotalStatistics.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VmaTotalStatistics	malloc()	Returns a new VmaTotalStatistics instance allocated with memAlloc.
static VmaTotalStatistics.Buffer	malloc(int capacity)	Returns a new VmaTotalStatistics.Buffer instance allocated with memAlloc.
static VmaTotalStatistics.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VmaTotalStatistics.Buffer instance allocated on the specified MemoryStack.
static VmaTotalStatistics	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VmaTotalStatistics instance allocated on the specified MemoryStack.
VmaDetailedStatistics.Buffer	memoryHeap()
VmaDetailedStatistics	memoryHeap(int index)
VmaDetailedStatistics.Buffer	memoryType()
VmaDetailedStatistics	memoryType(int index)
static VmaDetailedStatistics.Buffer	nmemoryHeap(long struct)	Unsafe version of memoryHeap().
static VmaDetailedStatistics	nmemoryHeap(long struct, int index)	Unsafe version of memoryHeap.
static VmaDetailedStatistics.Buffer	nmemoryType(long struct)	Unsafe version of memoryType().
static VmaDetailedStatistics	nmemoryType(long struct, int index)	Unsafe version of memoryType.
static VmaDetailedStatistics	ntotal(long struct)	Unsafe version of total().
int	sizeof()
VmaDetailedStatistics	total()

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

MEMORYTYPE

public static final int MEMORYTYPE

The struct member offsets.

MEMORYHEAP

public static final int MEMORYHEAP

The struct member offsets.

TOTAL

public static final int TOTAL

The struct member offsets.

Constructor Details

VmaTotalStatistics

public VmaTotalStatistics(ByteBuffer container)

Creates a VmaTotalStatistics 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VmaTotalStatistics>

memoryType

public VmaDetailedStatistics.Buffer memoryType()

Returns:

a VmaDetailedStatistics.Buffer view of the memoryType field.

memoryType

public VmaDetailedStatistics memoryType(int index)

Returns:

a VmaDetailedStatistics view of the struct at the specified index of the memoryType field.

memoryHeap

public VmaDetailedStatistics.Buffer memoryHeap()

Returns:

a VmaDetailedStatistics.Buffer view of the memoryHeap field.

memoryHeap

public VmaDetailedStatistics memoryHeap(int index)

Returns:

a VmaDetailedStatistics view of the struct at the specified index of the memoryHeap field.

total

public VmaDetailedStatistics total()

Returns:

a VmaDetailedStatistics view of the total field.

malloc

public static VmaTotalStatistics malloc()

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

calloc

public static VmaTotalStatistics calloc()

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

create

public static VmaTotalStatistics create()

Returns a new VmaTotalStatistics instance allocated with BufferUtils.

create

public static VmaTotalStatistics create(long address)

Returns a new VmaTotalStatistics instance for the specified memory address.

createSafe

public static @Nullable VmaTotalStatistics createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VmaTotalStatistics.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VmaTotalStatistics.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VmaTotalStatistics.Buffer create(int capacity)

Returns a new VmaTotalStatistics.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VmaTotalStatistics.Buffer create(long address,
 int capacity)

Create a VmaTotalStatistics.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VmaTotalStatistics.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VmaTotalStatistics malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VmaTotalStatistics instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VmaTotalStatistics calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VmaTotalStatistics.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VmaTotalStatistics.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nmemoryType

public static VmaDetailedStatistics.Buffer nmemoryType(long struct)

Unsafe version of memoryType().

nmemoryType

public static VmaDetailedStatistics nmemoryType(long struct,
 int index)

Unsafe version of memoryType.

nmemoryHeap

public static VmaDetailedStatistics.Buffer nmemoryHeap(long struct)

Unsafe version of memoryHeap().

nmemoryHeap

public static VmaDetailedStatistics nmemoryHeap(long struct,
 int index)

Unsafe version of memoryHeap.

ntotal

public static VmaDetailedStatistics ntotal(long struct)

Unsafe version of total().