NkBuffer (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class NkBuffer
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Member documentation
- marker[2] – buffer marker to free a buffer to a certain offset
- pool – allocator callback for dynamic buffers
- type – memory management type
- memory – memory and size of the current memory block
- grow_factor – growing factor for dynamic memory management
- allocated – total amount of memory allocated
- needed – totally consumed memory given that enough memory is present
- calls – number of allocation calls
- size – current size of the buffer
Layout
```
 struct nk_buffer {
     struct nk_buffer_marker marker[2];
     struct nk_allocator pool;
     enum nk_allocation_type type;
     struct nk_memory memory;
     float grow_factor;
     nk_size allocated;
     nk_size needed;
     nk_size calls;
     nk_size size;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NkBuffer.Buffer
An array of NkBuffer 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`	`NkBuffer.Buffer` An array of `NkBuffer` 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`	`GROW_FACTOR` The struct member offsets.
`static int`	`MARKER` The struct member offsets.
`static int`	`MEMORY` The struct member offsets.
`static int`	`NEEDED` The struct member offsets.
`static int`	`POOL` 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

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

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

Class NkBuffer

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

MARKER

POOL

TYPE

MEMORY

GROW_FACTOR

ALLOCATED

NEEDED

CALLS

SIZE

Constructor Detail

NkBuffer

Method Detail

sizeof

marker

marker

pool

type

memory

grow_factor

allocated

needed

calls

size

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmarker

nmarker

npool

ntype

nmemory

ngrow_factor

nallocated

nneeded

ncalls

nsize