LWJGL 3.3.3 · org.lwjgl.util.vma.VmaAllocatorCreateInfo

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	DEVICE The struct member offsets.
public static final int	FLAGS The struct member offsets.
public static final int	INSTANCE The struct member offsets.
public static final int	PALLOCATIONCALLBACKS The struct member offsets.
public static final int	PDEVICEMEMORYCALLBACKS The struct member offsets.
public static final int	PHEAPSIZELIMIT The struct member offsets.
public static final int	PHYSICALDEVICE The struct member offsets.
public static final int	PREFERREDLARGEHEAPBLOCKSIZE The struct member offsets.
public static final int	PTYPEEXTERNALMEMORYHANDLETYPES The struct member offsets.
public static final int	PVULKANFUNCTIONS The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	VULKANAPIVERSION The struct member offsets.

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

Method Summary

Modifier and Type	Method and Description
public static VmaAllocatorCreateInfo	calloc() Returns a new `VmaAllocatorCreateInfo` instance allocated with `memCalloc`.
public static VmaAllocatorCreateInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VmaAllocatorCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VmaAllocatorCreateInfo	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VmaAllocatorCreateInfo	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VmaAllocatorCreateInfo	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 VmaAllocatorCreateInfo	create() Returns a new `VmaAllocatorCreateInfo` instance allocated with `BufferUtils`.
public static VmaAllocatorCreateInfo	create(long address) Returns a new `VmaAllocatorCreateInfo` instance for the specified memory address.
public static VmaAllocatorCreateInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public long	device() Vulkan device.
public VmaAllocatorCreateInfo	device(VkDevice value) Sets the specified value to the `device` field.
public int	flags() flags for created allocator.
public VmaAllocatorCreateInfo	flags(int value) Sets the specified value to the `flags` field.
public long	instance() handle to Vulkan instance object.
public VmaAllocatorCreateInfo	instance(VkInstance value) Sets the specified value to the `instance` field.
public static VmaAllocatorCreateInfo	malloc() Returns a new `VmaAllocatorCreateInfo` instance allocated with `memAlloc`.
public static VmaAllocatorCreateInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VmaAllocatorCreateInfo` instance allocated on the specified `MemoryStack`.
public static VmaAllocatorCreateInfo	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VmaAllocatorCreateInfo	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static long	ndevice(long struct) Unsafe version of `device`.
public static void	ndevice(long struct, VkDevice value) Unsafe version of `device`.
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	ninstance(long struct) Unsafe version of `instance`.
public static void	ninstance(long struct, VkInstance value) Unsafe version of `instance`.
public static VkAllocationCallbacks	npAllocationCallbacks(long struct) Unsafe version of `pAllocationCallbacks`.
public static void	npAllocationCallbacks(long struct, VkAllocationCallbacks value) Unsafe version of `pAllocationCallbacks`.
public static VmaDeviceMemoryCallbacks	npDeviceMemoryCallbacks(long struct) Unsafe version of `pDeviceMemoryCallbacks`.
public static void	npDeviceMemoryCallbacks(long struct, VmaDeviceMemoryCallbacks value) Unsafe version of `pDeviceMemoryCallbacks`.
public static LongBuffer	npHeapSizeLimit(long struct, int capacity) Unsafe version of `pHeapSizeLimit`.
public static void	npHeapSizeLimit(long struct, LongBuffer value) Unsafe version of `pHeapSizeLimit`.
public static long	nphysicalDevice(long struct) Unsafe version of `physicalDevice`.
public static void	nphysicalDevice(long struct, VkPhysicalDevice value) Unsafe version of `physicalDevice`.
public static long	npreferredLargeHeapBlockSize(long struct) Unsafe version of `preferredLargeHeapBlockSize`.
public static void	npreferredLargeHeapBlockSize(long struct, long value) Unsafe version of `preferredLargeHeapBlockSize`.
public static IntBuffer	npTypeExternalMemoryHandleTypes(long struct, int capacity) Unsafe version of `pTypeExternalMemoryHandleTypes`.
public static void	npTypeExternalMemoryHandleTypes(long struct, IntBuffer value) Unsafe version of `pTypeExternalMemoryHandleTypes`.
public static VmaVulkanFunctions	npVulkanFunctions(long struct) Unsafe version of `pVulkanFunctions`.
public static void	npVulkanFunctions(long struct, VmaVulkanFunctions value) Unsafe version of `pVulkanFunctions`.
public static int	nvulkanApiVersion(long struct) Unsafe version of `vulkanApiVersion`.
public static void	nvulkanApiVersion(long struct, int value) Unsafe version of `vulkanApiVersion`.
public VkAllocationCallbacks	pAllocationCallbacks() custom CPU memory allocation callbacks.
public VmaAllocatorCreateInfo	pAllocationCallbacks(VkAllocationCallbacks value) Sets the address of the specified `VkAllocationCallbacks` to the `pAllocationCallbacks` field.
public VmaDeviceMemoryCallbacks	pDeviceMemoryCallbacks() informative callbacks for `vkAllocateMemory`, `vkFreeMemory`.
public VmaAllocatorCreateInfo	pDeviceMemoryCallbacks(VmaDeviceMemoryCallbacks value) Sets the address of the specified `VmaDeviceMemoryCallbacks` to the `pDeviceMemoryCallbacks` field.
public LongBuffer	Returns: 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 `GetMemoryProperties`. 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. pHeapSizeLimit(int the number of elements in the returned buffer capacity)
public VmaAllocatorCreateInfo	pHeapSizeLimit(LongBuffer value) Sets the address of the specified `LongBuffer` to the `pHeapSizeLimit` field.
public long	physicalDevice() Vulkan physical device.
public VmaAllocatorCreateInfo	physicalDevice(VkPhysicalDevice value) Sets the specified value to the `physicalDevice` field.
public long	preferredLargeHeapBlockSize() preferred size of a single `VkDeviceMemory` block to be allocated from large heaps > 1 GiB.
public VmaAllocatorCreateInfo	preferredLargeHeapBlockSize(long value) Sets the specified value to the `preferredLargeHeapBlockSize` field.
public IntBuffer	Returns: 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`. pTypeExternalMemoryHandleTypes(int the number of elements in the returned buffer capacity)
public VmaAllocatorCreateInfo	pTypeExternalMemoryHandleTypes(IntBuffer value) Sets the address of the specified `IntBuffer` to the `pTypeExternalMemoryHandleTypes` field.
public VmaVulkanFunctions	pVulkanFunctions() pointers to Vulkan functions
public VmaAllocatorCreateInfo	pVulkanFunctions(VmaVulkanFunctions value) Sets the address of the specified `VmaVulkanFunctions` to the `pVulkanFunctions` field.
public VmaAllocatorCreateInfo	set(int flags, VkPhysicalDevice physicalDevice, VkDevice device, long preferredLargeHeapBlockSize, VkAllocationCallbacks pAllocationCallbacks, VmaDeviceMemoryCallbacks pDeviceMemoryCallbacks, LongBuffer pHeapSizeLimit, VmaVulkanFunctions pVulkanFunctions, VkInstance instance, int vulkanApiVersion, IntBuffer pTypeExternalMemoryHandleTypes) Initializes this struct with the specified values.
public VmaAllocatorCreateInfo	Returns: this struct set(VmaAllocatorCreateInfo 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 static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.
public int	vulkanApiVersion() the highest version of Vulkan that the application is designed to use.
public VmaAllocatorCreateInfo	vulkanApiVersion(int value) Sets the specified value to the `vulkanApiVersion` field.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

VmaAllocatorCreateInfo	back to summary
public VmaAllocatorCreateInfo(ByteBuffer container) Creates a `VmaAllocatorCreateInfo` 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 VmaAllocatorCreateInfo calloc() Returns a new `VmaAllocatorCreateInfo` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VmaAllocatorCreateInfo calloc(MemoryStack stack) Returns a new `VmaAllocatorCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VmaAllocatorCreateInfo calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

callocStack back to summary

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

public static VmaAllocatorCreateInfo 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 VmaAllocatorCreateInfo callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VmaAllocatorCreateInfo callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

create back to summary

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

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

createSafe back to summary

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

public static VmaAllocatorCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

device	back to summary
public long device() Vulkan device. It must be valid throughout whole lifetime of created allocator. Annotations @NativeType:VkDevice

device

back to summary

public long device()

Vulkan device. It must be valid throughout whole lifetime of created allocator.

Annotations

@NativeType:VkDevice

device	back to summary
public VmaAllocatorCreateInfo device(VkDevice value) Sets the specified value to the `device` field.

flags back to summary

public int flags()

flags for created allocator. Use VmaAllocatorCreateFlagBits enum. One of:

ALLOCATOR_CREATE_EXTERNALLY_SYNCHRONIZED_BIT

ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT

ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT

ALLOCATOR_CREATE_EXT_MEMORY_BUDGET_BIT

ALLOCATOR_CREATE_AMD_DEVICE_COHERENT_MEMORY_BIT

ALLOCATOR_CREATE_BUFFER_DEVICE_ADDRESS_BIT

ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT

Annotations

@NativeType:VmaAllocatorCreateFlags

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

instance	back to summary
public long instance() handle to Vulkan instance object. Annotations @NativeType:VkInstance

instance

back to summary

public long instance()

handle to Vulkan instance object.

Annotations

@NativeType:VkInstance

instance	back to summary
public VmaAllocatorCreateInfo instance(VkInstance value) Sets the specified value to the `instance` field.

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

malloc back to summary

malloc	back to summary
public static VmaAllocatorCreateInfo malloc(MemoryStack stack) Returns a new `VmaAllocatorCreateInfo` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VmaAllocatorCreateInfo malloc(MemoryStack stack)

Returns a new VmaAllocatorCreateInfo instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

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

public static VmaAllocatorCreateInfo 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 VmaAllocatorCreateInfo mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VmaAllocatorCreateInfo mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

ndevice	back to summary
public static long ndevice(long struct) Unsafe version of `device`.

ndevice	back to summary
public static void ndevice(long struct, VkDevice value) Unsafe version of `device`.

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

ninstance	back to summary
public static long ninstance(long struct) Unsafe version of `instance`.

ninstance	back to summary
public static void ninstance(long struct, VkInstance value) Unsafe version of `instance`.

npAllocationCallbacks back to summary

npAllocationCallbacks	back to summary
public static VkAllocationCallbacks npAllocationCallbacks(long struct) Unsafe version of `pAllocationCallbacks`. Annotations @Nullable

public static VkAllocationCallbacks npAllocationCallbacks(long struct)

Unsafe version of pAllocationCallbacks.

Annotations

@Nullable

npAllocationCallbacks	back to summary
public static void npAllocationCallbacks(long struct, VkAllocationCallbacks value) Unsafe version of `pAllocationCallbacks`.

npDeviceMemoryCallbacks back to summary

npDeviceMemoryCallbacks	back to summary
public static VmaDeviceMemoryCallbacks npDeviceMemoryCallbacks(long struct) Unsafe version of `pDeviceMemoryCallbacks`. Annotations @Nullable

public static VmaDeviceMemoryCallbacks npDeviceMemoryCallbacks(long struct)

Unsafe version of pDeviceMemoryCallbacks.

Annotations

@Nullable

npDeviceMemoryCallbacks	back to summary
public static void npDeviceMemoryCallbacks(long struct, VmaDeviceMemoryCallbacks value) Unsafe version of `pDeviceMemoryCallbacks`.

npHeapSizeLimit back to summary

npHeapSizeLimit	back to summary
public static LongBuffer npHeapSizeLimit(long struct, int capacity) Unsafe version of `pHeapSizeLimit`. Annotations @Nullable

public static LongBuffer npHeapSizeLimit(long struct, int capacity)

Unsafe version of pHeapSizeLimit.

Annotations

@Nullable

npHeapSizeLimit	back to summary
public static void npHeapSizeLimit(long struct, LongBuffer value) Unsafe version of `pHeapSizeLimit`.

nphysicalDevice	back to summary
public static long nphysicalDevice(long struct) Unsafe version of `physicalDevice`.

nphysicalDevice	back to summary
public static void nphysicalDevice(long struct, VkPhysicalDevice value) Unsafe version of `physicalDevice`.

npreferredLargeHeapBlockSize	back to summary
public static long npreferredLargeHeapBlockSize(long struct) Unsafe version of `preferredLargeHeapBlockSize`.

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

npTypeExternalMemoryHandleTypes back to summary

public static IntBuffer npTypeExternalMemoryHandleTypes(long struct, int capacity)

Unsafe version of pTypeExternalMemoryHandleTypes.

Annotations

@Nullable

npTypeExternalMemoryHandleTypes	back to summary
public static void npTypeExternalMemoryHandleTypes(long struct, IntBuffer value) Unsafe version of `pTypeExternalMemoryHandleTypes`.

npVulkanFunctions	back to summary
public static VmaVulkanFunctions npVulkanFunctions(long struct) Unsafe version of `pVulkanFunctions`.

npVulkanFunctions	back to summary
public static void npVulkanFunctions(long struct, VmaVulkanFunctions value) Unsafe version of `pVulkanFunctions`.

nvulkanApiVersion	back to summary
public static int nvulkanApiVersion(long struct) Unsafe version of `vulkanApiVersion`.

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

pAllocationCallbacks

back to summary

public VkAllocationCallbacks pAllocationCallbacks()

custom CPU memory allocation callbacks. Optional, can be null. When specified, will also be used for all CPU-side memory allocations. Optional.

Annotations

@Nullable
@NativeType:VkAllocationCallbacks const *

pAllocationCallbacks	back to summary
public VmaAllocatorCreateInfo pAllocationCallbacks(VkAllocationCallbacks value) Sets the address of the specified `VkAllocationCallbacks` to the `pAllocationCallbacks` field.

pDeviceMemoryCallbacks back to summary

public VmaDeviceMemoryCallbacks pDeviceMemoryCallbacks()

informative callbacks for vkAllocateMemory, vkFreeMemory. Optional.

Annotations

@Nullable
@NativeType:VmaDeviceMemoryCallbacks const *

pDeviceMemoryCallbacks	back to summary
public VmaAllocatorCreateInfo pDeviceMemoryCallbacks(VmaDeviceMemoryCallbacks value) Sets the address of the specified `VmaDeviceMemoryCallbacks` to the `pDeviceMemoryCallbacks` field.

pHeapSizeLimit back to summary

public LongBuffer pHeapSizeLimit(int capacity)

Parameters

capacity:int: the number of elements in the returned buffer

Returns:LongBuffer

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

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.

Annotations

@Nullable
@NativeType:VkDeviceSize const *

pHeapSizeLimit	back to summary
public VmaAllocatorCreateInfo pHeapSizeLimit(LongBuffer value) Sets the address of the specified `LongBuffer` to the `pHeapSizeLimit` field.

physicalDevice

back to summary

public long physicalDevice()

Vulkan physical device. It must be valid throughout whole lifetime of created allocator.

Annotations

@NativeType:VkPhysicalDevice

physicalDevice	back to summary
public VmaAllocatorCreateInfo physicalDevice(VkPhysicalDevice value) Sets the specified value to the `physicalDevice` field.

preferredLargeHeapBlockSize back to summary

public long preferredLargeHeapBlockSize()

preferred size of a single VkDeviceMemory block to be allocated from large heaps > 1 GiB. Set to 0 to use default, which is currently 256 MiB. Optional.

Annotations

@NativeType:VkDeviceSize

preferredLargeHeapBlockSize	back to summary
public VmaAllocatorCreateInfo preferredLargeHeapBlockSize(long value) Sets the specified value to the `preferredLargeHeapBlockSize` field.

pTypeExternalMemoryHandleTypes back to summary

public IntBuffer pTypeExternalMemoryHandleTypes(int capacity)

Parameters

capacity:int: the number of elements in the returned buffer

Returns:IntBuffer

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.

Annotations

@Nullable
@NativeType:VkExternalMemoryHandleTypeFlagsKHR const *

pTypeExternalMemoryHandleTypes	back to summary
public VmaAllocatorCreateInfo pTypeExternalMemoryHandleTypes(IntBuffer value) Sets the address of the specified `IntBuffer` to the `pTypeExternalMemoryHandleTypes` field.

pVulkanFunctions

back to summary

public VmaVulkanFunctions pVulkanFunctions()

pointers to Vulkan functions

Annotations

@NativeType:VmaVulkanFunctions const *

pVulkanFunctions	back to summary
public VmaAllocatorCreateInfo pVulkanFunctions(VmaVulkanFunctions value) Sets the address of the specified `VmaVulkanFunctions` to the `pVulkanFunctions` field.

set

back to summary

public VmaAllocatorCreateInfo set(int flags, VkPhysicalDevice physicalDevice, VkDevice device, long preferredLargeHeapBlockSize, VkAllocationCallbacks pAllocationCallbacks, VmaDeviceMemoryCallbacks pDeviceMemoryCallbacks, LongBuffer pHeapSizeLimit, VmaVulkanFunctions pVulkanFunctions, VkInstance instance, int vulkanApiVersion, IntBuffer pTypeExternalMemoryHandleTypes)

Initializes this struct with the specified values.

set

back to summary

public VmaAllocatorCreateInfo set(VmaAllocatorCreateInfo src)

Copies the specified struct data to this struct.

Parameters

src:VmaAllocatorCreateInfo: the source struct

Returns:VmaAllocatorCreateInfo

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

validate back to summary

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

vulkanApiVersion back to summary

public int vulkanApiVersion()

the highest version of Vulkan that the application is designed to use. (optional)

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. It must be less or equal (preferably equal) to value as passed to vkCreateInstance as VkApplicationInfo::apiVersion. Only versions 1.0, 1.1, 1.2 and 1.3 are supported by the current implementation.

Leaving it initialized to zero is equivalent to VK_API_VERSION_1_0.

Annotations

@NativeType:uint32_t

vulkanApiVersion	back to summary
public VmaAllocatorCreateInfo vulkanApiVersion(int value) Sets the specified value to the `vulkanApiVersion` field.

public Class VmaAllocatorCreateInfo

Layout

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail