org.lwjgl.util.vma.VmaAllocatorCreateInfo

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

public class VmaAllocatorCreateInfo extends Struct<VmaAllocatorCreateInfo> implements NativeResource

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

Nested Class Summary

Nested classes/interfaces inherited from class Struct
Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer
Pointer.Default
Field Summary

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

DEVICE

The struct member offsets.

static final int

FLAGS

The struct member offsets.

static final int

INSTANCE

The struct member offsets.

static final int

PALLOCATIONCALLBACKS

The struct member offsets.

static final int

PDEVICEMEMORYCALLBACKS

The struct member offsets.

static final int

PHEAPSIZELIMIT

The struct member offsets.

static final int

PHYSICALDEVICE

The struct member offsets.

static final int

PREFERREDLARGEHEAPBLOCKSIZE

The struct member offsets.

static final int

PTYPEEXTERNALMEMORYHANDLETYPES

The struct member offsets.

static final int

PVULKANFUNCTIONS

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

VULKANAPIVERSION

The struct member offsets.

Fields inherited from interface Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
Constructor Summary

Constructors

Constructor

Description

VmaAllocatorCreateInfo(ByteBuffer container)

Creates a VmaAllocatorCreateInfo instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

Description

static VmaAllocatorCreateInfo

calloc()

Returns a new VmaAllocatorCreateInfo instance allocated with memCalloc.

static VmaAllocatorCreateInfo

calloc(MemoryStack stack)

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

static VmaAllocatorCreateInfo

create()

Returns a new VmaAllocatorCreateInfo instance allocated with BufferUtils.

static VmaAllocatorCreateInfo

create(long address)

Returns a new VmaAllocatorCreateInfo instance for the specified memory address.

static @Nullable VmaAllocatorCreateInfo

createSafe(long address)

Like create, but returns null if address is NULL.

long

device()

VmaAllocatorCreateInfo

device(VkDevice value)

Sets the specified value to the device field.

int

flags()

VmaAllocatorCreateInfo

flags(int value)

Sets the specified value to the flags field.

long

instance()

VmaAllocatorCreateInfo

instance(VkInstance value)

Sets the specified value to the instance field.

static VmaAllocatorCreateInfo

malloc()

Returns a new VmaAllocatorCreateInfo instance allocated with memAlloc.

static VmaAllocatorCreateInfo

malloc(MemoryStack stack)

Returns a new VmaAllocatorCreateInfo instance allocated on the specified MemoryStack.

static long

ndevice(long struct)

Unsafe version of device().

static void

ndevice(long struct, VkDevice value)

Unsafe version of device.

static int

nflags(long struct)

Unsafe version of flags().

static void

nflags(long struct, int value)

Unsafe version of flags.

static long

ninstance(long struct)

Unsafe version of instance().

static void

ninstance(long struct, VkInstance value)

Unsafe version of instance.

static @Nullable VkAllocationCallbacks

npAllocationCallbacks(long struct)

Unsafe version of pAllocationCallbacks().

static void

npAllocationCallbacks(long struct, @Nullable VkAllocationCallbacks value)

Unsafe version of pAllocationCallbacks.

static @Nullable VmaDeviceMemoryCallbacks

npDeviceMemoryCallbacks(long struct)

Unsafe version of pDeviceMemoryCallbacks().

static void

npDeviceMemoryCallbacks(long struct, @Nullable VmaDeviceMemoryCallbacks value)

Unsafe version of pDeviceMemoryCallbacks.

static @Nullable LongBuffer

npHeapSizeLimit(long struct, int capacity)

Unsafe version of pHeapSizeLimit.

static void

npHeapSizeLimit(long struct, @Nullable LongBuffer value)

Unsafe version of pHeapSizeLimit.

static long

nphysicalDevice(long struct)

Unsafe version of physicalDevice().

static void

nphysicalDevice(long struct, VkPhysicalDevice value)

Unsafe version of physicalDevice.

static long

npreferredLargeHeapBlockSize(long struct)

Unsafe version of preferredLargeHeapBlockSize().

static void

npreferredLargeHeapBlockSize(long struct, long value)

Unsafe version of preferredLargeHeapBlockSize.

