RPmallocGlobalStatistics (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.system.rpmalloc.RPmallocGlobalStatistics

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class RPmallocGlobalStatistics
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Member documentation
- mapped – Current amount of virtual memory mapped, all of which might not have been committed (only if ENABLE_STATISTICS=1)
- mapped_peak – Peak amount of virtual memory mapped, all of which might not have been committed (only if ENABLE_STATISTICS=1)
- cached – Current amount of memory in global caches for small and medium sizes (<32KiB)
- huge_alloc – Current amount of memory allocated in huge allocations, i.e larger than LARGE_SIZE_LIMIT which is 2MiB by default (only if ENABLE_STATISTICS=1)
- huge_alloc_peak – Peak amount of memory allocated in huge allocations, i.e larger than LARGE_SIZE_LIMIT which is 2MiB by default (only if ENABLE_STATISTICS=1)
- mapped_total – Total amount of memory mapped since initialization (only if ENABLE_STATISTICS=1)
- unmapped_total – Total amount of memory unmapped since initialization (only if ENABLE_STATISTICS=1)
Layout
```
 struct rpmalloc_global_statistics_t {
     size_t mapped;
     size_t mapped_peak;
     size_t cached;
     size_t huge_alloc;
     size_t huge_alloc_peak;
     size_t mapped_total;
     size_t unmapped_total;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CACHED` The struct member offsets.
`static int`	`HUGE_ALLOC` The struct member offsets.
`static int`	`HUGE_ALLOC_PEAK` The struct member offsets.
`static int`	`MAPPED` The struct member offsets.
`static int`	`MAPPED_PEAK` The struct member offsets.
`static int`	`MAPPED_TOTAL` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`UNMAPPED_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
`RPmallocGlobalStatistics(java.nio.ByteBuffer container)` Creates a `RPmallocGlobalStatistics` 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`	`cached()` Returns the value of the `cached` field.
`static RPmallocGlobalStatistics`	`calloc()` Returns a new `RPmallocGlobalStatistics` instance allocated with `memCalloc`.
`static RPmallocGlobalStatistics.Buffer`	`calloc(int capacity)` Returns a new `RPmallocGlobalStatistics.Buffer` instance allocated with `memCalloc`.
`static RPmallocGlobalStatistics`	`callocStack()` Returns a new `RPmallocGlobalStatistics` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static RPmallocGlobalStatistics.Buffer`	`callocStack(int capacity)` Returns a new `RPmallocGlobalStatistics.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static RPmallocGlobalStatistics.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `RPmallocGlobalStatistics.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static RPmallocGlobalStatistics`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `RPmallocGlobalStatistics` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static RPmallocGlobalStatistics`	`create()` Returns a new `RPmallocGlobalStatistics` instance allocated with `BufferUtils`.
`static RPmallocGlobalStatistics.Buffer`	`create(int capacity)` Returns a new `RPmallocGlobalStatistics.Buffer` instance allocated with `BufferUtils`.
`static RPmallocGlobalStatistics`	`create(long address)` Returns a new `RPmallocGlobalStatistics` instance for the specified memory address.
`static RPmallocGlobalStatistics.Buffer`	`create(long address, int capacity)` Create a `RPmallocGlobalStatistics.Buffer` instance at the specified memory.
`static RPmallocGlobalStatistics`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static RPmallocGlobalStatistics.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`huge_alloc_peak()` Returns the value of the `huge_alloc_peak` field.
`long`	`huge_alloc()` Returns the value of the `huge_alloc` field.
`static RPmallocGlobalStatistics`	`malloc()` Returns a new `RPmallocGlobalStatistics` instance allocated with `memAlloc`.
`static RPmallocGlobalStatistics.Buffer`	`malloc(int capacity)` Returns a new `RPmallocGlobalStatistics.Buffer` instance allocated with `memAlloc`.
`static RPmallocGlobalStatistics`	`mallocStack()` Returns a new `RPmallocGlobalStatistics` instance allocated on the thread-local `MemoryStack`.
`static RPmallocGlobalStatistics.Buffer`	`mallocStack(int capacity)` Returns a new `RPmallocGlobalStatistics.Buffer` instance allocated on the thread-local `MemoryStack`.
`static RPmallocGlobalStatistics.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `RPmallocGlobalStatistics.Buffer` instance allocated on the specified `MemoryStack`.
`static RPmallocGlobalStatistics`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `RPmallocGlobalStatistics` instance allocated on the specified `MemoryStack`.
`long`	`mapped_peak()` Returns the value of the `mapped_peak` field.
`long`	`mapped_total()` Returns the value of the `mapped_total` field.
`long`	`mapped()` Returns the value of the `mapped` field.
`static long`	`ncached(long struct)` Unsafe version of `cached()`.
`static long`	`nhuge_alloc_peak(long struct)` Unsafe version of `huge_alloc_peak()`.
`static long`	`nhuge_alloc(long struct)` Unsafe version of `huge_alloc()`.
`static long`	`nmapped_peak(long struct)` Unsafe version of `mapped_peak()`.
`static long`	`nmapped_total(long struct)` Unsafe version of `mapped_total()`.
`static long`	`nmapped(long struct)` Unsafe version of `mapped()`.
`static long`	`nunmapped_total(long struct)` Unsafe version of `unmapped_total()`.
`int`	`sizeof()`
`long`	`unmapped_total()` Returns the value of the `unmapped_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.
  - MAPPED
```
public static final int MAPPED
```
    The struct member offsets.
  - MAPPED_PEAK
```
public static final int MAPPED_PEAK
```
    The struct member offsets.
  - CACHED
```
public static final int CACHED
```
    The struct member offsets.
  - HUGE_ALLOC
```
public static final int HUGE_ALLOC
```
    The struct member offsets.
  - HUGE_ALLOC_PEAK
```
public static final int HUGE_ALLOC_PEAK
```
    The struct member offsets.
  - MAPPED_TOTAL
```
public static final int MAPPED_TOTAL
```
    The struct member offsets.
  - UNMAPPED_TOTAL
```
public static final int UNMAPPED_TOTAL
```
    The struct member offsets.
- Constructor Detail
  - RPmallocGlobalStatistics
```
public RPmallocGlobalStatistics(java.nio.ByteBuffer container)
```
    Creates a RPmallocGlobalStatistics 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
  - mapped
```
public long mapped()
```
    Returns the value of the mapped field.
  - mapped_peak
```
public long mapped_peak()
```
    Returns the value of the mapped_peak field.
  - cached
```
public long cached()
```
    Returns the value of the cached field.
  - huge_alloc
```
public long huge_alloc()
```
    Returns the value of the huge_alloc field.
  - huge_alloc_peak
```
public long huge_alloc_peak()
```
    Returns the value of the huge_alloc_peak field.
  - mapped_total
```
public long mapped_total()
```
    Returns the value of the mapped_total field.
  - unmapped_total
```
public long unmapped_total()
```
    Returns the value of the unmapped_total field.
  - malloc
```
public static RPmallocGlobalStatistics malloc()
```
    Returns a new RPmallocGlobalStatistics instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static RPmallocGlobalStatistics calloc()
```
    Returns a new RPmallocGlobalStatistics instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static RPmallocGlobalStatistics create()
```
    Returns a new RPmallocGlobalStatistics instance allocated with BufferUtils.
  - create
```
public static RPmallocGlobalStatistics create(long address)
```
    Returns a new RPmallocGlobalStatistics instance for the specified memory address.
  - createSafe
```
@Nullable
public static RPmallocGlobalStatistics createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static RPmallocGlobalStatistics.Buffer malloc(int capacity)
```
    Returns a new RPmallocGlobalStatistics.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static RPmallocGlobalStatistics.Buffer calloc(int capacity)
```
    Returns a new RPmallocGlobalStatistics.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static RPmallocGlobalStatistics.Buffer create(int capacity)
```
    Returns a new RPmallocGlobalStatistics.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static RPmallocGlobalStatistics.Buffer create(long address,
                                                     int capacity)
```
    Create a RPmallocGlobalStatistics.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static RPmallocGlobalStatistics.Buffer createSafe(long address,
                                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static RPmallocGlobalStatistics mallocStack()
```
    Returns a new RPmallocGlobalStatistics instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static RPmallocGlobalStatistics callocStack()
```
    Returns a new RPmallocGlobalStatistics instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static RPmallocGlobalStatistics mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new RPmallocGlobalStatistics instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static RPmallocGlobalStatistics callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new RPmallocGlobalStatistics instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static RPmallocGlobalStatistics.Buffer mallocStack(int capacity)
```
    Returns a new RPmallocGlobalStatistics.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static RPmallocGlobalStatistics.Buffer callocStack(int capacity)
```
    Returns a new RPmallocGlobalStatistics.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static RPmallocGlobalStatistics.Buffer mallocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new RPmallocGlobalStatistics.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static RPmallocGlobalStatistics.Buffer callocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new RPmallocGlobalStatistics.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
  - nmapped
```
public static long nmapped(long struct)
```
    Unsafe version of mapped().
  - nmapped_peak
```
public static long nmapped_peak(long struct)
```
    Unsafe version of mapped_peak().
  - ncached
```
public static long ncached(long struct)
```
    Unsafe version of cached().
  - nhuge_alloc
```
public static long nhuge_alloc(long struct)
```
    Unsafe version of huge_alloc().
  - nhuge_alloc_peak
```
public static long nhuge_alloc_peak(long struct)
```
    Unsafe version of huge_alloc_peak().
  - nmapped_total
```
public static long nmapped_total(long struct)
```
    Unsafe version of mapped_total().
  - nunmapped_total
```
public static long nunmapped_total(long struct)
```
    Unsafe version of unmapped_total().

Class RPmallocGlobalStatistics

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

MAPPED

MAPPED_PEAK

CACHED

HUGE_ALLOC

HUGE_ALLOC_PEAK

MAPPED_TOTAL

UNMAPPED_TOTAL

Constructor Detail

RPmallocGlobalStatistics

Method Detail

sizeof

mapped

mapped_peak

cached

huge_alloc

huge_alloc_peak

mapped_total

unmapped_total

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmapped

nmapped_peak

ncached

nhuge_alloc

nhuge_alloc_peak

nmapped_total

nunmapped_total