Modifier and Type	Class and Description
public static class	NkBuffer.Buffer An array of `NkBuffer` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	ALLOCATED The struct member offsets.
public static final int	CALLS The struct member offsets.
public static final int	GROW_FACTOR The struct member offsets.
public static final int	MARKER The struct member offsets.
public static final int	MEMORY The struct member offsets.
public static final int	NEEDED The struct member offsets.
public static final int	POOL The struct member offsets.
public static final int	SIZE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	TYPE The struct member offsets.

Access	Constructor and Description
protected	NkBuffer(long address, ByteBuffer container)
public	NkBuffer(ByteBuffer container) Creates a `NkBuffer` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public long	allocated() total amount of memory allocated
public static NkBuffer	calloc() Returns a new `NkBuffer` instance allocated with `memCalloc`.
public static NkBuffer.Buffer	calloc(int the buffer capacity capacity) Returns a new `NkBuffer.Buffer` instance allocated with `memCalloc`.
public static NkBuffer	calloc(MemoryStack the stack from which to allocate stack) Returns a new `NkBuffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static NkBuffer.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `NkBuffer.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static NkBuffer	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static NkBuffer	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkBuffer.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static NkBuffer.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public long	calls() number of allocation calls
protected NkBuffer	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static NkBuffer	create() Returns a new `NkBuffer` instance allocated with `BufferUtils`.
public static NkBuffer	create(long address) Returns a new `NkBuffer` instance for the specified memory address.
public static NkBuffer.Buffer	create(int the buffer capacity capacity) Returns a new `NkBuffer.Buffer` instance allocated with `BufferUtils`.
public static NkBuffer.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `NkBuffer.Buffer` instance at the specified memory.
public static NkBuffer	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static NkBuffer.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public float	grow_factor() growing factor for dynamic memory management
public static NkBuffer	malloc() Returns a new `NkBuffer` instance allocated with `memAlloc`.
public static NkBuffer.Buffer	malloc(int the buffer capacity capacity) Returns a new `NkBuffer.Buffer` instance allocated with `memAlloc`.
public static NkBuffer	malloc(MemoryStack the stack from which to allocate stack) Returns a new `NkBuffer` instance allocated on the specified `MemoryStack`.
public static NkBuffer.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `NkBuffer.Buffer` instance allocated on the specified `MemoryStack`.
public static NkBuffer	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static NkBuffer	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkBuffer.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static NkBuffer.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public NkBufferMarker.Buffer	marker() buffer marker to free a buffer to a certain offset
public NkBufferMarker	marker(int index) buffer marker to free a buffer to a certain offset
public NkMemory	memory() memory and size of the current memory block
public static long	nallocated(long struct) Unsafe version of `allocated`.
public static long	ncalls(long struct) Unsafe version of `calls`.
public long	needed() totally consumed memory given that enough memory is present
public static float	ngrow_factor(long struct) Unsafe version of `grow_factor`.
public static NkBufferMarker.Buffer	nmarker(long struct) Unsafe version of `marker`.
public static NkBufferMarker	nmarker(long struct, int index) Unsafe version of `marker`.
public static NkMemory	nmemory(long struct) Unsafe version of `memory`.
public static long	nneeded(long struct) Unsafe version of `needed`.
public static NkAllocator	npool(long struct) Unsafe version of `pool`.
public static long	nsize(long struct) Unsafe version of `size`.
public static int	ntype(long struct) Unsafe version of `type`.
public NkAllocator	pool() allocator callback for dynamic buffers
public long	size() current size of the buffer
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	type() memory management type

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

ALLOCATED	back to summary
public static final int ALLOCATED The struct member offsets.

CALLS	back to summary
public static final int CALLS The struct member offsets.

GROW_FACTOR	back to summary
public static final int GROW_FACTOR The struct member offsets.

MARKER	back to summary
public static final int MARKER The struct member offsets.

MEMORY	back to summary
public static final int MEMORY The struct member offsets.

NEEDED	back to summary
public static final int NEEDED The struct member offsets.

POOL	back to summary
public static final int POOL The struct member offsets.

SIZE	back to summary
public static final int SIZE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

TYPE	back to summary
public static final int TYPE The struct member offsets.

Constructor Detail

NkBuffer	back to summary
protected NkBuffer(long address, ByteBuffer container)

