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

public Class VmaPoolCreateInfo

extends Struct<VmaPoolCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*, org.lwjgl.vulkan.*
Describes parameter of created VmaPool.

Layout


struct VmaPoolCreateInfo {
    uint32_t memoryTypeIndex;
    VmaPoolCreateFlags flags;
    VkDeviceSize blockSize;
    size_t minBlockCount;
    size_t maxBlockCount;
    float priority;
    VkDeviceSize minAllocationAlignment;
    void * pMemoryAllocateNext;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VmaPoolCreateInfo.Buffer

An array of VmaPoolCreateInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BLOCKSIZE

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
MAXBLOCKCOUNT

The struct member offsets.

public static final int
MEMORYTYPEINDEX

The struct member offsets.

public static final int
MINALLOCATIONALIGNMENT

The struct member offsets.

public static final int
MINBLOCKCOUNT

The struct member offsets.

public static final int
PMEMORYALLOCATENEXT

The struct member offsets.

public static final int
PRIORITY

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VmaPoolCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
blockSize()

size of a single VkDeviceMemory block to be allocated as part of this pool, in bytes.

public VmaPoolCreateInfo
blockSize(long value)

Sets the specified value to the blockSize field.

public static VmaPoolCreateInfo
calloc()

Returns a new VmaPoolCreateInfo instance allocated with memCalloc.

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

Returns a new VmaPoolCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VmaPoolCreateInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VmaPoolCreateInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaPoolCreateInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaPoolCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VmaPoolCreateInfo
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 VmaPoolCreateInfo
create()

Returns a new VmaPoolCreateInfo instance allocated with BufferUtils.

public static VmaPoolCreateInfo
create(long address)

Returns a new VmaPoolCreateInfo instance for the specified memory address.

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

Returns a new VmaPoolCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VmaPoolCreateInfo.Buffer instance at the specified memory.

public static VmaPoolCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

Use combination of VmaPoolCreateFlagBits.

public VmaPoolCreateInfo
flags(int value)

Sets the specified value to the flags field.

public static VmaPoolCreateInfo
malloc()

Returns a new VmaPoolCreateInfo instance allocated with memAlloc.

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

Returns a new VmaPoolCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VmaPoolCreateInfo instance allocated on the specified MemoryStack.

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

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

public static VmaPoolCreateInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VmaPoolCreateInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaPoolCreateInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VmaPoolCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public long
maxBlockCount()

maximum number of blocks that can be allocated in this pool.

public VmaPoolCreateInfo
maxBlockCount(long value)

Sets the specified value to the maxBlockCount field.

public int
memoryTypeIndex()

Vulkan memory type index to allocate this pool from

public VmaPoolCreateInfo
memoryTypeIndex(int value)

Sets the specified value to the memoryTypeIndex field.

public long
minAllocationAlignment()

Additional minimum alignment to be used for all allocations created from this pool.

public VmaPoolCreateInfo
minAllocationAlignment(long value)

Sets the specified value to the minAllocationAlignment field.

public long
minBlockCount()

minimum number of blocks to be always allocated in this pool, even if they stay empty.

public VmaPoolCreateInfo
minBlockCount(long value)

Sets the specified value to the minBlockCount field.

public static long
nblockSize(long struct)

Unsafe version of blockSize.

public static void
nblockSize(long struct, long value)

Unsafe version of blockSize.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
nmaxBlockCount(long struct)

Unsafe version of maxBlockCount.

public static void
nmaxBlockCount(long struct, long value)

Unsafe version of maxBlockCount.

public static int
nmemoryTypeIndex(long struct)

Unsafe version of memoryTypeIndex.

public static void
nmemoryTypeIndex(long struct, int value)

Unsafe version of memoryTypeIndex.

public static long
nminAllocationAlignment(long struct)

Unsafe version of minAllocationAlignment.

public static void
nminAllocationAlignment(long struct, long value)

Unsafe version of minAllocationAlignment.

public static long
nminBlockCount(long struct)

Unsafe version of minBlockCount.

public static void
nminBlockCount(long struct, long value)

Unsafe version of minBlockCount.

public static long
npMemoryAllocateNext(long struct)

Unsafe version of pMemoryAllocateNext.

public static void
npMemoryAllocateNext(long struct, long value)

Unsafe version of pMemoryAllocateNext.

public static float
npriority(long struct)

Unsafe version of priority.

public static void
npriority(long struct, float value)

Unsafe version of priority.

public long
pMemoryAllocateNext()

Additional pNext chain to be attached to VkMemoryAllocateInfo used for every allocation made by this pool.

public VmaPoolCreateInfo
pMemoryAllocateNext(long value)

Sets the specified value to the pMemoryAllocateNext field.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkDedicatedAllocationMemoryAllocateInfoNV value)

Prepends the specified VkDedicatedAllocationMemoryAllocateInfoNV value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkExportMemoryAllocateInfo value)

Prepends the specified VkExportMemoryAllocateInfo value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkExportMemoryAllocateInfoKHR value)

Prepends the specified VkExportMemoryAllocateInfoKHR value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkExportMemoryAllocateInfoNV value)

Prepends the specified VkExportMemoryAllocateInfoNV value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkExportMemoryWin32HandleInfoKHR value)

Prepends the specified VkExportMemoryWin32HandleInfoKHR value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkExportMemoryWin32HandleInfoNV value)

Prepends the specified VkExportMemoryWin32HandleInfoNV value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkExportMetalObjectCreateInfoEXT value)

Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkImportAndroidHardwareBufferInfoANDROID value)

Prepends the specified VkImportAndroidHardwareBufferInfoANDROID value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkImportMemoryFdInfoKHR value)

Prepends the specified VkImportMemoryFdInfoKHR value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkImportMemoryHostPointerInfoEXT value)

Prepends the specified VkImportMemoryHostPointerInfoEXT value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkImportMemoryWin32HandleInfoKHR value)

Prepends the specified VkImportMemoryWin32HandleInfoKHR value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkImportMemoryWin32HandleInfoNV value)

Prepends the specified VkImportMemoryWin32HandleInfoNV value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkImportMetalBufferInfoEXT value)

Prepends the specified VkImportMetalBufferInfoEXT value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkMemoryAllocateFlagsInfo value)

Prepends the specified VkMemoryAllocateFlagsInfo value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkMemoryAllocateFlagsInfoKHR value)

Prepends the specified VkMemoryAllocateFlagsInfoKHR value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkMemoryDedicatedAllocateInfo value)

Prepends the specified VkMemoryDedicatedAllocateInfo value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkMemoryDedicatedAllocateInfoKHR value)

Prepends the specified VkMemoryDedicatedAllocateInfoKHR value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkMemoryOpaqueCaptureAddressAllocateInfo value)

Prepends the specified VkMemoryOpaqueCaptureAddressAllocateInfo value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkMemoryOpaqueCaptureAddressAllocateInfoKHR value)

Prepends the specified VkMemoryOpaqueCaptureAddressAllocateInfoKHR value to the pMemoryAllocateNext chain.

public VmaPoolCreateInfo
pMemoryAllocateNext(VkMemoryPriorityAllocateInfoEXT value)

Prepends the specified VkMemoryPriorityAllocateInfoEXT value to the pMemoryAllocateNext chain.

public float
priority()

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

public VmaPoolCreateInfo
priority(float value)

Sets the specified value to the priority field.

public VmaPoolCreateInfo
set(int memoryTypeIndex, int flags, long blockSize, long minBlockCount, long maxBlockCount, float priority, long minAllocationAlignment, long pMemoryAllocateNext)

Initializes this struct with the specified values.

public VmaPoolCreateInfo

Returns:

this struct
set(VmaPoolCreateInfo
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).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate