NkMemoryStatus (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.nuklear.NkMemoryStatus

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

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

Layout


 struct nk_memory_status {
     void * memory;
     unsigned int type;
     nk_size size;
     nk_size allocated;
     nk_size needed;
     nk_size calls;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ALLOCATED` The struct member offsets.
`static int`	`CALLS` The struct member offsets.
`static int`	`MEMORY` The struct member offsets.
`static int`	`NEEDED` The struct member offsets.
`static int`	`SIZE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`TYPE` 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

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

Constructors
Constructor and Description
`NkMemoryStatus(java.nio.ByteBuffer container)` Creates a `NkMemoryStatus` 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`	`allocated()` Returns the value of the `allocated` field.
`static NkMemoryStatus`	`calloc()` Returns a new `NkMemoryStatus` instance allocated with `memCalloc`.
`static NkMemoryStatus.Buffer`	`calloc(int capacity)` Returns a new `NkMemoryStatus.Buffer` instance allocated with `memCalloc`.
`static NkMemoryStatus`	`callocStack()` Returns a new `NkMemoryStatus` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkMemoryStatus.Buffer`	`callocStack(int capacity)` Returns a new `NkMemoryStatus.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkMemoryStatus.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkMemoryStatus.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static NkMemoryStatus`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkMemoryStatus` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`long`	`calls()` Returns the value of the `calls` field.
`static NkMemoryStatus`	`create()` Returns a new `NkMemoryStatus` instance allocated with `BufferUtils`.
`static NkMemoryStatus.Buffer`	`create(int capacity)` Returns a new `NkMemoryStatus.Buffer` instance allocated with `BufferUtils`.
`static NkMemoryStatus`	`create(long address)` Returns a new `NkMemoryStatus` instance for the specified memory address.
`static NkMemoryStatus.Buffer`	`create(long address, int capacity)` Create a `NkMemoryStatus.Buffer` instance at the specified memory.
`static NkMemoryStatus`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static NkMemoryStatus.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static NkMemoryStatus`	`malloc()` Returns a new `NkMemoryStatus` instance allocated with `memAlloc`.
`static NkMemoryStatus.Buffer`	`malloc(int capacity)` Returns a new `NkMemoryStatus.Buffer` instance allocated with `memAlloc`.
`static NkMemoryStatus`	`mallocStack()` Returns a new `NkMemoryStatus` instance allocated on the thread-local `MemoryStack`.
`static NkMemoryStatus.Buffer`	`mallocStack(int capacity)` Returns a new `NkMemoryStatus.Buffer` instance allocated on the thread-local `MemoryStack`.
`static NkMemoryStatus.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkMemoryStatus.Buffer` instance allocated on the specified `MemoryStack`.
`static NkMemoryStatus`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkMemoryStatus` instance allocated on the specified `MemoryStack`.
`java.nio.ByteBuffer`	`memory()` Returns a `ByteBuffer` view of the data pointed to by the `memory` field.
`static long`	`nallocated(long struct)` Unsafe version of `allocated()`.
`static long`	`ncalls(long struct)` Unsafe version of `calls()`.
`long`	`needed()` Returns the value of the `needed` field.
`static java.nio.ByteBuffer`	`nmemory(long struct)` Unsafe version of `memory`.
`static long`	`nneeded(long struct)` Unsafe version of `needed()`.
`static long`	`nsize(long struct)` Unsafe version of `size()`.
`static int`	`ntype(long struct)` Unsafe version of `type()`.
`long`	`size()` Returns the value of the `size` field.
`int`	`sizeof()`
`int`	`type()` Returns the value of the `type` 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.
  - MEMORY
```
public static final int MEMORY
```
    The struct member offsets.
  - TYPE
```
public static final int TYPE
```
    The struct member offsets.
  - SIZE
```
public static final int SIZE
```
    The struct member offsets.
  - ALLOCATED
```
public static final int ALLOCATED
```
    The struct member offsets.
  - NEEDED
```
public static final int NEEDED
```
    The struct member offsets.
  - CALLS
```
public static final int CALLS
```
    The struct member offsets.
- Constructor Detail
  - NkMemoryStatus
```
public NkMemoryStatus(java.nio.ByteBuffer container)
```
    Creates a NkMemoryStatus 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
  - memory
```
public java.nio.ByteBuffer memory()
```
    Returns a ByteBuffer view of the data pointed to by the memory field.
  - type
```
public int type()
```
    Returns the value of the type field.
  - size
```
public long size()
```
    Returns the value of the size field.
  - allocated
```
public long allocated()
```
    Returns the value of the allocated field.
  - needed
```
public long needed()
```
    Returns the value of the needed field.
  - calls
```
public long calls()
```
    Returns the value of the calls field.
  - malloc
```
public static NkMemoryStatus malloc()
```
    Returns a new NkMemoryStatus instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static NkMemoryStatus calloc()
```
    Returns a new NkMemoryStatus instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static NkMemoryStatus create()
```
    Returns a new NkMemoryStatus instance allocated with BufferUtils.
  - create
```
public static NkMemoryStatus create(long address)
```
    Returns a new NkMemoryStatus instance for the specified memory address.
  - createSafe
```
@Nullable
public static NkMemoryStatus createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static NkMemoryStatus.Buffer malloc(int capacity)
```
    Returns a new NkMemoryStatus.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static NkMemoryStatus.Buffer calloc(int capacity)
```
    Returns a new NkMemoryStatus.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkMemoryStatus.Buffer create(int capacity)
```
    Returns a new NkMemoryStatus.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkMemoryStatus.Buffer create(long address,
                                           int capacity)
```
    Create a NkMemoryStatus.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static NkMemoryStatus.Buffer createSafe(long address,
                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static NkMemoryStatus mallocStack()
```
    Returns a new NkMemoryStatus instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static NkMemoryStatus callocStack()
```
    Returns a new NkMemoryStatus instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static NkMemoryStatus mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkMemoryStatus instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static NkMemoryStatus callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkMemoryStatus instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static NkMemoryStatus.Buffer mallocStack(int capacity)
```
    Returns a new NkMemoryStatus.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static NkMemoryStatus.Buffer callocStack(int capacity)
```
    Returns a new NkMemoryStatus.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static NkMemoryStatus.Buffer mallocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkMemoryStatus.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static NkMemoryStatus.Buffer callocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkMemoryStatus.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
  - nmemory
```
public static java.nio.ByteBuffer nmemory(long struct)
```
    Unsafe version of memory.
  - ntype
```
public static int ntype(long struct)
```
    Unsafe version of type().
  - nsize
```
public static long nsize(long struct)
```
    Unsafe version of size().
  - nallocated
```
public static long nallocated(long struct)
```
    Unsafe version of allocated().
  - nneeded
```
public static long nneeded(long struct)
```
    Unsafe version of needed().
  - ncalls
```
public static long ncalls(long struct)
```
    Unsafe version of calls().

Class NkMemoryStatus

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

MEMORY

TYPE

SIZE

ALLOCATED

NEEDED

CALLS

Constructor Detail

NkMemoryStatus

Method Detail

sizeof

memory

type

size

allocated

needed

calls

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmemory

ntype

nsize

nallocated

nneeded

ncalls