VmaStats (LWJGL 3.2.4 SNAPSHOT

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

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

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

General statistics from current state of Allocator.

Layout


 struct VmaStats {
     VmaStatInfo memoryType[32];
     VmaStatInfo memoryHeap[16];
     VmaStatInfo total;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`MEMORYHEAP` The struct member offsets.
`static int`	`MEMORYTYPE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`TOTAL` 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

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

Constructors
Constructor and Description
`VmaStats(java.nio.ByteBuffer container)` Creates a `VmaStats` 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 VmaStats`	`calloc()` Returns a new `VmaStats` instance allocated with `memCalloc`.
`static VmaStats.Buffer`	`calloc(int capacity)` Returns a new `VmaStats.Buffer` instance allocated with `memCalloc`.
`static VmaStats`	`callocStack()` Returns a new `VmaStats` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaStats.Buffer`	`callocStack(int capacity)` Returns a new `VmaStats.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VmaStats.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaStats.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaStats`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaStats` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VmaStats`	`create()` Returns a new `VmaStats` instance allocated with `BufferUtils`.
`static VmaStats.Buffer`	`create(int capacity)` Returns a new `VmaStats.Buffer` instance allocated with `BufferUtils`.
`static VmaStats`	`create(long address)` Returns a new `VmaStats` instance for the specified memory address.
`static VmaStats.Buffer`	`create(long address, int capacity)` Create a `VmaStats.Buffer` instance at the specified memory.
`static VmaStats`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VmaStats.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VmaStats`	`malloc()` Returns a new `VmaStats` instance allocated with `memAlloc`.
`static VmaStats.Buffer`	`malloc(int capacity)` Returns a new `VmaStats.Buffer` instance allocated with `memAlloc`.
`static VmaStats`	`mallocStack()` Returns a new `VmaStats` instance allocated on the thread-local `MemoryStack`.
`static VmaStats.Buffer`	`mallocStack(int capacity)` Returns a new `VmaStats.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VmaStats.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VmaStats.Buffer` instance allocated on the specified `MemoryStack`.
`static VmaStats`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VmaStats` instance allocated on the specified `MemoryStack`.
`VmaStatInfo.Buffer`	`memoryHeap()` Returns a `VmaStatInfo`.Buffer view of the `memoryHeap` field.
`VmaStatInfo`	`memoryHeap(int index)` Returns a `VmaStatInfo` view of the struct at the specified index of the `memoryHeap` field.
`VmaStatInfo.Buffer`	`memoryType()` Returns a `VmaStatInfo`.Buffer view of the `memoryType` field.
`VmaStatInfo`	`memoryType(int index)` Returns a `VmaStatInfo` view of the struct at the specified index of the `memoryType` field.
`static VmaStatInfo.Buffer`	`nmemoryHeap(long struct)` Unsafe version of `memoryHeap()`.
`static VmaStatInfo`	`nmemoryHeap(long struct, int index)` Unsafe version of `memoryHeap`.
`static VmaStatInfo.Buffer`	`nmemoryType(long struct)` Unsafe version of `memoryType()`.
`static VmaStatInfo`	`nmemoryType(long struct, int index)` Unsafe version of `memoryType`.
`static VmaStatInfo`	`ntotal(long struct)` Unsafe version of `total()`.
`int`	`sizeof()`
`VmaStatInfo`	`total()` Returns a `VmaStatInfo` view of the `total` 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.
  - MEMORYTYPE
```
public static final int MEMORYTYPE
```
    The struct member offsets.
  - MEMORYHEAP
```
public static final int MEMORYHEAP
```
    The struct member offsets.
  - TOTAL
```
public static final int TOTAL
```
    The struct member offsets.
- Constructor Detail
  - VmaStats
```
public VmaStats(java.nio.ByteBuffer container)
```
    Creates a VmaStats 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
  - memoryType
```
public VmaStatInfo.Buffer memoryType()
```
    Returns a VmaStatInfo.Buffer view of the memoryType field.
  - memoryType
```
public VmaStatInfo memoryType(int index)
```
    Returns a VmaStatInfo view of the struct at the specified index of the memoryType field.
  - memoryHeap
```
public VmaStatInfo.Buffer memoryHeap()
```
    Returns a VmaStatInfo.Buffer view of the memoryHeap field.
  - memoryHeap
```
public VmaStatInfo memoryHeap(int index)
```
    Returns a VmaStatInfo view of the struct at the specified index of the memoryHeap field.
  - total
```
public VmaStatInfo total()
```
    Returns a VmaStatInfo view of the total field.
  - malloc
```
public static VmaStats malloc()
```
    Returns a new VmaStats instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VmaStats calloc()
```
    Returns a new VmaStats instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VmaStats create()
```
    Returns a new VmaStats instance allocated with BufferUtils.
  - create
```
public static VmaStats create(long address)
```
    Returns a new VmaStats instance for the specified memory address.
  - createSafe
```
@Nullable
public static VmaStats createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VmaStats.Buffer malloc(int capacity)
```
    Returns a new VmaStats.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VmaStats.Buffer calloc(int capacity)
```
    Returns a new VmaStats.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaStats.Buffer create(int capacity)
```
    Returns a new VmaStats.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VmaStats.Buffer create(long address,
                                     int capacity)
```
    Create a VmaStats.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VmaStats.Buffer createSafe(long address,
                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VmaStats mallocStack()
```
    Returns a new VmaStats instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VmaStats callocStack()
```
    Returns a new VmaStats instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VmaStats mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaStats instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VmaStats callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaStats instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VmaStats.Buffer mallocStack(int capacity)
```
    Returns a new VmaStats.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaStats.Buffer callocStack(int capacity)
```
    Returns a new VmaStats.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VmaStats.Buffer mallocStack(int capacity,
                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaStats.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VmaStats.Buffer callocStack(int capacity,
                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VmaStats.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
  - nmemoryType
```
public static VmaStatInfo.Buffer nmemoryType(long struct)
```
    Unsafe version of memoryType().
  - nmemoryType
```
public static VmaStatInfo nmemoryType(long struct,
                                      int index)
```
    Unsafe version of memoryType.
  - nmemoryHeap
```
public static VmaStatInfo.Buffer nmemoryHeap(long struct)
```
    Unsafe version of memoryHeap().
  - nmemoryHeap
```
public static VmaStatInfo nmemoryHeap(long struct,
                                      int index)
```
    Unsafe version of memoryHeap.
  - ntotal
```
public static VmaStatInfo ntotal(long struct)
```
    Unsafe version of total().

Class VmaStats

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

MEMORYTYPE

MEMORYHEAP

TOTAL

Constructor Detail

VmaStats

Method Detail

sizeof

memoryType

memoryType

memoryHeap

memoryHeap

total

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmemoryType

nmemoryType

nmemoryHeap

nmemoryHeap

ntotal