Record Class VmaAllocationCreateInfo

java.lang.Object
java.lang.Record
club.doki7.vma.datatype.VmaAllocationCreateInfo
All Implemented Interfaces:
IPointer, IVmaAllocationCreateInfo
@ValueBasedCandidate @UnsafeConstructor public record VmaAllocationCreateInfo(@NotNull MemorySegment segment) extends Record implements IVmaAllocationCreateInfo

Parameters of new VmaAllocation.

To be used with functions like vmaCreateBuffer(), vmaCreateImage(), and many others.

Structure

typedef struct VmaAllocationCreateInfo {
    VmaAllocationCreateFlags flags;
    VmaMemoryUsage usage;
    VkMemoryPropertyFlags requiredFlags;
    VkMemoryPropertyFlags preferredFlags;
    uint32_t memoryTypeBits;
    VmaPool pool; // optional
    void* pUserData; // optional
    float priority;
} VmaAllocationCreateInfo;

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

Member documentation

  • flags() Use VmaAllocationCreateFlagBits enum.
  • usage() Intended usage of memory.

    You can leave VMA_MEMORY_USAGE_UNKNOWN if you specify memory requirements in other way.

    If pool is not null, this member is ignored.

  • 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.

  • 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.

  • 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.

  • 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.

  • pUserData() Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo::pUserData and changed using vmaSetAllocationUserData().

    If VMA_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.

  • 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 VMA_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 VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT. Otherwise, it has the priority of a memory block where it is placed and this variable is ignored.