VmaPoolCreateInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VmaPoolCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Describes parameter of created VmaPool.
Member documentation
- memoryTypeIndex – Vulkan memory type index to allocate this pool from
- flags – Use combination of VmaPoolCreateFlagBits. One or more of:
  POOL_CREATE_IGNORE_BUFFER_IMAGE_GRANULARITY_BIT POOL_CREATE_LINEAR_ALGORITHM_BIT
  POOL_CREATE_BUDDY_ALGORITHM_BIT POOL_CREATE_ALGORITHM_MASK
- blockSize – size of a single VkDeviceMemory block to be allocated as part of this pool, in bytes. Optional.
  Specify nonzero to set explicit, constant size of memory blocks used by this pool. Leave 0 to use default and let the library manage block sizes automatically. Sizes of particular blocks may vary.
- minBlockCount – minimum number of blocks to be always allocated in this pool, even if they stay empty.
  Set to 0 to have no preallocated blocks and allow the pool be completely empty.
- maxBlockCount – maximum number of blocks that can be allocated in this pool. Optional.
  Set to 0 to use default, which is SIZE_MAX, which means no limit. Set to same value as VmaPoolCreateInfo::minBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
- frameInUseCount – maximum number of additional frames that are in use at the same time as current frame.
  This value is used only when you make allocations with ALLOCATION_CREATE_CAN_BECOME_LOST_BIT flag. Such allocation cannot become lost if allocation.lastUseFrameIndex >= allocator.currentFrameIndex - frameInUseCount.
  
  For example, if you double-buffer your command buffers, so resources used for rendering in previous frame may still be in use by the GPU at the moment you allocate resources needed for the current frame, set this value to 1.
  
  If you want to allow any allocations other than used in the current frame to become lost, set this value to 0.
Layout
```
 struct VmaPoolCreateInfo {
     uint32_t memoryTypeIndex;
     VmaPoolCreateFlags flags;
     VkDeviceSize blockSize;
     size_t minBlockCount;
     size_t maxBlockCount;
     uint32_t frameInUseCount;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VmaPoolCreateInfo.Buffer
An array of VmaPoolCreateInfo 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`	`VmaPoolCreateInfo.Buffer` An array of `VmaPoolCreateInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`BLOCKSIZE` The struct member offsets.
`static int`	`FLAGS` The struct member offsets.
`static int`	`FRAMEINUSECOUNT` The struct member offsets.
`static int`	`MAXBLOCKCOUNT` The struct member offsets.
`static int`	`MEMORYTYPEINDEX` The struct member offsets.
`static int`	`MINBLOCKCOUNT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

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

Constructor Summary

Constructors
Constructor and Description

