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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	FLAGS The struct member offsets.
public static final int	MEMORYTYPEBITS The struct member offsets.
public static final int	POOL The struct member offsets.
public static final int	PREFERREDFLAGS The struct member offsets.
public static final int	PRIORITY The struct member offsets.
public static final int	PUSERDATA The struct member offsets.
public static final int	REQUIREDFLAGS The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	USAGE The struct member offsets.

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

Method Summary

Modifier and Type	Method and Description
public static VmaAllocationCreateInfo	calloc() Returns a new `VmaAllocationCreateInfo` instance allocated with `memCalloc`.
public static VmaAllocationCreateInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated with `memCalloc`.
public static VmaAllocationCreateInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VmaAllocationCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VmaAllocationCreateInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VmaAllocationCreateInfo	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VmaAllocationCreateInfo	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VmaAllocationCreateInfo.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VmaAllocationCreateInfo.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VmaAllocationCreateInfo	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 VmaAllocationCreateInfo	create() Returns a new `VmaAllocationCreateInfo` instance allocated with `BufferUtils`.
public static VmaAllocationCreateInfo	create(long address) Returns a new `VmaAllocationCreateInfo` instance for the specified memory address.
public static VmaAllocationCreateInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated with `BufferUtils`.
public static VmaAllocationCreateInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VmaAllocationCreateInfo.Buffer` instance at the specified memory.
public static VmaAllocationCreateInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VmaAllocationCreateInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() use `VmaAllocationCreateFlagBits` enum.
public VmaAllocationCreateInfo	flags(int value) Sets the specified value to the `flags` field.
public static VmaAllocationCreateInfo	malloc() Returns a new `VmaAllocationCreateInfo` instance allocated with `memAlloc`.
public static VmaAllocationCreateInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated with `memAlloc`.
public static VmaAllocationCreateInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VmaAllocationCreateInfo` instance allocated on the specified `MemoryStack`.
public static VmaAllocationCreateInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static VmaAllocationCreateInfo	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VmaAllocationCreateInfo	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VmaAllocationCreateInfo.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VmaAllocationCreateInfo.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public int	memoryTypeBits() bitmask containing one bit set for every memory type acceptable for this allocation.
public VmaAllocationCreateInfo	memoryTypeBits(int value) Sets the specified value to the `memoryTypeBits` field.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static int	nmemoryTypeBits(long struct) Unsafe version of `memoryTypeBits`.
public static void	nmemoryTypeBits(long struct, int value) Unsafe version of `memoryTypeBits`.
public static long	npool(long struct) Unsafe version of `pool`.
public static void	npool(long struct, long value) Unsafe version of `pool`.
public static int	npreferredFlags(long struct) Unsafe version of `preferredFlags`.
public static void	npreferredFlags(long struct, int value) Unsafe version of `preferredFlags`.
public static float	npriority(long struct) Unsafe version of `priority`.
public static void	npriority(long struct, float value) Unsafe version of `priority`.
public static long	npUserData(long struct) Unsafe version of `pUserData`.
public static void	npUserData(long struct, long value) Unsafe version of `pUserData`.
public static int	nrequiredFlags(long struct) Unsafe version of `requiredFlags`.
public static void	nrequiredFlags(long struct, int value) Unsafe version of `requiredFlags`.
public static int	nusage(long struct) Unsafe version of `usage`.
public static void	nusage(long struct, int value) Unsafe version of `usage`.
public long	pool() pool that this allocation should be created in. Leave `VK_NULL_HANDLE` to allocate from default pool.
public VmaAllocationCreateInfo	pool(long value) Sets the specified value to the `pool` field.
public int	preferredFlags() flags that preferably should be set in a memory type chosen for an allocation.
public VmaAllocationCreateInfo	preferredFlags(int value) Sets the specified value to the `preferredFlags` field.
public float	priority() A floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations.
public VmaAllocationCreateInfo	priority(float value) Sets the specified value to the `priority` field.
public long	pUserData() custom general-purpose pointer that will be stored in `VmaAllocation`, can be read as `VmaAllocationInfo::pUserData` and changed using `SetAllocationUserData`.
public VmaAllocationCreateInfo	pUserData(long value) Sets the specified value to the `pUserData` field.
public int	requiredFlags() flags that must be set in a Memory Type chosen for an allocation.
public VmaAllocationCreateInfo	requiredFlags(int value) Sets the specified value to the `requiredFlags` field.
public VmaAllocationCreateInfo	set(int flags, int usage, int requiredFlags, int preferredFlags, int memoryTypeBits, long pool, long pUserData, float priority) Initializes this struct with the specified values.
public VmaAllocationCreateInfo	Returns: this struct set(VmaAllocationCreateInfo the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	usage() intended usage of memory.
public VmaAllocationCreateInfo	usage(int value) Sets the specified value to the `usage` field.

Field Detail

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

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

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

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

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

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

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

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

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

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

Constructor Detail

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

VmaAllocationCreateInfo back to summary

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

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

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

calloc back to summary

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

public static VmaAllocationCreateInfo.Buffer calloc(int capacity)

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

public static VmaAllocationCreateInfo calloc(MemoryStack stack)

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

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

callocStack back to summary

callocStack	back to summary
public static VmaAllocationCreateInfo callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VmaAllocationCreateInfo callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VmaAllocationCreateInfo callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VmaAllocationCreateInfo callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VmaAllocationCreateInfo.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VmaAllocationCreateInfo.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VmaAllocationCreateInfo.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VmaAllocationCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected VmaAllocationCreateInfo 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 VmaAllocationCreateInfo 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 VmaAllocationCreateInfo create() Returns a new `VmaAllocationCreateInfo` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VmaAllocationCreateInfo.Buffer create(int capacity)

Returns a new VmaAllocationCreateInfo.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static VmaAllocationCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

flags back to summary

public int flags()

use VmaAllocationCreateFlagBits enum. One or more of:

`ALLOCATION_CREATE_DEDICATED_MEMORY_BIT`	`ALLOCATION_CREATE_NEVER_ALLOCATE_BIT`
`ALLOCATION_CREATE_MAPPED_BIT`	`ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT`
`ALLOCATION_CREATE_UPPER_ADDRESS_BIT`	`ALLOCATION_CREATE_DONT_BIND_BIT`
`ALLOCATION_CREATE_WITHIN_BUDGET_BIT`	`ALLOCATION_CREATE_CAN_ALIAS_BIT`
`ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT`	`ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT`
`ALLOCATION_CREATE_HOST_ACCESS_ALLOW_TRANSFER_INSTEAD_BIT`	`ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT`
`ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT`	`ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT`
`ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT`	`ALLOCATION_CREATE_STRATEGY_MASK`

Annotations

@NativeType:VmaAllocationCreateFlags

flags	back to summary
public VmaAllocationCreateInfo flags(int value) Sets the specified value to the `flags` field.

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

malloc back to summary

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

public static VmaAllocationCreateInfo.Buffer malloc(int capacity)

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

public static VmaAllocationCreateInfo malloc(MemoryStack stack)

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

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

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

Parameters

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

mallocStack back to summary

mallocStack	back to summary
public static VmaAllocationCreateInfo mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VmaAllocationCreateInfo mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VmaAllocationCreateInfo mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VmaAllocationCreateInfo mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VmaAllocationCreateInfo.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VmaAllocationCreateInfo.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VmaAllocationCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VmaAllocationCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

memoryTypeBits back to summary

memoryTypeBits	back to summary
public int memoryTypeBits() bitmask containing one bit set for every memory type acceptable for this allocation. Value 0 is equivalent to `UINT32_MAX` - it means any memory type is accepted if it meets other requirements specified by this structure, with no further restrictions on memory type index. If `pool` is not null, this member is ignored. Annotations @NativeType:uint32_t

public int memoryTypeBits()

bitmask containing one bit set for every memory type acceptable for this allocation.

Value 0 is equivalent to UINT32_MAX - it means any memory type is accepted if it meets other requirements specified by this structure, with no further restrictions on memory type index. If pool is not null, this member is ignored.

Annotations

@NativeType:uint32_t

memoryTypeBits	back to summary
public VmaAllocationCreateInfo memoryTypeBits(int value) Sets the specified value to the `memoryTypeBits` field.

nflags	back to summary
public static int nflags(long struct) Unsafe version of `flags`.

nflags	back to summary
public static void nflags(long struct, int value) Unsafe version of `flags`.

nmemoryTypeBits	back to summary
public static int nmemoryTypeBits(long struct) Unsafe version of `memoryTypeBits`.

nmemoryTypeBits	back to summary
public static void nmemoryTypeBits(long struct, int value) Unsafe version of `memoryTypeBits`.

npool	back to summary
public static long npool(long struct) Unsafe version of `pool`.

npool	back to summary
public static void npool(long struct, long value) Unsafe version of `pool`.

npreferredFlags	back to summary
public static int npreferredFlags(long struct) Unsafe version of `preferredFlags`.

npreferredFlags	back to summary
public static void npreferredFlags(long struct, int value) Unsafe version of `preferredFlags`.

npriority	back to summary
public static float npriority(long struct) Unsafe version of `priority`.

npriority	back to summary
public static void npriority(long struct, float value) Unsafe version of `priority`.

npUserData	back to summary
public static long npUserData(long struct) Unsafe version of `pUserData`.

npUserData	back to summary
public static void npUserData(long struct, long value) Unsafe version of `pUserData`.

nrequiredFlags	back to summary
public static int nrequiredFlags(long struct) Unsafe version of `requiredFlags`.

nrequiredFlags	back to summary
public static void nrequiredFlags(long struct, int value) Unsafe version of `requiredFlags`.

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

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

pool back to summary

public long pool()

pool that this allocation should be created in.

Leave VK_NULL_HANDLE to allocate from default pool. If not null, members: usage, requiredFlags, preferredFlags, memoryTypeBits are ignored.

Annotations

@NativeType:VmaPool

pool	back to summary
public VmaAllocationCreateInfo pool(long value) Sets the specified value to the `pool` field.

preferredFlags back to summary

public int preferredFlags()

flags that preferably should be set in a memory type chosen for an allocation.

Set to 0 if no additional flags are preferred. If pool is not null, this member is ignored.

Annotations

@NativeType:VkMemoryPropertyFlags

preferredFlags	back to summary
public VmaAllocationCreateInfo preferredFlags(int value) Sets the specified value to the `preferredFlags` field.

priority back to summary

public float priority()

A floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations.

It is used only when ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT flag was used during creation of the VmaAllocator object and this allocation ends up as dedicated or is explicitly forced as dedicated using ALLOCATION_CREATE_DEDICATED_MEMORY_BIT. Otherwise, it has the priority of a memory block where it is placed and this variable is ignored.

priority	back to summary
public VmaAllocationCreateInfo priority(float value) Sets the specified value to the `priority` field.

pUserData back to summary

public long pUserData()

custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo::pUserData and changed using SetAllocationUserData.

If ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT is used, it must be either null or pointer to a null-terminated string. The string will be then copied to internal buffer, so it doesn't need to be valid after allocation call.

Annotations

@NativeType:void *

pUserData	back to summary
public VmaAllocationCreateInfo pUserData(long value) Sets the specified value to the `pUserData` field.

requiredFlags back to summary

public int requiredFlags()

flags that must be set in a Memory Type chosen for an allocation.

Leave 0 if you specify memory requirements in other way. If pool is not null, this member is ignored.

Annotations

@NativeType:VkMemoryPropertyFlags

requiredFlags	back to summary
public VmaAllocationCreateInfo requiredFlags(int value) Sets the specified value to the `requiredFlags` field.

set	back to summary
public VmaAllocationCreateInfo set(int flags, int usage, int requiredFlags, int preferredFlags, int memoryTypeBits, long pool, long pUserData, float priority) Initializes this struct with the specified values.

set

back to summary

public VmaAllocationCreateInfo set(VmaAllocationCreateInfo src)

Copies the specified struct data to this struct.

Parameters

src:VmaAllocationCreateInfo: the source struct

Returns:VmaAllocationCreateInfo

this struct

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

usage back to summary

public int usage()

intended usage of memory.

You can leave MEMORY_USAGE_UNKNOWN if you specify memory requirements in other way. If pool is not null, this member is ignored. One of:

`MEMORY_USAGE_UNKNOWN`	`MEMORY_USAGE_GPU_ONLY`	`MEMORY_USAGE_CPU_ONLY`
`MEMORY_USAGE_CPU_TO_GPU`	`MEMORY_USAGE_GPU_TO_CPU`	`MEMORY_USAGE_CPU_COPY`
`MEMORY_USAGE_GPU_LAZILY_ALLOCATED`	`MEMORY_USAGE_AUTO`	`MEMORY_USAGE_AUTO_PREFER_DEVICE`
`MEMORY_USAGE_AUTO_PREFER_HOST`

Annotations

@NativeType:VmaMemoryUsage

usage	back to summary
public VmaAllocationCreateInfo usage(int value) Sets the specified value to the `usage` field.

org.lwjgl.util.vma back to summary

public Class VmaAllocationCreateInfo.Buffer

Class Inheritance

extends StructBuffer<VmaAllocationCreateInfo, VmaAllocationCreateInfo.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.util.vma.VmaAllocationCreateInfo.Buffer

All Implemented Interfaces

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

An array of VmaAllocationCreateInfo structs.

Field Summary

Modifier and Type	Field and Description
private static final VmaAllocationCreateInfo	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VmaAllocationCreateInfo.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 int	Returns: the value of the `VmaAllocationCreateInfo#flags` field. flags()
public VmaAllocationCreateInfo.Buffer	flags(int value) Sets the specified value to the `VmaAllocationCreateInfo#flags` field.
protected VmaAllocationCreateInfo	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `VmaAllocationCreateInfo#memoryTypeBits` field. memoryTypeBits()
public VmaAllocationCreateInfo.Buffer	memoryTypeBits(int value) Sets the specified value to the `VmaAllocationCreateInfo#memoryTypeBits` field.
public long	Returns: the value of the `VmaAllocationCreateInfo#pool` field. pool()
public VmaAllocationCreateInfo.Buffer	pool(long value) Sets the specified value to the `VmaAllocationCreateInfo#pool` field.
public int	Returns: the value of the `VmaAllocationCreateInfo#preferredFlags` field. preferredFlags()
public VmaAllocationCreateInfo.Buffer	preferredFlags(int value) Sets the specified value to the `VmaAllocationCreateInfo#preferredFlags` field.
public float	Returns: the value of the `VmaAllocationCreateInfo#priority` field. priority()
public VmaAllocationCreateInfo.Buffer	priority(float value) Sets the specified value to the `VmaAllocationCreateInfo#priority` field.
public long	Returns: the value of the `VmaAllocationCreateInfo#pUserData` field. pUserData()
public VmaAllocationCreateInfo.Buffer	pUserData(long value) Sets the specified value to the `VmaAllocationCreateInfo#pUserData` field.
public int	Returns: the value of the `VmaAllocationCreateInfo#requiredFlags` field. requiredFlags()
public VmaAllocationCreateInfo.Buffer	requiredFlags(int value) Sets the specified value to the `VmaAllocationCreateInfo#requiredFlags` field.
protected VmaAllocationCreateInfo.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VmaAllocationCreateInfo#usage` field. usage()
public VmaAllocationCreateInfo.Buffer	usage(int value) Sets the specified value to the `VmaAllocationCreateInfo#usage` field.

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

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

flags	back to summary
public int flags() Returns:int the value of the `VmaAllocationCreateInfo#flags` field. Annotations @NativeType:VmaAllocationCreateFlags

flags	back to summary
public VmaAllocationCreateInfo.Buffer flags(int value) Sets the specified value to the `VmaAllocationCreateInfo#flags` field.

getElementFactory

back to summary

protected VmaAllocationCreateInfo getElementFactory()

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

Annotations

@Override

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

memoryTypeBits	back to summary
public VmaAllocationCreateInfo.Buffer memoryTypeBits(int value) Sets the specified value to the `VmaAllocationCreateInfo#memoryTypeBits` field.

pool	back to summary
public long pool() Returns:long the value of the `VmaAllocationCreateInfo#pool` field. Annotations @NativeType:VmaPool

pool	back to summary
public VmaAllocationCreateInfo.Buffer pool(long value) Sets the specified value to the `VmaAllocationCreateInfo#pool` field.

preferredFlags	back to summary
public int preferredFlags() Returns:int the value of the `VmaAllocationCreateInfo#preferredFlags` field. Annotations @NativeType:VkMemoryPropertyFlags

preferredFlags	back to summary
public VmaAllocationCreateInfo.Buffer preferredFlags(int value) Sets the specified value to the `VmaAllocationCreateInfo#preferredFlags` field.

priority	back to summary
public float priority() Returns:float the value of the `VmaAllocationCreateInfo#priority` field.

priority	back to summary
public VmaAllocationCreateInfo.Buffer priority(float value) Sets the specified value to the `VmaAllocationCreateInfo#priority` field.

pUserData	back to summary
public long pUserData() Returns:long the value of the `VmaAllocationCreateInfo#pUserData` field. Annotations @NativeType:void *

pUserData	back to summary
public VmaAllocationCreateInfo.Buffer pUserData(long value) Sets the specified value to the `VmaAllocationCreateInfo#pUserData` field.

requiredFlags	back to summary
public int requiredFlags() Returns:int the value of the `VmaAllocationCreateInfo#requiredFlags` field. Annotations @NativeType:VkMemoryPropertyFlags