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

public Class VmaTotalStatistics

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

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

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
MEMORYHEAP

The struct member offsets.

public static final int
MEMORYTYPE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TOTAL

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VmaTotalStatistics(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VmaTotalStatistics
calloc()

Returns a new VmaTotalStatistics instance allocated with memCalloc.

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

Returns a new VmaTotalStatistics.Buffer instance allocated with memCalloc.

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

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

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

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

protected VmaTotalStatistics
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 VmaTotalStatistics
create()

Returns a new VmaTotalStatistics instance allocated with BufferUtils.

public static VmaTotalStatistics
create(long address)

Returns a new VmaTotalStatistics instance for the specified memory address.

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

Returns a new VmaTotalStatistics.Buffer instance allocated with BufferUtils.

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

Create a VmaTotalStatistics.Buffer instance at the specified memory.

public static VmaTotalStatistics
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VmaTotalStatistics
malloc()

Returns a new VmaTotalStatistics instance allocated with memAlloc.

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

Returns a new VmaTotalStatistics.Buffer instance allocated with memAlloc.

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

Returns a new VmaTotalStatistics instance allocated on the specified MemoryStack.

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

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

public VmaDetailedStatistics.Buffer

Returns:

a VmaDetailedStatistics.Buffer view of the memoryHeap field.
memoryHeap
()

public VmaDetailedStatistics

Returns:

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

public VmaDetailedStatistics.Buffer

Returns:

a VmaDetailedStatistics.Buffer view of the memoryType field.
memoryType
()

public VmaDetailedStatistics

Returns:

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

public static VmaDetailedStatistics.Buffer
nmemoryHeap(long struct)

Unsafe version of memoryHeap.

public static VmaDetailedStatistics
nmemoryHeap(long struct, int index)

Unsafe version of memoryHeap.

public static VmaDetailedStatistics.Buffer
nmemoryType(long struct)

Unsafe version of memoryType.

public static VmaDetailedStatistics
nmemoryType(long struct, int index)

Unsafe version of memoryType.

public static VmaDetailedStatistics
ntotal(long struct)

Unsafe version of total.

public int
sizeof()

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

Returns sizeof(struct).
public VmaDetailedStatistics

Returns:

a VmaDetailedStatistics view of the total field.
total
()

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.

MEMORYHEAPback to summary
public static final int MEMORYHEAP

The struct member offsets.

MEMORYTYPEback to summary
public static final int MEMORYTYPE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TOTALback to summary
public static final int TOTAL

The struct member offsets.

Constructor Detail

VmaTotalStatisticsback to summary
protected VmaTotalStatistics(long address, ByteBuffer container)
VmaTotalStatisticsback to summary
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 Detail

callocback to summary
public static VmaTotalStatistics calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VmaTotalStatistics calloc(MemoryStack stack)

Returns a new VmaTotalStatistics 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 VmaTotalStatistics.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VmaTotalStatistics.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

createback to summary
protected VmaTotalStatistics 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 VmaTotalStatistics create()

Returns a new VmaTotalStatistics instance allocated with BufferUtils.

createback to summary
public static VmaTotalStatistics create(long address)

Returns a new VmaTotalStatistics instance for the specified memory address.

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

Returns a new VmaTotalStatistics.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VmaTotalStatistics.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VmaTotalStatistics createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VmaTotalStatistics malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VmaTotalStatistics malloc(MemoryStack stack)

Returns a new VmaTotalStatistics instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

memoryHeapback to summary
public VmaDetailedStatistics.Buffer memoryHeap()
Returns:VmaDetailedStatistics.Buffer

a VmaDetailedStatistics.Buffer view of the memoryHeap field.

Annotations
@NativeType:VmaDetailedStatistics[16]
memoryHeapback to summary
public VmaDetailedStatistics memoryHeap(int index)
Returns:VmaDetailedStatistics

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

memoryTypeback to summary
public VmaDetailedStatistics.Buffer memoryType()
Returns:VmaDetailedStatistics.Buffer

a VmaDetailedStatistics.Buffer view of the memoryType field.

Annotations
@NativeType:VmaDetailedStatistics[32]
memoryTypeback to summary
public VmaDetailedStatistics memoryType(int index)
Returns:VmaDetailedStatistics

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

nmemoryHeapback to summary
public static VmaDetailedStatistics.Buffer nmemoryHeap(long struct)

Unsafe version of memoryHeap.

nmemoryHeapback to summary
public static VmaDetailedStatistics nmemoryHeap(long struct, int index)

Unsafe version of memoryHeap.

nmemoryTypeback to summary
public static VmaDetailedStatistics.Buffer nmemoryType(long struct)

Unsafe version of memoryType.

nmemoryTypeback to summary
public static VmaDetailedStatistics nmemoryType(long struct, int index)

Unsafe version of memoryType.

ntotalback to summary
public static VmaDetailedStatistics ntotal(long struct)

Unsafe version of total.

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
totalback to summary
public VmaDetailedStatistics total()
Returns:VmaDetailedStatistics

a VmaDetailedStatistics view of the total field.

org.lwjgl.util.vma back to summary

public Class VmaTotalStatistics.Buffer

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

An array of VmaTotalStatistics structs.

Field Summary

Modifier and TypeField and Description
private static final VmaTotalStatistics

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VmaTotalStatistics.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
protected VmaTotalStatistics
public VmaDetailedStatistics.Buffer

Returns:

a VmaDetailedStatistics.Buffer view of the memoryHeap field.
memoryHeap
()

public VmaDetailedStatistics

Returns:

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

public VmaDetailedStatistics.Buffer

Returns:

a VmaDetailedStatistics.Buffer view of the memoryType field.
memoryType
()

public VmaDetailedStatistics

Returns:

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

protected VmaTotalStatistics.Buffer
public VmaDetailedStatistics

Returns:

a VmaDetailedStatistics view of the total field.
total
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VmaTotalStatistics ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VmaTotalStatistics.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 VmaTotalStatistics#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

getElementFactoryback to summary
protected VmaTotalStatistics getElementFactory()

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

Annotations
@Override
memoryHeapback to summary
public VmaDetailedStatistics.Buffer memoryHeap()
Returns:VmaDetailedStatistics.Buffer

a VmaDetailedStatistics.Buffer view of the memoryHeap field.

Annotations
@NativeType:VmaDetailedStatistics[16]
memoryHeapback to summary
public VmaDetailedStatistics memoryHeap(int index)
Returns:VmaDetailedStatistics

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

memoryTypeback to summary
public VmaDetailedStatistics.Buffer memoryType()
Returns:VmaDetailedStatistics.Buffer

a VmaDetailedStatistics.Buffer view of the memoryType field.

Annotations
@NativeType:VmaDetailedStatistics[32]
memoryTypeback to summary
public VmaDetailedStatistics memoryType(int index)
Returns:VmaDetailedStatistics

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

selfback to summary
protected VmaTotalStatistics.Buffer self()

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

Annotations
@Override
totalback to summary
public VmaDetailedStatistics total()
Returns:VmaDetailedStatistics

a VmaDetailedStatistics view of the total field.