VmaPoolCreateInfo(java.nio.ByteBuffer container)
Creates a VmaPoolCreateInfo instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`VmaPoolCreateInfo(java.nio.ByteBuffer container)` Creates a `VmaPoolCreateInfo` 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
`long`	`blockSize()` Returns the value of the `blockSize` field.
`VmaPoolCreateInfo`	`blockSize(long value)` Sets the specified value to the `blockSize` field.
`static VmaPoolCreateInfo`	`calloc()` Returns a new `VmaPoolCreateInfo` instance allocated with `memCalloc`.
`static VmaPoolCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VmaPoolCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VmaPoolCreateInfo`	`callocStack()` Returns a new `VmaPoolCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaPoolCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VmaPoolCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaPoolCreateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaPoolCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaPoolCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaPoolCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaPoolCreateInfo`	`create()` Returns a new `VmaPoolCreateInfo` instance allocated with `BufferUtils`.
`static VmaPoolCreateInfo.Buffer`	`create(int capacity)` Returns a new `VmaPoolCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VmaPoolCreateInfo`	`create(long address)` Returns a new `VmaPoolCreateInfo` instance for the specified memory address.
`static VmaPoolCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VmaPoolCreateInfo.Buffer` instance at the specified memory.
`static VmaPoolCreateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VmaPoolCreateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VmaPoolCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`int`	`frameInUseCount()` Returns the value of the `frameInUseCount` field.
`VmaPoolCreateInfo`	`frameInUseCount(int value)` Sets the specified value to the `frameInUseCount` field.
`static VmaPoolCreateInfo`	`malloc()` Returns a new `VmaPoolCreateInfo` instance allocated with `memAlloc`.
`static VmaPoolCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VmaPoolCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VmaPoolCreateInfo`	`mallocStack()` Returns a new `VmaPoolCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VmaPoolCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VmaPoolCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VmaPoolCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaPoolCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VmaPoolCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaPoolCreateInfo` instance allocated on the specified `MemoryStack`.
`long`	`maxBlockCount()` Returns the value of the `maxBlockCount` field.
`VmaPoolCreateInfo`	`maxBlockCount(long value)` Sets the specified value to the `maxBlockCount` field.
`int`	`memoryTypeIndex()` Returns the value of the `memoryTypeIndex` field.
`VmaPoolCreateInfo`	`memoryTypeIndex(int value)` Sets the specified value to the `memoryTypeIndex` field.
`long`	`minBlockCount()` Returns the value of the `minBlockCount` field.
`VmaPoolCreateInfo`	`minBlockCount(long value)` Sets the specified value to the `minBlockCount` field.
`static long`	`nblockSize(long struct)` Unsafe version of `blockSize()`.
`static void`	`nblockSize(long struct, long value)` Unsafe version of `blockSize`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static int`	`nframeInUseCount(long struct)` Unsafe version of `frameInUseCount()`.
`static void`	`nframeInUseCount(long struct, int value)` Unsafe version of `frameInUseCount`.
`static long`	`nmaxBlockCount(long struct)` Unsafe version of `maxBlockCount()`.
`static void`	`nmaxBlockCount(long struct, long value)` Unsafe version of `maxBlockCount`.
`static int`	`nmemoryTypeIndex(long struct)` Unsafe version of `memoryTypeIndex()`.
`static void`	`nmemoryTypeIndex(long struct, int value)` Unsafe version of `memoryTypeIndex`.
`static long`	`nminBlockCount(long struct)` Unsafe version of `minBlockCount()`.
`static void`	`nminBlockCount(long struct, long value)` Unsafe version of `minBlockCount`.
`VmaPoolCreateInfo`	`set(int memoryTypeIndex, int flags, long blockSize, long minBlockCount, long maxBlockCount, int frameInUseCount)` Initializes this struct with the specified values.
`VmaPoolCreateInfo`	`set(VmaPoolCreateInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`

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.
  - MEMORYTYPEINDEX
```
public static final int MEMORYTYPEINDEX
```
    The struct member offsets.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
  - BLOCKSIZE
```
public static final int BLOCKSIZE
```
    The struct member offsets.
  - MINBLOCKCOUNT
```
public static final int MINBLOCKCOUNT
```
    The struct member offsets.
  - MAXBLOCKCOUNT
```
public static final int MAXBLOCKCOUNT
```
    The struct member offsets.
  - FRAMEINUSECOUNT
```
public static final int FRAMEINUSECOUNT
```
    The struct member offsets.
- Constructor Detail
  - VmaPoolCreateInfo
```
public VmaPoolCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VmaPoolCreateInfo 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
  - memoryTypeIndex
```
public int memoryTypeIndex()
```
    Returns the value of the memoryTypeIndex field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - blockSize
```
public long blockSize()
```
    Returns the value of the blockSize field.
  - minBlockCount
```
public long minBlockCount()
```
    Returns the value of the minBlockCount field.
  - maxBlockCount
```
public long maxBlockCount()
```
    Returns the value of the maxBlockCount field.
  - frameInUseCount
```
public int frameInUseCount()
```
    Returns the value of the frameInUseCount field.
  - memoryTypeIndex
```
public VmaPoolCreateInfo memoryTypeIndex(int value)
```
    Sets the specified value to the memoryTypeIndex field.
  - flags
```
public VmaPoolCreateInfo flags(int value)
```
    Sets the specified value to the flags field.
  - blockSize
```
public VmaPoolCreateInfo blockSize(long value)
```
    Sets the specified value to the blockSize field.
  - minBlockCount
```
public VmaPoolCreateInfo minBlockCount(long value)
```
    Sets the specified value to the minBlockCount field.
  - maxBlockCount
```
public VmaPoolCreateInfo maxBlockCount(long value)
```
    Sets the specified value to the maxBlockCount field.
  - frameInUseCount
```
public VmaPoolCreateInfo frameInUseCount(int value)
```
    Sets the specified value to the frameInUseCount field.
  - set
```
public VmaPoolCreateInfo set(int memoryTypeIndex,
                             int flags,
                             long blockSize,
                             long minBlockCount,
                             long maxBlockCount,
                             int frameInUseCount)
