Modifier and Type	Class and Description
public static class	VmaStatistics.Buffer An array of `VmaStatistics` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	ALLOCATIONBYTES The struct member offsets.
public static final int	ALLOCATIONCOUNT The struct member offsets.
public static final int	BLOCKBYTES The struct member offsets.
public static final int	BLOCKCOUNT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Access	Constructor and Description
protected	VmaStatistics(long address, ByteBuffer container)
public	VmaStatistics(ByteBuffer container) Creates a `VmaStatistics` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public long	allocationBytes() total number of bytes occupied by all `VmaAllocation` objects.
public int	allocationCount() number of `VmaAllocation` objects allocated.
public long	blockBytes() number of bytes allocated in `VkDeviceMemory` blocks.
public int	blockCount() number of `VkDeviceMemory` objects - Vulkan memory blocks allocated
public static VmaStatistics	calloc() Returns a new `VmaStatistics` instance allocated with `memCalloc`.
public static VmaStatistics.Buffer	calloc(int the buffer capacity capacity) Returns a new `VmaStatistics.Buffer` instance allocated with `memCalloc`.
public static VmaStatistics	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VmaStatistics` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VmaStatistics.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VmaStatistics.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VmaStatistics	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 VmaStatistics	create() Returns a new `VmaStatistics` instance allocated with `BufferUtils`.
public static VmaStatistics	create(long address) Returns a new `VmaStatistics` instance for the specified memory address.
public static VmaStatistics.Buffer	create(int the buffer capacity capacity) Returns a new `VmaStatistics.Buffer` instance allocated with `BufferUtils`.
public static VmaStatistics.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VmaStatistics.Buffer` instance at the specified memory.
public static VmaStatistics	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VmaStatistics.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VmaStatistics	malloc() Returns a new `VmaStatistics` instance allocated with `memAlloc`.
public static VmaStatistics.Buffer	malloc(int the buffer capacity capacity) Returns a new `VmaStatistics.Buffer` instance allocated with `memAlloc`.
public static VmaStatistics	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VmaStatistics` instance allocated on the specified `MemoryStack`.
public static VmaStatistics.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VmaStatistics.Buffer` instance allocated on the specified `MemoryStack`.
public static long	nallocationBytes(long struct) Unsafe version of `allocationBytes`.
public static int	nallocationCount(long struct) Unsafe version of `allocationCount`.
public static long	nblockBytes(long struct) Unsafe version of `blockBytes`.
public static int	nblockCount(long struct) Unsafe version of `blockCount`.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

ALLOCATIONBYTES	back to summary
public static final int ALLOCATIONBYTES The struct member offsets.

ALLOCATIONCOUNT	back to summary
public static final int ALLOCATIONCOUNT The struct member offsets.

BLOCKBYTES	back to summary
public static final int BLOCKBYTES The struct member offsets.

BLOCKCOUNT	back to summary
public static final int BLOCKCOUNT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

VmaStatistics	back to summary
protected VmaStatistics(long address, ByteBuffer container)

VmaStatistics back to summary

VmaStatistics	back to summary
public VmaStatistics(ByteBuffer container) Creates a `VmaStatistics` 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.

public VmaStatistics(ByteBuffer container)

Creates a VmaStatistics 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

allocationBytes back to summary

allocationBytes	back to summary
public long allocationBytes() total number of bytes occupied by all `VmaAllocation` objects. Always less or equal than `blockBytes`. Difference `(blockBytes - allocationBytes)` is the amount of memory allocated from Vulkan but unused by any `VmaAllocation`. Annotations @NativeType:VkDeviceSize

public long allocationBytes()

total number of bytes occupied by all VmaAllocation objects.

Always less or equal than blockBytes. Difference (blockBytes - allocationBytes) is the amount of memory allocated from Vulkan but unused by any VmaAllocation.

Annotations

@NativeType:VkDeviceSize

allocationCount back to summary

allocationCount	back to summary
public int allocationCount() number of `VmaAllocation` objects allocated. Dedicated allocations have their own blocks, so each one adds 1 to `allocationCount` as well as `blockCount`. Annotations @NativeType:uint32_t

public int allocationCount()

number of VmaAllocation objects allocated.

Dedicated allocations have their own blocks, so each one adds 1 to allocationCount as well as blockCount.

Annotations

@NativeType:uint32_t

blockBytes back to summary

blockBytes	back to summary
public long blockBytes() number of bytes allocated in `VkDeviceMemory` blocks. To avoid confusion, please be aware that what Vulkan calls an "allocation" - a whole `VkDeviceMemory` object (e.g. as in `VkPhysicalDeviceLimits::maxMemoryAllocationCount`) is called a "block" in VMA, while VMA calls "allocation" a `VmaAllocation` object that represents a memory region sub-allocated from such block, usually for a single buffer or image. Annotations @NativeType:VkDeviceSize

public long blockBytes()

number of bytes allocated in VkDeviceMemory blocks.

To avoid confusion, please be aware that what Vulkan calls an "allocation" - a whole VkDeviceMemory object (e.g. as in VkPhysicalDeviceLimits::maxMemoryAllocationCount) is called a "block" in VMA, while VMA calls "allocation" a VmaAllocation object that represents a memory region sub-allocated from such block, usually for a single buffer or image.

Annotations

@NativeType:VkDeviceSize

blockCount back to summary

blockCount	back to summary
public int blockCount() number of `VkDeviceMemory` objects - Vulkan memory blocks allocated Annotations @NativeType:uint32_t

public int blockCount()

number of VkDeviceMemory objects - Vulkan memory blocks allocated

Annotations

@NativeType:uint32_t

calloc	back to summary
public static VmaStatistics calloc() Returns a new `VmaStatistics` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VmaStatistics.Buffer calloc(int capacity) Returns a new `VmaStatistics.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VmaStatistics.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VmaStatistics calloc(MemoryStack stack) Returns a new `VmaStatistics` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VmaStatistics calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VmaStatistics.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VmaStatistics.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

public static VmaStatistics.Buffer calloc(int capacity, MemoryStack stack)

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

create back to summary

create	back to summary
protected VmaStatistics 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

protected VmaStatistics 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

create	back to summary
public static VmaStatistics create() Returns a new `VmaStatistics` instance allocated with `BufferUtils`.

create	back to summary
public static VmaStatistics create(long address) Returns a new `VmaStatistics` instance for the specified memory address.

create back to summary

create	back to summary
public static VmaStatistics.Buffer create(int capacity) Returns a new `VmaStatistics.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VmaStatistics.Buffer create(int capacity)

Returns a new VmaStatistics.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VmaStatistics.Buffer create(long address, int capacity) Create a `VmaStatistics.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VmaStatistics.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VmaStatistics createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VmaStatistics createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VmaStatistics.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static VmaStatistics malloc() Returns a new `VmaStatistics` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VmaStatistics.Buffer malloc(int capacity) Returns a new `VmaStatistics.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VmaStatistics.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VmaStatistics malloc(MemoryStack stack) Returns a new `VmaStatistics` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VmaStatistics malloc(MemoryStack stack)

Returns a new VmaStatistics instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VmaStatistics.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VmaStatistics.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VmaStatistics.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

nallocationBytes	back to summary
public static long nallocationBytes(long struct) Unsafe version of `allocationBytes`.

nallocationCount	back to summary
public static int nallocationCount(long struct) Unsafe version of `allocationCount`.

nblockBytes	back to summary
public static long nblockBytes(long struct) Unsafe version of `blockBytes`.

nblockCount	back to summary
public static int nblockCount(long struct) Unsafe version of `blockCount`.

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

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 VmaStatistics.Buffer

Class Inheritance

extends StructBuffer<VmaStatistics, VmaStatistics.Buffer>
implements NativeResource

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VmaStatistics structs.

Field Summary

Modifier and Type	Field and Description
private static final VmaStatistics	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VmaStatistics.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 Type	Method and Description
public long	Returns: the value of the `VmaStatistics#allocationBytes` field. allocationBytes()
public int	Returns: the value of the `VmaStatistics#allocationCount` field. allocationCount()
public long	Returns: the value of the `VmaStatistics#blockBytes` field. blockBytes()
public int	Returns: the value of the `VmaStatistics#blockCount` field. blockCount()
protected VmaStatistics	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VmaStatistics.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VmaStatistics ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VmaStatistics.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 `VmaStatistics#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VmaStatistics.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 VmaStatistics#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

allocationBytes	back to summary
public long allocationBytes() Returns:long the value of the `VmaStatistics#allocationBytes` field. Annotations @NativeType:VkDeviceSize

allocationCount	back to summary
public int allocationCount() Returns:int the value of the `VmaStatistics#allocationCount` field. Annotations @NativeType:uint32_t

blockBytes	back to summary
public long blockBytes() Returns:long the value of the `VmaStatistics#blockBytes` field. Annotations @NativeType:VkDeviceSize

blockCount	back to summary
public int blockCount() Returns:int the value of the `VmaStatistics#blockCount` field. Annotations @NativeType:uint32_t

getElementFactory	back to summary
protected VmaStatistics getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected VmaStatistics getElementFactory()

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

Annotations

@Override

self	back to summary
protected VmaStatistics.Buffer self() Implements abstract org.lwjgl.system.CustomBuffer.self. Annotations @Override

self

back to summary

protected VmaStatistics.Buffer self()

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

Annotations

@Override

public Class VmaStatistics

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VmaStatistics.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail