Record Class VmaAllocatorCreateInfo

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

Description of a Allocator to be created.

Structure

typedef struct VmaAllocatorCreateInfo {
    VmaAllocatorCreateFlags flags;
    VkPhysicalDevice physicalDevice;
    VkDevice device;
    VkDeviceSize preferredLargeHeapBlockSize;
    VkAllocationCallbacks const* pAllocationCallbacks; // optional
    VmaDeviceMemoryCallbacks const* pDeviceMemoryCallbacks; // optional
    VkDeviceSize const* pHeapSizeLimit; // optional
    VmaVulkanFunctions const* pVulkanFunctions; // optional
    VkInstance instance;
    uint32_t vulkanApiVersion;
    


invalid reference

VkExternalMemoryHandleTypeFlags



KHR const* pTypeExternalMemoryHandleTypes; // optional
    void*[8] reserved;
} VmaAllocatorCreateInfo;

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() Flags for created allocator. Use VmaAllocatorCreateFlagBits enum.
  • physicalDevice() It must be valid throughout whole lifetime of created allocator.
  • device() It must be valid throughout whole lifetime of created allocator.
  • preferredLargeHeapBlockSize() Set to 0 to use default, which is currently 256 MiB.
  • pAllocationCallbacks(club.doki7.vulkan.datatype.IVkAllocationCallbacks) Optional, can be null. When specified, will also be used for all CPU-side memory allocations.
  • pDeviceMemoryCallbacks(club.doki7.vma.datatype.IVmaDeviceMemoryCallbacks) Optional, can be null.
  • pHeapSizeLimit() Either null or a pointer to an array of limits on maximum number of bytes that can be allocated out of particular Vulkan memory heap.

    If not NULL, it must be a pointer to an array of VkPhysicalDeviceMemoryProperties::memoryHeapCount elements, defining limit on maximum number of bytes that can be allocated out of particular Vulkan memory heap.

    Any of the elements may be equal to VK_WHOLE_SIZE, which means no limit on that heap. This is also the default in case of pHeapSizeLimit = NULL.

    If there is a limit defined for a heap:

    • If user tries to allocate more memory from that heap using this allocator, the allocation fails with VK_ERROR_OUT_OF_DEVICE_MEMORY.
    • If the limit is smaller than heap size reported in VkMemoryHeap::size, the value of this limit will be reported instead when using vmaGetMemoryProperties().

    Warning! Using this feature may not be equivalent to installing a GPU with smaller amount of memory, because graphics driver doesn't necessary fail new allocations with VK_ERROR_OUT_OF_DEVICE_MEMORY result when memory capacity is exceeded. It may return success and just silently migrate some device memory blocks to system RAM. This driver behavior can also be controlled using VK_AMD_memory_overallocation_behavior extension.

  • pVulkanFunctions(club.doki7.vma.datatype.IVmaVulkanFunctions) Pointers to Vulkan functions. Can be null.

    For details see [Pointers to Vulkan functions](@ref config_Vulkan_functions).

  • instance() Handle to Vulkan instance object.

    Starting from version 3.0.0 this member is no longer optional, it must be set!

  • vulkanApiVersion() Optional. Vulkan version that the application uses.

    It must be a value in the format as created by macro VK_MAKE_VERSION or a constant like: VK_API_VERSION_1_1, VK_API_VERSION_1_0. The patch version number specified is ignored. Only the major and minor versions are considered. Only versions 1.0...1.4 are supported by the current implementation. Leaving it initialized to zero is equivalent to VK_API_VERSION_1_0. It must match the Vulkan version used by the application and supported on the selected physical device, so it must be no higher than VkApplicationInfo::apiVersion passed to vkCreateInstance and no higher than VkPhysicalDeviceProperties::apiVersion found on the physical device used.

  • pTypeExternalMemoryHandleTypes() Either null or a pointer to an array of external memory handle types for each Vulkan memory type.

    If not NULL, it must be a pointer to an array of VkPhysicalDeviceMemoryProperties::memoryTypeCount elements, defining external memory handle types of particular Vulkan memory type, to be passed using VkExportMemoryAllocateInfoKHR.

    Any of the elements may be equal to 0, which means not to use VkExportMemoryAllocateInfoKHR on this memory type. This is also the default in case of pTypeExternalMemoryHandleTypes = NULL.