```
    Initializes this struct with the specified values.
  - set
```
public VmaPoolCreateInfo set(VmaPoolCreateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VmaPoolCreateInfo malloc()
```
    Returns a new VmaPoolCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VmaPoolCreateInfo calloc()
```
    Returns a new VmaPoolCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VmaPoolCreateInfo create()
```
    Returns a new VmaPoolCreateInfo instance allocated with BufferUtils.
  - create
```
public static VmaPoolCreateInfo create(long address)
```
    Returns a new VmaPoolCreateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VmaPoolCreateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VmaPoolCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VmaPoolCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VmaPoolCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VmaPoolCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaPoolCreateInfo.Buffer create(int capacity)
```
    Returns a new VmaPoolCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaPoolCreateInfo.Buffer create(long address,
                                              int capacity)
```
    Create a VmaPoolCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VmaPoolCreateInfo.Buffer createSafe(long address,
                                                            int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VmaPoolCreateInfo mallocStack()
```
    Returns a new VmaPoolCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VmaPoolCreateInfo callocStack()
```
    Returns a new VmaPoolCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VmaPoolCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaPoolCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VmaPoolCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaPoolCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VmaPoolCreateInfo.Buffer mallocStack(int capacity)
```
    Returns a new VmaPoolCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaPoolCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VmaPoolCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VmaPoolCreateInfo.Buffer mallocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaPoolCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaPoolCreateInfo.Buffer callocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaPoolCreateInfo.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
  - nmemoryTypeIndex
```
public static int nmemoryTypeIndex(long struct)
```
    Unsafe version of memoryTypeIndex().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nblockSize
```
public static long nblockSize(long struct)
```
    Unsafe version of blockSize().
  - nminBlockCount
```
public static long nminBlockCount(long struct)
```
    Unsafe version of minBlockCount().
  - nmaxBlockCount
```
public static long nmaxBlockCount(long struct)
```
    Unsafe version of maxBlockCount().
  - nframeInUseCount
```
public static int nframeInUseCount(long struct)
```
    Unsafe version of frameInUseCount().
  - nmemoryTypeIndex
```
public static void nmemoryTypeIndex(long struct,
                                    int value)
```
    Unsafe version of memoryTypeIndex.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - nblockSize
```
public static void nblockSize(long struct,
                              long value)
```
    Unsafe version of blockSize.
  - nminBlockCount
```
public static void nminBlockCount(long struct,
                                  long value)
```
    Unsafe version of minBlockCount.
  - nmaxBlockCount
```
public static void nmaxBlockCount(long struct,
                                  long value)
```
    Unsafe version of maxBlockCount.
  - nframeInUseCount
```
public static void nframeInUseCount(long struct,
                                    int value)
```
    Unsafe version of frameInUseCount.

`POOL_CREATE_IGNORE_BUFFER_IMAGE_GRANULARITY_BIT`	`POOL_CREATE_LINEAR_ALGORITHM_BIT`
`POOL_CREATE_BUDDY_ALGORITHM_BIT`	`POOL_CREATE_ALGORITHM_MASK`

Class VmaPoolCreateInfo

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

MEMORYTYPEINDEX

FLAGS

BLOCKSIZE

MINBLOCKCOUNT

MAXBLOCKCOUNT

FRAMEINUSECOUNT

Constructor Detail

VmaPoolCreateInfo

Method Detail

sizeof

memoryTypeIndex

flags

blockSize

minBlockCount

maxBlockCount

frameInUseCount

memoryTypeIndex

flags

blockSize

minBlockCount

maxBlockCount

frameInUseCount

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmemoryTypeIndex

nflags

nblockSize

nminBlockCount

nmaxBlockCount

nframeInUseCount

nmemoryTypeIndex

nflags

nblockSize

nminBlockCount

nmaxBlockCount

nframeInUseCount