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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	BUDGET The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STATISTICS The struct member offsets.
public static final int	USAGE The struct member offsets.

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

Method Summary

Modifier and Type	Method and Description
public long	budget() Estimated amount of memory available to the program, in bytes.
public static VmaBudget	calloc() Returns a new `VmaBudget` instance allocated with `memCalloc`.
public static VmaBudget.Buffer	calloc(int the buffer capacity capacity) Returns a new `VmaBudget.Buffer` instance allocated with `memCalloc`.
public static VmaBudget	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VmaBudget` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VmaBudget.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VmaBudget.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VmaBudget	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 VmaBudget	create() Returns a new `VmaBudget` instance allocated with `BufferUtils`.
public static VmaBudget	create(long address) Returns a new `VmaBudget` instance for the specified memory address.
public static VmaBudget.Buffer	create(int the buffer capacity capacity) Returns a new `VmaBudget.Buffer` instance allocated with `BufferUtils`.
public static VmaBudget.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VmaBudget.Buffer` instance at the specified memory.
public static VmaBudget	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VmaBudget.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VmaBudget	malloc() Returns a new `VmaBudget` instance allocated with `memAlloc`.
public static VmaBudget.Buffer	malloc(int the buffer capacity capacity) Returns a new `VmaBudget.Buffer` instance allocated with `memAlloc`.
public static VmaBudget	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VmaBudget` instance allocated on the specified `MemoryStack`.
public static VmaBudget.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VmaBudget.Buffer` instance allocated on the specified `MemoryStack`.
public static long	nbudget(long struct) Unsafe version of `budget`.
public static VmaStatistics	nstatistics(long struct) Unsafe version of `statistics`.
public static long	nusage(long struct) Unsafe version of `usage`.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public VmaStatistics	statistics() statistics fetched from the library
public long	usage() Estimated current memory usage of the program, in bytes.

Field Detail

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

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

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

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

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

Constructor Detail

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

VmaBudget back to summary

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

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

budget back to summary

budget	back to summary
public long budget() Estimated amount of memory available to the program, in bytes. Fetched from system using `VK_EXT_memory_budget` extension if enabled. It might be different (most probably smaller) than `VkMemoryHeap::size[heapIndex]` due to factors external to the program, decided by the operating system. Difference `budget - usage` is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems. Annotations @NativeType:VkDeviceSize

public long budget()

Estimated amount of memory available to the program, in bytes.

Fetched from system using VK_EXT_memory_budget extension if enabled.

It might be different (most probably smaller) than VkMemoryHeap::size[heapIndex] due to factors external to the program, decided by the operating system. Difference budget - usage is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.

Annotations

@NativeType:VkDeviceSize

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

calloc back to summary

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

public static VmaBudget.Buffer calloc(int capacity)

Returns a new VmaBudget.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 VmaBudget calloc(MemoryStack stack) Returns a new `VmaBudget` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VmaBudget calloc(MemoryStack stack)

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

Returns a new VmaBudget.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 VmaBudget 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 VmaBudget 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 VmaBudget create() Returns a new `VmaBudget` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VmaBudget.Buffer create(int capacity)

Returns a new VmaBudget.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VmaBudget.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 VmaBudget createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VmaBudget createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

malloc back to summary

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

public static VmaBudget.Buffer malloc(int capacity)

Returns a new VmaBudget.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 VmaBudget malloc(MemoryStack stack) Returns a new `VmaBudget` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VmaBudget malloc(MemoryStack stack)

Returns a new VmaBudget 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 VmaBudget.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VmaBudget.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

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

nbudget	back to summary
public static long nbudget(long struct) Unsafe version of `budget`.

nstatistics	back to summary
public static VmaStatistics nstatistics(long struct) Unsafe version of `statistics`.

nusage	back to summary
public static long nusage(long struct) Unsafe version of `usage`.

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

statistics	back to summary
public VmaStatistics statistics() statistics fetched from the library

usage back to summary

usage	back to summary
public long usage() Estimated current memory usage of the program, in bytes. Fetched from system using `VK_EXT_memory_budget` extension if enabled. It might be different than `statistics.blockBytes` (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipelines, descriptor heaps, command buffers, or `VkDeviceMemory` blocks allocated outside of this library, if any. Annotations @NativeType:VkDeviceSize

public long usage()

Estimated current memory usage of the program, in bytes.

Fetched from system using VK_EXT_memory_budget extension if enabled.

It might be different than statistics.blockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipelines, descriptor heaps, command buffers, or VkDeviceMemory blocks allocated outside of this library, if any.

Annotations

@NativeType:VkDeviceSize

org.lwjgl.util.vma back to summary

public Class VmaBudget.Buffer

Class Inheritance

extends StructBuffer<VmaBudget, VmaBudget.Buffer>
implements NativeResource

All Implemented Interfaces

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

An array of VmaBudget structs.

Field Summary

Modifier and Type	Field and Description
private static final VmaBudget	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VmaBudget.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 `VmaBudget#budget` field. budget()
protected VmaBudget	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VmaBudget.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public VmaStatistics	Returns: a `VmaStatistics` view of the `VmaBudget#statistics` field. statistics()
public long	Returns: the value of the `VmaBudget#usage` field. usage()

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 VmaBudget ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

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

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

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

getElementFactory

back to summary

protected VmaBudget getElementFactory()

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

Annotations

@Override

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

self

back to summary

protected VmaBudget.Buffer self()

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

Annotations

@Override

statistics	back to summary
public VmaStatistics statistics() Returns:VmaStatistics a `VmaStatistics` view of the `VmaBudget#statistics` field.

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

public Class VmaBudget

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VmaBudget.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail