VmaStatInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

org.lwjgl.system.Pointer
```
public class VmaStatInfo
extends org.lwjgl.system.Struct
```
Calculated statistics of memory usage in entire allocator.
Member documentation
- blockCount – number of VkDeviceMemory Vulkan memory blocks allocated
- allocationCount – number of VmaAllocation allocation objects allocated
- unusedRangeCount – number of free ranges of memory between allocations
- usedBytes – total number of bytes occupied by all allocations
- unusedBytes – total number of bytes occupied by unused ranges
Layout
```
 struct VmaStatInfo {
     uint32_t blockCount;
     uint32_t allocationCount;
     uint32_t unusedRangeCount;
     VkDeviceSize usedBytes;
     VkDeviceSize unusedBytes;
     VkDeviceSize allocationSizeMin;
     VkDeviceSize allocationSizeAvg;
     VkDeviceSize allocationSizeMax;
     VkDeviceSize unusedRangeSizeMin;
     VkDeviceSize unusedRangeSizeAvg;
     VkDeviceSize unusedRangeSizeMax;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VmaStatInfo.Buffer
An array of VmaStatInfo 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`	`VmaStatInfo.Buffer` An array of `VmaStatInfo` 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`	`ALLOCATIONSIZEAVG` The struct member offsets.
`static int`	`ALLOCATIONSIZEMAX` The struct member offsets.
`static int`	`ALLOCATIONSIZEMIN` The struct member offsets.
`static int`	`BLOCKCOUNT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`UNUSEDBYTES` The struct member offsets.
`static int`	`UNUSEDRANGECOUNT` The struct member offsets.
`static int`	`UNUSEDRANGESIZEAVG` The struct member offsets.
`static int`	`UNUSEDRANGESIZEMAX` The struct member offsets.
`static int`	`UNUSEDRANGESIZEMIN` The struct member offsets.
`static int`	`USEDBYTES` 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

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

Constructors
Constructor and Description
`VmaStatInfo(java.nio.ByteBuffer container)` Creates a `VmaStatInfo` 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
`int`	`allocationCount()` Returns the value of the `allocationCount` field.
`long`	`allocationSizeAvg()` Returns the value of the `allocationSizeAvg` field.
`long`	`allocationSizeMax()` Returns the value of the `allocationSizeMax` field.
`long`	`allocationSizeMin()` Returns the value of the `allocationSizeMin` field.
`int`	`blockCount()` Returns the value of the `blockCount` field.
`static VmaStatInfo`	`create(long address)` Returns a new `VmaStatInfo` instance for the specified memory address.
`static VmaStatInfo.Buffer`	`create(long address, int capacity)` Create a `VmaStatInfo.Buffer` instance at the specified memory.
`static VmaStatInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VmaStatInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static int`	`nallocationCount(long struct)` Unsafe version of `allocationCount()`.
`static long`	`nallocationSizeAvg(long struct)` Unsafe version of `allocationSizeAvg()`.
`static long`	`nallocationSizeMax(long struct)` Unsafe version of `allocationSizeMax()`.
`static long`	`nallocationSizeMin(long struct)` Unsafe version of `allocationSizeMin()`.
`static int`	`nblockCount(long struct)` Unsafe version of `blockCount()`.
`static long`	`nunusedBytes(long struct)` Unsafe version of `unusedBytes()`.
`static int`	`nunusedRangeCount(long struct)` Unsafe version of `unusedRangeCount()`.
`static long`	`nunusedRangeSizeAvg(long struct)` Unsafe version of `unusedRangeSizeAvg()`.
`static long`	`nunusedRangeSizeMax(long struct)` Unsafe version of `unusedRangeSizeMax()`.
`static long`	`nunusedRangeSizeMin(long struct)` Unsafe version of `unusedRangeSizeMin()`.
`static long`	`nusedBytes(long struct)` Unsafe version of `usedBytes()`.
`int`	`sizeof()`
`long`	`unusedBytes()` Returns the value of the `unusedBytes` field.
`int`	`unusedRangeCount()` Returns the value of the `unusedRangeCount` field.
`long`	`unusedRangeSizeAvg()` Returns the value of the `unusedRangeSizeAvg` field.
`long`	`unusedRangeSizeMax()` Returns the value of the `unusedRangeSizeMax` field.
`long`	`unusedRangeSizeMin()` Returns the value of the `unusedRangeSizeMin` field.
`long`	`usedBytes()` Returns the value of the `usedBytes` 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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - BLOCKCOUNT
```
public static final int BLOCKCOUNT
```
    The struct member offsets.
  - ALLOCATIONCOUNT
```
public static final int ALLOCATIONCOUNT
```
    The struct member offsets.
  - UNUSEDRANGECOUNT
```
public static final int UNUSEDRANGECOUNT
```
    The struct member offsets.
  - USEDBYTES
```
public static final int USEDBYTES
```
    The struct member offsets.
  - UNUSEDBYTES
```
public static final int UNUSEDBYTES
```
    The struct member offsets.
  - ALLOCATIONSIZEMIN
```
public static final int ALLOCATIONSIZEMIN
```
    The struct member offsets.
  - ALLOCATIONSIZEAVG
```
public static final int ALLOCATIONSIZEAVG
```
    The struct member offsets.
  - ALLOCATIONSIZEMAX
```
public static final int ALLOCATIONSIZEMAX
```
    The struct member offsets.
  - UNUSEDRANGESIZEMIN
```
public static final int UNUSEDRANGESIZEMIN
```
    The struct member offsets.
  - UNUSEDRANGESIZEAVG
```
public static final int UNUSEDRANGESIZEAVG
```
    The struct member offsets.
  - UNUSEDRANGESIZEMAX
```
public static final int UNUSEDRANGESIZEMAX
```
    The struct member offsets.
- Constructor Detail
  - VmaStatInfo
```
public VmaStatInfo(java.nio.ByteBuffer container)
```
    Creates a VmaStatInfo 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
  - blockCount
```
public int blockCount()
```
    Returns the value of the blockCount field.
  - allocationCount
```
public int allocationCount()
```
    Returns the value of the allocationCount field.
  - unusedRangeCount
```
public int unusedRangeCount()
```
    Returns the value of the unusedRangeCount field.
  - usedBytes
```
public long usedBytes()
```
    Returns the value of the usedBytes field.
  - unusedBytes
```
public long unusedBytes()
```
    Returns the value of the unusedBytes field.
  - allocationSizeMin
```
public long allocationSizeMin()
```
    Returns the value of the allocationSizeMin field.
  - allocationSizeAvg
```
public long allocationSizeAvg()
```
    Returns the value of the allocationSizeAvg field.
  - allocationSizeMax
```
public long allocationSizeMax()
```
    Returns the value of the allocationSizeMax field.
  - unusedRangeSizeMin
```
public long unusedRangeSizeMin()
```
    Returns the value of the unusedRangeSizeMin field.
  - unusedRangeSizeAvg
```
public long unusedRangeSizeAvg()
```
    Returns the value of the unusedRangeSizeAvg field.
  - unusedRangeSizeMax
```
public long unusedRangeSizeMax()
```
    Returns the value of the unusedRangeSizeMax field.
  - create
```
public static VmaStatInfo create(long address)
```
    Returns a new VmaStatInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VmaStatInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - create
```
public static VmaStatInfo.Buffer create(long address,
                                        int capacity)
```
    Create a VmaStatInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VmaStatInfo.Buffer createSafe(long address,
                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - nblockCount
```
public static int nblockCount(long struct)
```
    Unsafe version of blockCount().
  - nallocationCount
```
public static int nallocationCount(long struct)
```
    Unsafe version of allocationCount().
  - nunusedRangeCount
```
public static int nunusedRangeCount(long struct)
```
    Unsafe version of unusedRangeCount().
  - nusedBytes
```
public static long nusedBytes(long struct)
```
    Unsafe version of usedBytes().
  - nunusedBytes
```
public static long nunusedBytes(long struct)
```
    Unsafe version of unusedBytes().
  - nallocationSizeMin
```
public static long nallocationSizeMin(long struct)
```
    Unsafe version of allocationSizeMin().
  - nallocationSizeAvg
```
public static long nallocationSizeAvg(long struct)
```
    Unsafe version of allocationSizeAvg().
  - nallocationSizeMax
```
public static long nallocationSizeMax(long struct)
```
    Unsafe version of allocationSizeMax().
  - nunusedRangeSizeMin
```
public static long nunusedRangeSizeMin(long struct)
```
    Unsafe version of unusedRangeSizeMin().
  - nunusedRangeSizeAvg
```
public static long nunusedRangeSizeAvg(long struct)
```
    Unsafe version of unusedRangeSizeAvg().
  - nunusedRangeSizeMax
```
public static long nunusedRangeSizeMax(long struct)
```
    Unsafe version of unusedRangeSizeMax().

Class VmaStatInfo

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

Field Detail

SIZEOF

ALIGNOF

BLOCKCOUNT

ALLOCATIONCOUNT

UNUSEDRANGECOUNT

USEDBYTES

UNUSEDBYTES

ALLOCATIONSIZEMIN

ALLOCATIONSIZEAVG

ALLOCATIONSIZEMAX

UNUSEDRANGESIZEMIN

UNUSEDRANGESIZEAVG

UNUSEDRANGESIZEMAX

Constructor Detail

VmaStatInfo

Method Detail

sizeof

blockCount

allocationCount

unusedRangeCount

usedBytes

unusedBytes

allocationSizeMin

allocationSizeAvg

allocationSizeMax

unusedRangeSizeMin

unusedRangeSizeAvg

unusedRangeSizeMax

create

createSafe

create

createSafe

nblockCount

nallocationCount

nunusedRangeCount

nusedBytes

nunusedBytes

nallocationSizeMin

nallocationSizeAvg

nallocationSizeMax

nunusedRangeSizeMin

nunusedRangeSizeAvg

nunusedRangeSizeMax