VmaPoolStats (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VmaPoolStats
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Describes parameter of existing VmaPool.
Member documentation
- size – total amount of VkDeviceMemory allocated from Vulkan for this pool, in bytes
- unusedSize – total number of bytes in the pool not used by any VmaAllocation
- allocationCount – number of VmaAllocation objects created from this pool that were not destroyed or lost
- unusedRangeCount – number of continuous memory ranges in the pool not used by any VmaAllocation
- unusedRangeSizeMax – size of the largest continuous free memory region available for new allocation.
  Making a new allocation of that size is not guaranteed to succeed because of possible additional margin required to respect alignment and buffer/imag granularity.
- blockCount – number of VkDeviceMemory blocks allocated for this pool
Layout
```
 struct VmaPoolStats {
     VkDeviceSize size;
     VkDeviceSize unusedSize;
     size_t allocationCount;
     size_t unusedRangeCount;
     VkDeviceSize unusedRangeSizeMax;
     size_t blockCount;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ALLOCATIONCOUNT` The struct member offsets.
`static int`	`BLOCKCOUNT` The struct member offsets.
`static int`	`SIZE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`UNUSEDRANGECOUNT` The struct member offsets.
`static int`	`UNUSEDRANGESIZEMAX` The struct member offsets.
`static int`	`UNUSEDSIZE` 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

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

Constructors
Constructor and Description
`VmaPoolStats(java.nio.ByteBuffer container)` Creates a `VmaPoolStats` 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`	`allocationCount()` Returns the value of the `allocationCount` field.
`long`	`blockCount()` Returns the value of the `blockCount` field.
`static VmaPoolStats`	`calloc()` Returns a new `VmaPoolStats` instance allocated with `memCalloc`.
`static VmaPoolStats.Buffer`	`calloc(int capacity)` Returns a new `VmaPoolStats.Buffer` instance allocated with `memCalloc`.
`static VmaPoolStats`	`callocStack()` Returns a new `VmaPoolStats` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaPoolStats.Buffer`	`callocStack(int capacity)` Returns a new `VmaPoolStats.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaPoolStats.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaPoolStats.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaPoolStats`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaPoolStats` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaPoolStats`	`create()` Returns a new `VmaPoolStats` instance allocated with `BufferUtils`.
`static VmaPoolStats.Buffer`	`create(int capacity)` Returns a new `VmaPoolStats.Buffer` instance allocated with `BufferUtils`.
`static VmaPoolStats`	`create(long address)` Returns a new `VmaPoolStats` instance for the specified memory address.
`static VmaPoolStats.Buffer`	`create(long address, int capacity)` Create a `VmaPoolStats.Buffer` instance at the specified memory.
`static VmaPoolStats`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VmaPoolStats.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VmaPoolStats`	`malloc()` Returns a new `VmaPoolStats` instance allocated with `memAlloc`.
`static VmaPoolStats.Buffer`	`malloc(int capacity)` Returns a new `VmaPoolStats.Buffer` instance allocated with `memAlloc`.
`static VmaPoolStats`	`mallocStack()` Returns a new `VmaPoolStats` instance allocated on the thread-local `MemoryStack`.
`static VmaPoolStats.Buffer`	`mallocStack(int capacity)` Returns a new `VmaPoolStats.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VmaPoolStats.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaPoolStats.Buffer` instance allocated on the specified `MemoryStack`.
`static VmaPoolStats`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaPoolStats` instance allocated on the specified `MemoryStack`.
`static long`	`nallocationCount(long struct)` Unsafe version of `allocationCount()`.
`static long`	`nblockCount(long struct)` Unsafe version of `blockCount()`.
`static long`	`nsize(long struct)` Unsafe version of `size()`.
`static long`	`nunusedRangeCount(long struct)` Unsafe version of `unusedRangeCount()`.
`static long`	`nunusedRangeSizeMax(long struct)` Unsafe version of `unusedRangeSizeMax()`.
`static long`	`nunusedSize(long struct)` Unsafe version of `unusedSize()`.
`long`	`size()` Returns the value of the `size` field.
`int`	`sizeof()`
`long`	`unusedRangeCount()` Returns the value of the `unusedRangeCount` field.
`long`	`unusedRangeSizeMax()` Returns the value of the `unusedRangeSizeMax` field.
`long`	`unusedSize()` Returns the value of the `unusedSize` 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.
  - SIZE
```
public static final int SIZE
```
    The struct member offsets.
  - UNUSEDSIZE
```
public static final int UNUSEDSIZE
```
    The struct member offsets.
  - ALLOCATIONCOUNT
```
public static final int ALLOCATIONCOUNT
```
    The struct member offsets.
  - UNUSEDRANGECOUNT
```
public static final int UNUSEDRANGECOUNT
```
    The struct member offsets.
  - UNUSEDRANGESIZEMAX
```
public static final int UNUSEDRANGESIZEMAX
```
    The struct member offsets.
  - BLOCKCOUNT
```
public static final int BLOCKCOUNT
```
    The struct member offsets.
- Constructor Detail
  - VmaPoolStats
```
public VmaPoolStats(java.nio.ByteBuffer container)
```
    Creates a VmaPoolStats 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
  - size
```
public long size()
```
    Returns the value of the size field.
  - unusedSize
```
public long unusedSize()
```
    Returns the value of the unusedSize field.
  - allocationCount
```
public long allocationCount()
```
    Returns the value of the allocationCount field.
  - unusedRangeCount
```
public long unusedRangeCount()
```
    Returns the value of the unusedRangeCount field.
  - unusedRangeSizeMax
```
public long unusedRangeSizeMax()
```
    Returns the value of the unusedRangeSizeMax field.
  - blockCount
```
public long blockCount()
```
    Returns the value of the blockCount field.
  - malloc
```
public static VmaPoolStats malloc()
```
    Returns a new VmaPoolStats instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VmaPoolStats calloc()
```
    Returns a new VmaPoolStats instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VmaPoolStats create()
```
    Returns a new VmaPoolStats instance allocated with BufferUtils.
  - create
```
public static VmaPoolStats create(long address)
```
    Returns a new VmaPoolStats instance for the specified memory address.
  - createSafe
```
@Nullable
public static VmaPoolStats createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VmaPoolStats.Buffer malloc(int capacity)
```
    Returns a new VmaPoolStats.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VmaPoolStats.Buffer calloc(int capacity)
```
    Returns a new VmaPoolStats.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaPoolStats.Buffer create(int capacity)
```
    Returns a new VmaPoolStats.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaPoolStats.Buffer create(long address,
                                         int capacity)
```
    Create a VmaPoolStats.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VmaPoolStats.Buffer createSafe(long address,
                                                       int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VmaPoolStats mallocStack()
```
    Returns a new VmaPoolStats instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VmaPoolStats callocStack()
```
    Returns a new VmaPoolStats instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VmaPoolStats mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaPoolStats instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VmaPoolStats callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaPoolStats instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VmaPoolStats.Buffer mallocStack(int capacity)
```
    Returns a new VmaPoolStats.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaPoolStats.Buffer callocStack(int capacity)
```
    Returns a new VmaPoolStats.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VmaPoolStats.Buffer mallocStack(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaPoolStats.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaPoolStats.Buffer callocStack(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaPoolStats.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
  - nsize
```
public static long nsize(long struct)
```
    Unsafe version of size().
  - nunusedSize
```
public static long nunusedSize(long struct)
```
    Unsafe version of unusedSize().
  - nallocationCount
```
public static long nallocationCount(long struct)
```
    Unsafe version of allocationCount().
  - nunusedRangeCount
```
public static long nunusedRangeCount(long struct)
```
    Unsafe version of unusedRangeCount().
  - nunusedRangeSizeMax
```
public static long nunusedRangeSizeMax(long struct)
```
    Unsafe version of unusedRangeSizeMax().
  - nblockCount
```
public static long nblockCount(long struct)
```
    Unsafe version of blockCount().

Class VmaPoolStats

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

SIZE

UNUSEDSIZE

ALLOCATIONCOUNT

UNUSEDRANGECOUNT

UNUSEDRANGESIZEMAX

BLOCKCOUNT

Constructor Detail

VmaPoolStats

Method Detail

sizeof

size

unusedSize

allocationCount

unusedRangeCount

unusedRangeSizeMax

blockCount

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsize

nunusedSize

nallocationCount

nunusedRangeCount

nunusedRangeSizeMax

nblockCount