NkBuffer back to summary

NkBuffer	back to summary
public NkBuffer(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.

public NkBuffer(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

allocated	back to summary
public long allocated() total amount of memory allocated Annotations @NativeType:nk_size

allocated

back to summary

public long allocated()

total amount of memory allocated

Annotations

@NativeType:nk_size

calloc	back to summary
public static NkBuffer calloc() Returns a new `NkBuffer` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static NkBuffer.Buffer calloc(int capacity) Returns a new `NkBuffer.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static NkBuffer.Buffer calloc(int capacity)

Returns a new NkBuffer.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static NkBuffer calloc(MemoryStack stack) Returns a new `NkBuffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static NkBuffer calloc(MemoryStack stack)

Returns a new NkBuffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static NkBuffer.Buffer calloc(int capacity, MemoryStack stack) Returns a new `NkBuffer.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static NkBuffer.Buffer calloc(int capacity, MemoryStack stack)

Returns a new NkBuffer.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

callocStack back to summary

callocStack	back to summary
public static NkBuffer callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static NkBuffer callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static NkBuffer callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static NkBuffer callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static NkBuffer.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static NkBuffer.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static NkBuffer.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static NkBuffer.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

calls	back to summary
public long calls() number of allocation calls Annotations @NativeType:nk_size

calls

back to summary

public long calls()

number of allocation calls

Annotations

@NativeType:nk_size

create back to summary

create	back to summary
protected NkBuffer create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected NkBuffer create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static NkBuffer create() Returns a new `NkBuffer` instance allocated with `BufferUtils`.

create	back to summary
public static NkBuffer create(long address) Returns a new `NkBuffer` instance for the specified memory address.

create back to summary

create	back to summary
public static NkBuffer.Buffer create(int capacity) Returns a new `NkBuffer.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static NkBuffer.Buffer create(int capacity)

Returns a new NkBuffer.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static NkBuffer.Buffer create(long address, int capacity) Create a `NkBuffer.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static NkBuffer.Buffer create(long address, int capacity)

Create a NkBuffer.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static NkBuffer createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static NkBuffer createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static NkBuffer.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static NkBuffer.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations

@Nullable

grow_factor	back to summary
public float grow_factor() growing factor for dynamic memory management

malloc	back to summary
public static NkBuffer malloc() Returns a new `NkBuffer` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static NkBuffer.Buffer malloc(int capacity) Returns a new `NkBuffer.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static NkBuffer.Buffer malloc(int capacity)

Returns a new NkBuffer.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static NkBuffer malloc(MemoryStack stack) Returns a new `NkBuffer` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static NkBuffer malloc(MemoryStack stack)

Returns a new NkBuffer instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static NkBuffer.Buffer malloc(int capacity, MemoryStack stack) Returns a new `NkBuffer.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static NkBuffer.Buffer malloc(int capacity, MemoryStack stack)

Returns a new NkBuffer.Buffer instance allocated on the specified MemoryStack.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static NkBuffer mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static NkBuffer mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static NkBuffer mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static NkBuffer mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static NkBuffer.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static NkBuffer.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static NkBuffer.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static NkBuffer.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

marker	back to summary
public NkBufferMarker.Buffer marker() buffer marker to free a buffer to a certain offset Annotations @NativeType:struct nk_buffer_marker[2]

marker

back to summary

public NkBufferMarker.Buffer marker()

buffer marker to free a buffer to a certain offset

Annotations

@NativeType:struct nk_buffer_marker[2]

marker	back to summary
public NkBufferMarker marker(int index) buffer marker to free a buffer to a certain offset Annotations @NativeType:struct nk_buffer_marker

marker

back to summary

public NkBufferMarker marker(int index)

buffer marker to free a buffer to a certain offset

Annotations

@NativeType:struct nk_buffer_marker

memory	back to summary
public NkMemory memory() memory and size of the current memory block Annotations @NativeType:struct nk_memory

memory

back to summary

public NkMemory memory()

memory and size of the current memory block

Annotations

@NativeType:struct nk_memory

nallocated	back to summary
public static long nallocated(long struct) Unsafe version of `allocated`.

ncalls	back to summary
public static long ncalls(long struct) Unsafe version of `calls`.

needed	back to summary
public long needed() totally consumed memory given that enough memory is present Annotations @NativeType:nk_size

needed

back to summary

public long needed()

totally consumed memory given that enough memory is present

Annotations

@NativeType:nk_size

ngrow_factor	back to summary
public static float ngrow_factor(long struct) Unsafe version of `grow_factor`.

nmarker	back to summary
public static NkBufferMarker.Buffer nmarker(long struct) Unsafe version of `marker`.

nmarker	back to summary
public static NkBufferMarker nmarker(long struct, int index) Unsafe version of `marker`.

nmemory	back to summary
public static NkMemory nmemory(long struct) Unsafe version of `memory`.

nneeded	back to summary
public static long nneeded(long struct) Unsafe version of `needed`.

npool	back to summary
public static NkAllocator npool(long struct) Unsafe version of `pool`.

nsize	back to summary
public static long nsize(long struct) Unsafe version of `size`.

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

pool

back to summary

public NkAllocator pool()

allocator callback for dynamic buffers

Annotations

@NativeType:struct nk_allocator

size

back to summary

public long size()

current size of the buffer

Annotations

@NativeType:nk_size

sizeof back to summary

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

type

back to summary

public int type()

memory management type

Annotations

@NativeType:enum nk_allocation_type

org.lwjgl.nuklear back to summary

public Class NkBuffer.Buffer

Class Inheritance

extends StructBuffer<NkBuffer, NkBuffer.Buffer>
implements NativeResource

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of NkBuffer structs.

Field Summary

Modifier and Type	Field and Description
private static final NkBuffer	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `NkBuffer.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
public long	Returns: the value of the `NkBuffer#allocated` field. allocated()
public long	Returns: the value of the `NkBuffer#calls` field. calls()
protected NkBuffer	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public float	Returns: the value of the `NkBuffer#grow_factor` field. grow_factor()
public NkBufferMarker.Buffer	Returns: a `NkBufferMarker`.Buffer view of the `NkBuffer#marker` field. marker()
public NkBufferMarker	Returns: a `NkBufferMarker` view of the struct at the specified index of the `NkBuffer#marker` field. marker(int index)
public NkMemory	Returns: a `NkMemory` view of the `NkBuffer#memory` field. memory()
public long	Returns: the value of the `NkBuffer#needed` field. needed()
public NkAllocator	Returns: a `NkAllocator` view of the `NkBuffer#pool` field. pool()
protected NkBuffer.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `NkBuffer#size` field. size()
public int	Returns: the value of the `NkBuffer#type` field. type()

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final NkBuffer ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new NkBuffer.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by NkBuffer#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

allocated	back to summary
public long allocated() Returns:long the value of the `NkBuffer#allocated` field. Annotations @NativeType:nk_size

calls	back to summary
public long calls() Returns:long the value of the `NkBuffer#calls` field. Annotations @NativeType:nk_size

getElementFactory

back to summary

protected NkBuffer getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

grow_factor	back to summary
public float grow_factor() Returns:float the value of the `NkBuffer#grow_factor` field.

marker	back to summary
public NkBufferMarker.Buffer marker() Returns:NkBufferMarker.Buffer a `NkBufferMarker`.Buffer view of the `NkBuffer#marker` field. Annotations @NativeType:struct nk_buffer_marker[2]

marker	back to summary
public NkBufferMarker marker(int index) Returns:NkBufferMarker a `NkBufferMarker` view of the struct at the specified index of the `NkBuffer#marker` field. Annotations @NativeType:struct nk_buffer_marker

memory	back to summary
public NkMemory memory() Returns:NkMemory a `NkMemory` view of the `NkBuffer#memory` field. Annotations @NativeType:struct nk_memory

needed	back to summary
public long needed() Returns:long the value of the `NkBuffer#needed` field. Annotations @NativeType:nk_size

pool	back to summary
public NkAllocator pool() Returns:NkAllocator a `NkAllocator` view of the `NkBuffer#pool` field. Annotations @NativeType:struct nk_allocator

self

back to summary

protected NkBuffer.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

size	back to summary
public long size() Returns:long the value of the `NkBuffer#size` field. Annotations @NativeType:nk_size

type	back to summary
public int type() Returns:int the value of the `NkBuffer#type` field. Annotations @NativeType:enum nk_allocation_type

public Class NkBuffer

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class NkBuffer.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail