VmaAllocationCreateInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.vma.VmaAllocationCreateInfo

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VmaAllocationCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Member documentation

flags – use VmaAllocationCreateFlagBits enum. One or more of:

`ALLOCATION_CREATE_DEDICATED_MEMORY_BIT`	`ALLOCATION_CREATE_NEVER_ALLOCATE_BIT`
`ALLOCATION_CREATE_MAPPED_BIT`	`ALLOCATION_CREATE_CAN_BECOME_LOST_BIT`
`ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT`	`ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT`
`ALLOCATION_CREATE_UPPER_ADDRESS_BIT`	`ALLOCATION_CREATE_DONT_BIND_BIT`
`ALLOCATION_CREATE_WITHIN_BUDGET_BIT`	`ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT`
`ALLOCATION_CREATE_STRATEGY_WORST_FIT_BIT`	`ALLOCATION_CREATE_STRATEGY_FIRST_FIT_BIT`
`ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT`	`ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT`
`ALLOCATION_CREATE_STRATEGY_MIN_FRAGMENTATION_BIT`	`ALLOCATION_CREATE_STRATEGY_MASK`

usage – intended usage of memory.
You can leave MEMORY_USAGE_UNKNOWN if you specify memory requirements in other way. If pool is not null, this member is ignored. One of:
MEMORY_USAGE_UNKNOWN MEMORY_USAGE_GPU_ONLY MEMORY_USAGE_CPU_ONLY
MEMORY_USAGE_CPU_TO_GPU MEMORY_USAGE_GPU_TO_CPU MEMORY_USAGE_CPU_COPY
MEMORY_USAGE_GPU_LAZILY_ALLOCATED
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 prefered. 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 SetAllocationUserData.
If 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.

Layout


 struct VmaAllocationCreateInfo {
     VmaAllocationCreateFlags flags;
     VmaMemoryUsage usage;
     VkMemoryPropertyFlags requiredFlags;
     VkMemoryPropertyFlags preferredFlags;
     uint32_t memoryTypeBits;
     VmaPool pool;
     void * pUserData;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VmaAllocationCreateInfo.Buffer
An array of VmaAllocationCreateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VmaAllocationCreateInfo.Buffer` An array of `VmaAllocationCreateInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FLAGS` The struct member offsets.
`static int`	`MEMORYTYPEBITS` The struct member offsets.
`static int`	`POOL` The struct member offsets.
`static int`	`PREFERREDFLAGS` The struct member offsets.
`static int`	`PUSERDATA` The struct member offsets.
`static int`	`REQUIREDFLAGS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`USAGE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VmaAllocationCreateInfo(java.nio.ByteBuffer container)` Creates a `VmaAllocationCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VmaAllocationCreateInfo`	`calloc()` Returns a new `VmaAllocationCreateInfo` instance allocated with `memCalloc`.
`static VmaAllocationCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VmaAllocationCreateInfo`	`callocStack()` Returns a new `VmaAllocationCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaAllocationCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaAllocationCreateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaAllocationCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaAllocationCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaAllocationCreateInfo`	`create()` Returns a new `VmaAllocationCreateInfo` instance allocated with `BufferUtils`.
`static VmaAllocationCreateInfo.Buffer`	`create(int capacity)` Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VmaAllocationCreateInfo`	`create(long address)` Returns a new `VmaAllocationCreateInfo` instance for the specified memory address.
`static VmaAllocationCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VmaAllocationCreateInfo.Buffer` instance at the specified memory.
`static VmaAllocationCreateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VmaAllocationCreateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VmaAllocationCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`static VmaAllocationCreateInfo`	`malloc()` Returns a new `VmaAllocationCreateInfo` instance allocated with `memAlloc`.
`static VmaAllocationCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VmaAllocationCreateInfo`	`mallocStack()` Returns a new `VmaAllocationCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VmaAllocationCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VmaAllocationCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaAllocationCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VmaAllocationCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaAllocationCreateInfo` instance allocated on the specified `MemoryStack`.
`int`	`memoryTypeBits()` Returns the value of the `memoryTypeBits` field.
`VmaAllocationCreateInfo`	`memoryTypeBits(int value)` Sets the specified value to the `memoryTypeBits` field.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static int`	`nmemoryTypeBits(long struct)` Unsafe version of `memoryTypeBits()`.
`static void`	`nmemoryTypeBits(long struct, int value)` Unsafe version of `memoryTypeBits`.
`static long`	`npool(long struct)` Unsafe version of `pool()`.
`static void`	`npool(long struct, long value)` Unsafe version of `pool`.
`static int`	`npreferredFlags(long struct)` Unsafe version of `preferredFlags()`.
`static void`	`npreferredFlags(long struct, int value)` Unsafe version of `preferredFlags`.
`static long`	`npUserData(long struct)` Unsafe version of `pUserData()`.
`static void`	`npUserData(long struct, long value)` Unsafe version of `pUserData`.
`static int`	`nrequiredFlags(long struct)` Unsafe version of `requiredFlags()`.
`static void`	`nrequiredFlags(long struct, int value)` Unsafe version of `requiredFlags`.
`static int`	`nusage(long struct)` Unsafe version of `usage()`.
`static void`	`nusage(long struct, int value)` Unsafe version of `usage`.
`long`	`pool()` Returns the value of the `pool` field.
`VmaAllocationCreateInfo`	`pool(long value)` Sets the specified value to the `pool` field.
`int`	`preferredFlags()` Returns the value of the `preferredFlags` field.
`VmaAllocationCreateInfo`	`preferredFlags(int value)` Sets the specified value to the `preferredFlags` field.
`long`	`pUserData()` Returns the value of the `pUserData` field.
`VmaAllocationCreateInfo`	`pUserData(long value)` Sets the specified value to the `pUserData` field.
`int`	`requiredFlags()` Returns the value of the `requiredFlags` field.
`VmaAllocationCreateInfo`	`requiredFlags(int value)` Sets the specified value to the `requiredFlags` field.
`VmaAllocationCreateInfo`	`set(int flags, int usage, int requiredFlags, int preferredFlags, int memoryTypeBits, long pool, long pUserData)` Initializes this struct with the specified values.
`VmaAllocationCreateInfo`	`set(VmaAllocationCreateInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`usage()` Returns the value of the `usage` field.
`VmaAllocationCreateInfo`	`usage(int value)` Sets the specified value to the `usage` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - 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.
  - USAGE
```
public static final int USAGE
```
    The struct member offsets.
  - REQUIREDFLAGS
```
public static final int REQUIREDFLAGS
```
    The struct member offsets.
  - PREFERREDFLAGS
```
public static final int PREFERREDFLAGS
```
    The struct member offsets.
  - MEMORYTYPEBITS
```
public static final int MEMORYTYPEBITS
```
    The struct member offsets.
  - POOL
```
public static final int POOL
```
    The struct member offsets.
  - PUSERDATA
```
public static final int PUSERDATA
```
    The struct member offsets.
- Constructor Detail
  - VmaAllocationCreateInfo
```
public VmaAllocationCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VmaAllocationCreateInfo 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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - usage
```
public int usage()
```
    Returns the value of the usage field.
  - requiredFlags
```
public int requiredFlags()
```
    Returns the value of the requiredFlags field.
  - preferredFlags
```
public int preferredFlags()
```
    Returns the value of the preferredFlags field.
  - memoryTypeBits
```
public int memoryTypeBits()
```
    Returns the value of the memoryTypeBits field.
  - pool
```
public long pool()
```
    Returns the value of the pool field.
  - pUserData
```
public long pUserData()
```
    Returns the value of the pUserData field.
  - flags
```
public VmaAllocationCreateInfo flags(int value)
```
    Sets the specified value to the flags field.
  - usage
```
public VmaAllocationCreateInfo usage(int value)
```
    Sets the specified value to the usage field.
  - requiredFlags
```
public VmaAllocationCreateInfo requiredFlags(int value)
```
    Sets the specified value to the requiredFlags field.
  - preferredFlags
```
public VmaAllocationCreateInfo preferredFlags(int value)
```
    Sets the specified value to the preferredFlags field.
  - memoryTypeBits
```
public VmaAllocationCreateInfo memoryTypeBits(int value)
```
    Sets the specified value to the memoryTypeBits field.
  - pool
```
public VmaAllocationCreateInfo pool(long value)
```
    Sets the specified value to the pool field.
  - pUserData
```
public VmaAllocationCreateInfo pUserData(long value)
```
    Sets the specified value to the pUserData field.
  - set
```
public VmaAllocationCreateInfo set(int flags,
                                   int usage,
                                   int requiredFlags,
                                   int preferredFlags,
                                   int memoryTypeBits,
                                   long pool,
                                   long pUserData)
```
    Initializes this struct with the specified values.
  - set
```
public VmaAllocationCreateInfo set(VmaAllocationCreateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VmaAllocationCreateInfo malloc()
```
    Returns a new VmaAllocationCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VmaAllocationCreateInfo calloc()
```
    Returns a new VmaAllocationCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VmaAllocationCreateInfo create()
```
    Returns a new VmaAllocationCreateInfo instance allocated with BufferUtils.
  - create
```
public static VmaAllocationCreateInfo create(long address)
```
    Returns a new VmaAllocationCreateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VmaAllocationCreateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VmaAllocationCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VmaAllocationCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VmaAllocationCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VmaAllocationCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaAllocationCreateInfo.Buffer create(int capacity)
```
    Returns a new VmaAllocationCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaAllocationCreateInfo.Buffer create(long address,
                                                    int capacity)
```
    Create a VmaAllocationCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VmaAllocationCreateInfo.Buffer createSafe(long address,
                                                                  int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VmaAllocationCreateInfo mallocStack()
```
    Returns a new VmaAllocationCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VmaAllocationCreateInfo callocStack()
```
    Returns a new VmaAllocationCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VmaAllocationCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaAllocationCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VmaAllocationCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaAllocationCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VmaAllocationCreateInfo.Buffer mallocStack(int capacity)
```
    Returns a new VmaAllocationCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaAllocationCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VmaAllocationCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VmaAllocationCreateInfo.Buffer mallocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaAllocationCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaAllocationCreateInfo.Buffer callocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaAllocationCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nusage
```
public static int nusage(long struct)
```
    Unsafe version of usage().
  - nrequiredFlags
```
public static int nrequiredFlags(long struct)
```
    Unsafe version of requiredFlags().
  - npreferredFlags
```
public static int npreferredFlags(long struct)
```
    Unsafe version of preferredFlags().
  - nmemoryTypeBits
```
public static int nmemoryTypeBits(long struct)
```
    Unsafe version of memoryTypeBits().
  - npool
```
public static long npool(long struct)
```
    Unsafe version of pool().
  - npUserData
```
public static long npUserData(long struct)
```
    Unsafe version of pUserData().
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - nusage
```
public static void nusage(long struct,
                          int value)
```
    Unsafe version of usage.
  - nrequiredFlags
```
public static void nrequiredFlags(long struct,
                                  int value)
```
    Unsafe version of requiredFlags.
  - npreferredFlags
```
public static void npreferredFlags(long struct,
                                   int value)
```
    Unsafe version of preferredFlags.
  - nmemoryTypeBits
```
public static void nmemoryTypeBits(long struct,
                                   int value)
```
    Unsafe version of memoryTypeBits.
  - npool
```
public static void npool(long struct,
                         long value)
```
    Unsafe version of pool.
  - npUserData
```
public static void npUserData(long struct,
                              long value)
```
    Unsafe version of pUserData.

`MEMORY_USAGE_UNKNOWN`	`MEMORY_USAGE_GPU_ONLY`	`MEMORY_USAGE_CPU_ONLY`
`MEMORY_USAGE_CPU_TO_GPU`	`MEMORY_USAGE_GPU_TO_CPU`	`MEMORY_USAGE_CPU_COPY`
`MEMORY_USAGE_GPU_LAZILY_ALLOCATED`

Class VmaAllocationCreateInfo

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

FLAGS

USAGE

REQUIREDFLAGS

PREFERREDFLAGS

MEMORYTYPEBITS

POOL

PUSERDATA

Constructor Detail

VmaAllocationCreateInfo

Method Detail

sizeof

flags

usage

requiredFlags

preferredFlags

memoryTypeBits

pool

pUserData

flags

usage

requiredFlags

preferredFlags

memoryTypeBits

pool

pUserData

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nflags

nusage

nrequiredFlags

npreferredFlags

nmemoryTypeBits

npool

npUserData

nflags

nusage

nrequiredFlags

npreferredFlags

nmemoryTypeBits

npool

npUserData