static @Nullable IntBuffer

npTypeExternalMemoryHandleTypes(long struct, int capacity)

Unsafe version of pTypeExternalMemoryHandleTypes.

static void

npTypeExternalMemoryHandleTypes(long struct, @Nullable IntBuffer value)

Unsafe version of pTypeExternalMemoryHandleTypes.

static VmaVulkanFunctions

npVulkanFunctions(long struct)

Unsafe version of pVulkanFunctions().

static void

npVulkanFunctions(long struct, VmaVulkanFunctions value)

Unsafe version of pVulkanFunctions.

static int

nvulkanApiVersion(long struct)

Unsafe version of vulkanApiVersion().

static void

nvulkanApiVersion(long struct, int value)

Unsafe version of vulkanApiVersion.

@Nullable VkAllocationCallbacks

pAllocationCallbacks()

VmaAllocatorCreateInfo

pAllocationCallbacks(@Nullable VkAllocationCallbacks value)

Sets the address of the specified VkAllocationCallbacks to the pAllocationCallbacks field.

@Nullable VmaDeviceMemoryCallbacks

pDeviceMemoryCallbacks()

VmaAllocatorCreateInfo

pDeviceMemoryCallbacks(@Nullable VmaDeviceMemoryCallbacks value)

Sets the address of the specified VmaDeviceMemoryCallbacks to the pDeviceMemoryCallbacks field.

@Nullable LongBuffer

pHeapSizeLimit(int capacity)

VmaAllocatorCreateInfo

pHeapSizeLimit(@Nullable LongBuffer value)

Sets the address of the specified LongBuffer to the pHeapSizeLimit field.

long

physicalDevice()

VmaAllocatorCreateInfo

physicalDevice(VkPhysicalDevice value)

Sets the specified value to the physicalDevice field.

long

preferredLargeHeapBlockSize()

VmaAllocatorCreateInfo

preferredLargeHeapBlockSize(long value)

Sets the specified value to the preferredLargeHeapBlockSize field.

@Nullable IntBuffer

pTypeExternalMemoryHandleTypes(int capacity)

VmaAllocatorCreateInfo

pTypeExternalMemoryHandleTypes(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pTypeExternalMemoryHandleTypes field.

VmaVulkanFunctions

pVulkanFunctions()

VmaAllocatorCreateInfo

pVulkanFunctions(VmaVulkanFunctions value)

Sets the address of the specified VmaVulkanFunctions to the pVulkanFunctions field.

VmaAllocatorCreateInfo

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

Initializes this struct with the specified values.

VmaAllocatorCreateInfo

set(VmaAllocatorCreateInfo src)

Copies the specified struct data to this struct.

int

sizeof()

Returns sizeof(struct).

static void

validate(long struct)

Validates pointer members that should not be NULL.

int

vulkanApiVersion()

VmaAllocatorCreateInfo

vulkanApiVersion(int value)

Sets the specified value to the vulkanApiVersion field.

Methods inherited from class Struct
clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default
address, equals, hashCode, toString

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource
close, free

Field Details
- SIZEOF
  
  public static final int SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  public static final int ALIGNOF
  
  The struct alignment in bytes.
- FLAGS
  
  public static final int FLAGS
  
  The struct member offsets.
- PHYSICALDEVICE
  
  public static final int PHYSICALDEVICE
  
  The struct member offsets.
- DEVICE
  
  public static final int DEVICE
  
  The struct member offsets.
- PREFERREDLARGEHEAPBLOCKSIZE
  
  public static final int PREFERREDLARGEHEAPBLOCKSIZE
  
  The struct member offsets.
- PALLOCATIONCALLBACKS
  
  public static final int PALLOCATIONCALLBACKS
  
  The struct member offsets.
- PDEVICEMEMORYCALLBACKS
  
  public static final int PDEVICEMEMORYCALLBACKS
  
  The struct member offsets.
- PHEAPSIZELIMIT
  
  public static final int PHEAPSIZELIMIT
  
  The struct member offsets.
- PVULKANFUNCTIONS
  
  public static final int PVULKANFUNCTIONS
  
  The struct member offsets.
- INSTANCE
  
  public static final int INSTANCE
  
  The struct member offsets.
- VULKANAPIVERSION
  
  public static final int VULKANAPIVERSION
  
  The struct member offsets.
- PTYPEEXTERNALMEMORYHANDLETYPES
  
  public static final int PTYPEEXTERNALMEMORYHANDLETYPES
  
  The struct member offsets.
Constructor Details
- VmaAllocatorCreateInfo
  
  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 Details
- sizeof
  
  public int sizeof()
  
  Description copied from class: Struct
  
  Returns sizeof(struct).
  
  Specified by:
  
  sizeof in class Struct<VmaAllocatorCreateInfo>
- flags
  
  @NativeType("VmaAllocatorCreateFlags") public int flags()
  
  Returns:
  
  the value of the flags field.
- physicalDevice
  
  @NativeType("VkPhysicalDevice") public long physicalDevice()
  
  Returns:
  
  the value of the physicalDevice field.
- device
  
  @NativeType("VkDevice") public long device()
  
  Returns:
  
  the value of the device field.
- preferredLargeHeapBlockSize
  
  @NativeType("VkDeviceSize") public long preferredLargeHeapBlockSize()
  
  Returns:
  
  the value of the preferredLargeHeapBlockSize field.
- pAllocationCallbacks
  
  @NativeType("VkAllocationCallbacks const *") public @Nullable VkAllocationCallbacks pAllocationCallbacks()
  
  Returns:
  
  a VkAllocationCallbacks view of the struct pointed to by the pAllocationCallbacks field.
- pDeviceMemoryCallbacks
  
  @NativeType("VmaDeviceMemoryCallbacks const *") public @Nullable VmaDeviceMemoryCallbacks pDeviceMemoryCallbacks()
  
  Returns:
  
  a VmaDeviceMemoryCallbacks view of the struct pointed to by the pDeviceMemoryCallbacks field.
- pHeapSizeLimit
  
  @NativeType("VkDeviceSize const *") public @Nullable LongBuffer pHeapSizeLimit(int capacity)
  
  Returns:
  
  a LongBuffer view of the data pointed to by the pHeapSizeLimit field.
- pVulkanFunctions
  
  @NativeType("VmaVulkanFunctions const *") public VmaVulkanFunctions pVulkanFunctions()
  
  Returns:
  
  a VmaVulkanFunctions view of the struct pointed to by the pVulkanFunctions field.
- instance
  
  @NativeType("VkInstance") public long instance()
  
  Returns:
  
  the value of the instance field.
- vulkanApiVersion
  
  @NativeType("uint32_t") public int vulkanApiVersion()
  
  Returns:
  
  the value of the vulkanApiVersion field.
- pTypeExternalMemoryHandleTypes
  
  @NativeType("VkExternalMemoryHandleTypeFlagsKHR const *") public @Nullable IntBuffer pTypeExternalMemoryHandleTypes(int capacity)
  
  Returns:
  
  a IntBuffer view of the data pointed to by the pTypeExternalMemoryHandleTypes field.
- flags
  
  public VmaAllocatorCreateInfo flags(@NativeType("VmaAllocatorCreateFlags") int value)
  
  Sets the specified value to the flags field.
- physicalDevice
  
  public VmaAllocatorCreateInfo physicalDevice(VkPhysicalDevice value)
  
  Sets the specified value to the physicalDevice field.
- device
  
  public VmaAllocatorCreateInfo device(VkDevice value)
  
  Sets the specified value to the device field.
- preferredLargeHeapBlockSize
  
  public VmaAllocatorCreateInfo preferredLargeHeapBlockSize(@NativeType("VkDeviceSize") long value)
  
  Sets the specified value to the preferredLargeHeapBlockSize field.
- pAllocationCallbacks
  
  public VmaAllocatorCreateInfo pAllocationCallbacks(@NativeType("VkAllocationCallbacks const *") @Nullable VkAllocationCallbacks value)
  
  Sets the address of the specified VkAllocationCallbacks to the pAllocationCallbacks field.
- pDeviceMemoryCallbacks
  
  public VmaAllocatorCreateInfo pDeviceMemoryCallbacks(@NativeType("VmaDeviceMemoryCallbacks const *") @Nullable VmaDeviceMemoryCallbacks value)
  
  Sets the address of the specified VmaDeviceMemoryCallbacks to the pDeviceMemoryCallbacks field.
- pHeapSizeLimit
  
  public VmaAllocatorCreateInfo pHeapSizeLimit(@NativeType("VkDeviceSize const *") @Nullable LongBuffer value)
  
  Sets the address of the specified LongBuffer to the pHeapSizeLimit field.
- pVulkanFunctions
  
  public VmaAllocatorCreateInfo pVulkanFunctions(@NativeType("VmaVulkanFunctions const *") VmaVulkanFunctions value)
  
  Sets the address of the specified VmaVulkanFunctions to the pVulkanFunctions field.
- instance
  
  public VmaAllocatorCreateInfo instance(VkInstance value)
  
  Sets the specified value to the instance field.
- vulkanApiVersion
  
  public VmaAllocatorCreateInfo vulkanApiVersion(@NativeType("uint32_t") int value)
  
  Sets the specified value to the vulkanApiVersion field.
- pTypeExternalMemoryHandleTypes
  
  public VmaAllocatorCreateInfo pTypeExternalMemoryHandleTypes(@NativeType("VkExternalMemoryHandleTypeFlagsKHR const *") @Nullable IntBuffer value)
  
  Sets the address of the specified IntBuffer to the pTypeExternalMemoryHandleTypes field.
- set
  
  public VmaAllocatorCreateInfo set(int flags, VkPhysicalDevice physicalDevice, VkDevice device, long preferredLargeHeapBlockSize, @Nullable VkAllocationCallbacks pAllocationCallbacks, @Nullable VmaDeviceMemoryCallbacks pDeviceMemoryCallbacks, @Nullable LongBuffer pHeapSizeLimit, VmaVulkanFunctions pVulkanFunctions, VkInstance instance, int vulkanApiVersion, @Nullable IntBuffer pTypeExternalMemoryHandleTypes)
  
  Initializes this struct with the specified values.
- set
  
  public VmaAllocatorCreateInfo set(VmaAllocatorCreateInfo src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static VmaAllocatorCreateInfo malloc()
  
  Returns a new VmaAllocatorCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static VmaAllocatorCreateInfo calloc()
  
  Returns a new VmaAllocatorCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static VmaAllocatorCreateInfo create()
  
  Returns a new VmaAllocatorCreateInfo instance allocated with BufferUtils.
- create
  
  public static VmaAllocatorCreateInfo create(long address)
  
  Returns a new VmaAllocatorCreateInfo instance for the specified memory address.
- createSafe
  
  public static @Nullable VmaAllocatorCreateInfo createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VmaAllocatorCreateInfo malloc(MemoryStack stack)
  
  Returns a new VmaAllocatorCreateInfo instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  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 - the stack from which to allocate
- nflags
  
  public static int nflags(long struct)
  
  Unsafe version of flags().
- nphysicalDevice
  
  public static long nphysicalDevice(long struct)
  
  Unsafe version of physicalDevice().
- ndevice
  
  public static long ndevice(long struct)
  
  Unsafe version of device().
- npreferredLargeHeapBlockSize
  
  public static long npreferredLargeHeapBlockSize(long struct)
  
  Unsafe version of preferredLargeHeapBlockSize().
- npAllocationCallbacks
  
  public static @Nullable VkAllocationCallbacks npAllocationCallbacks(long struct)
  
  Unsafe version of pAllocationCallbacks().
- npDeviceMemoryCallbacks
  
  public static @Nullable VmaDeviceMemoryCallbacks npDeviceMemoryCallbacks(long struct)
  
  Unsafe version of pDeviceMemoryCallbacks().
- npHeapSizeLimit
  
  public static @Nullable LongBuffer npHeapSizeLimit(long struct, int capacity)
  
  Unsafe version of pHeapSizeLimit.
- npVulkanFunctions
  
  public static VmaVulkanFunctions npVulkanFunctions(long struct)
  
  Unsafe version of pVulkanFunctions().
- ninstance
  
  public static long ninstance(long struct)
  
  Unsafe version of instance().
- nvulkanApiVersion
  
  public static int nvulkanApiVersion(long struct)
  
  Unsafe version of vulkanApiVersion().
- npTypeExternalMemoryHandleTypes
  
  public static @Nullable IntBuffer npTypeExternalMemoryHandleTypes(long struct, int capacity)
  
  Unsafe version of pTypeExternalMemoryHandleTypes.
- nflags
  
  public static void nflags(long struct, int value)
  
  Unsafe version of flags.
- nphysicalDevice
  
  public static void nphysicalDevice(long struct, VkPhysicalDevice value)
  
  Unsafe version of physicalDevice.
- ndevice
  
  public static void ndevice(long struct, VkDevice value)
  
  Unsafe version of device.
- npreferredLargeHeapBlockSize
  
  public static void npreferredLargeHeapBlockSize(long struct, long value)
  
  Unsafe version of preferredLargeHeapBlockSize.
- npAllocationCallbacks
  
  public static void npAllocationCallbacks(long struct, @Nullable VkAllocationCallbacks value)
  
  Unsafe version of pAllocationCallbacks.
- npDeviceMemoryCallbacks
  
  public static void npDeviceMemoryCallbacks(long struct, @Nullable VmaDeviceMemoryCallbacks value)
  
  Unsafe version of pDeviceMemoryCallbacks.
- npHeapSizeLimit
  
  public static void npHeapSizeLimit(long struct, @Nullable LongBuffer value)
  
  Unsafe version of pHeapSizeLimit.
- npVulkanFunctions
  
  public static void npVulkanFunctions(long struct, VmaVulkanFunctions value)
  
  Unsafe version of pVulkanFunctions.
- ninstance
  
  public static void ninstance(long struct, VkInstance value)
  
  Unsafe version of instance.
- nvulkanApiVersion
  
  public static void nvulkanApiVersion(long struct, int value)
  
  Unsafe version of vulkanApiVersion.
- npTypeExternalMemoryHandleTypes
  
  public static void npTypeExternalMemoryHandleTypes(long struct, @Nullable IntBuffer value)
  
  Unsafe version of pTypeExternalMemoryHandleTypes.
- validate
  
  public static void validate(long struct)
  
  Validates pointer members that should not be NULL.
  
  Parameters:
  
  struct - the struct to validate

Class VmaAllocatorCreateInfo

Nested Class Summary

Nested classes/interfaces inherited from class Struct

Nested classes/interfaces inherited from interface Pointer

Field Summary

Fields inherited from interface Pointer

Constructor Summary

Method Summary

Methods inherited from class Struct

Methods inherited from class Pointer.Default

Methods inherited from class Object

Methods inherited from interface NativeResource

Field Details

SIZEOF

ALIGNOF

FLAGS

PHYSICALDEVICE

DEVICE

PREFERREDLARGEHEAPBLOCKSIZE

PALLOCATIONCALLBACKS

PDEVICEMEMORYCALLBACKS

PHEAPSIZELIMIT

PVULKANFUNCTIONS

INSTANCE

VULKANAPIVERSION

PTYPEEXTERNALMEMORYHANDLETYPES

Constructor Details

VmaAllocatorCreateInfo

Method Details

sizeof

flags

physicalDevice

device

preferredLargeHeapBlockSize

pAllocationCallbacks

pDeviceMemoryCallbacks

pHeapSizeLimit

pVulkanFunctions

instance

vulkanApiVersion

pTypeExternalMemoryHandleTypes

flags

physicalDevice

device

preferredLargeHeapBlockSize

pAllocationCallbacks

pDeviceMemoryCallbacks

pHeapSizeLimit

pVulkanFunctions

instance

vulkanApiVersion

pTypeExternalMemoryHandleTypes

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

nflags

nphysicalDevice

ndevice

npreferredLargeHeapBlockSize

npAllocationCallbacks

npDeviceMemoryCallbacks

npHeapSizeLimit

npVulkanFunctions

ninstance

nvulkanApiVersion

npTypeExternalMemoryHandleTypes

nflags

nphysicalDevice

ndevice

npreferredLargeHeapBlockSize

npAllocationCallbacks

npDeviceMemoryCallbacks

npHeapSizeLimit

npVulkanFunctions