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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	ALLOC The struct member offsets.
public static final int	MFREE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	USERDATA The struct member offsets.

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

Method Summary

Modifier and Type	Method and Description
public NkPluginAlloc	Returns: the value of the `alloc` field. alloc()
public NkAllocator	alloc(NkPluginAllocI value) Sets the specified value to the `alloc` field.
public static NkAllocator	calloc() Returns a new `NkAllocator` instance allocated with `memCalloc`.
public static NkAllocator.Buffer	calloc(int the buffer capacity capacity) Returns a new `NkAllocator.Buffer` instance allocated with `memCalloc`.
public static NkAllocator	calloc(MemoryStack the stack from which to allocate stack) Returns a new `NkAllocator` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static NkAllocator.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `NkAllocator.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static NkAllocator	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static NkAllocator	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkAllocator.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static NkAllocator.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected NkAllocator	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 NkAllocator	create() Returns a new `NkAllocator` instance allocated with `BufferUtils`.
public static NkAllocator	create(long address) Returns a new `NkAllocator` instance for the specified memory address.
public static NkAllocator.Buffer	create(int the buffer capacity capacity) Returns a new `NkAllocator.Buffer` instance allocated with `BufferUtils`.
public static NkAllocator.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `NkAllocator.Buffer` instance at the specified memory.
public static NkAllocator	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static NkAllocator.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static NkAllocator	malloc() Returns a new `NkAllocator` instance allocated with `memAlloc`.
public static NkAllocator.Buffer	malloc(int the buffer capacity capacity) Returns a new `NkAllocator.Buffer` instance allocated with `memAlloc`.
public static NkAllocator	malloc(MemoryStack the stack from which to allocate stack) Returns a new `NkAllocator` instance allocated on the specified `MemoryStack`.
public static NkAllocator.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `NkAllocator.Buffer` instance allocated on the specified `MemoryStack`.
public static NkAllocator	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static NkAllocator	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkAllocator.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static NkAllocator.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public NkPluginFree	Returns: the value of the `mfree` field. mfree()
public NkAllocator	mfree(NkPluginFreeI value) Sets the specified value to the `mfree` field.
public static NkPluginAlloc	nalloc(long struct) Unsafe version of `alloc`.
public static void	nalloc(long struct, NkPluginAllocI value) Unsafe version of `alloc`.
public static NkPluginFree	nmfree(long struct) Unsafe version of `mfree`.
public static void	nmfree(long struct, NkPluginFreeI value) Unsafe version of `mfree`.
public static NkHandle	nuserdata(long struct) Unsafe version of `userdata`.
public static void	nuserdata(long struct, NkHandle value) Unsafe version of `userdata`.
public NkAllocator	set(NkHandle userdata, NkPluginAllocI alloc, NkPluginFreeI mfree) Initializes this struct with the specified values.
public NkAllocator	Returns: this struct set(NkAllocator the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public NkHandle	Returns: a `NkHandle` view of the `userdata` field. userdata()
public NkAllocator	userdata(NkHandle value) Copies the specified `NkHandle` to the `userdata` field.
public NkAllocator	userdata(Consumer<NkHandle> consumer) Passes the `userdata` field to the specified `Consumer`.

Field Detail

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

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

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

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

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

Constructor Detail

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

NkAllocator back to summary

NkAllocator	back to summary
public NkAllocator(ByteBuffer container) Creates a `NkAllocator` 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 NkAllocator(ByteBuffer container)

Creates a NkAllocator 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

alloc	back to summary
public NkPluginAlloc alloc() Returns:NkPluginAlloc the value of the `alloc` field. Annotations @Nullable @NativeType:nk_plugin_alloc

alloc	back to summary
public NkAllocator alloc(NkPluginAllocI value) Sets the specified value to the `alloc` field.

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

calloc back to summary

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

public static NkAllocator.Buffer calloc(int capacity)

Returns a new NkAllocator.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 NkAllocator calloc(MemoryStack stack) Returns a new `NkAllocator` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static NkAllocator calloc(MemoryStack stack)

Returns a new NkAllocator 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 NkAllocator.Buffer calloc(int capacity, MemoryStack stack) Returns a new `NkAllocator.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 NkAllocator.Buffer calloc(int capacity, MemoryStack stack)

Returns a new NkAllocator.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 NkAllocator callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static NkAllocator 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 NkAllocator callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static NkAllocator 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 NkAllocator.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static NkAllocator.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 NkAllocator.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected NkAllocator 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 NkAllocator 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 NkAllocator create() Returns a new `NkAllocator` instance allocated with `BufferUtils`.

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

create back to summary

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

public static NkAllocator.Buffer create(int capacity)

Returns a new NkAllocator.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a NkAllocator.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 NkAllocator createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static NkAllocator createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

malloc back to summary

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

public static NkAllocator.Buffer malloc(int capacity)

Returns a new NkAllocator.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 NkAllocator malloc(MemoryStack stack) Returns a new `NkAllocator` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static NkAllocator malloc(MemoryStack stack)

Returns a new NkAllocator 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 NkAllocator.Buffer malloc(int capacity, MemoryStack stack) Returns a new `NkAllocator.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

Returns a new NkAllocator.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 NkAllocator mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static NkAllocator 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 NkAllocator mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static NkAllocator 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 NkAllocator.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static NkAllocator.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 NkAllocator.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

mfree	back to summary
public NkPluginFree mfree() Returns:NkPluginFree the value of the `mfree` field. Annotations @Nullable @NativeType:nk_plugin_free

mfree	back to summary
public NkAllocator mfree(NkPluginFreeI value) Sets the specified value to the `mfree` field.

nalloc back to summary

nalloc	back to summary
public static NkPluginAlloc nalloc(long struct) Unsafe version of `alloc`. Annotations @Nullable

public static NkPluginAlloc nalloc(long struct)

Unsafe version of alloc.

Annotations

@Nullable

nalloc	back to summary
public static void nalloc(long struct, NkPluginAllocI value) Unsafe version of `alloc`.

nmfree back to summary

nmfree	back to summary
public static NkPluginFree nmfree(long struct) Unsafe version of `mfree`. Annotations @Nullable

public static NkPluginFree nmfree(long struct)

Unsafe version of mfree.

Annotations

@Nullable

nmfree	back to summary
public static void nmfree(long struct, NkPluginFreeI value) Unsafe version of `mfree`.

nuserdata	back to summary
public static NkHandle nuserdata(long struct) Unsafe version of `userdata`.

nuserdata	back to summary
public static void nuserdata(long struct, NkHandle value) Unsafe version of `userdata`.

set	back to summary
public NkAllocator set(NkHandle userdata, NkPluginAllocI alloc, NkPluginFreeI mfree) Initializes this struct with the specified values.

set	back to summary
public NkAllocator set(NkAllocator src) Copies the specified struct data to this struct. Parameters src:NkAllocator the source struct Returns:NkAllocator this struct

set

back to summary

public NkAllocator set(NkAllocator src)

Copies the specified struct data to this struct.

Parameters

src:NkAllocator: the source struct

Returns:NkAllocator

this struct

sizeof back to summary

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

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

userdata	back to summary
public NkHandle userdata() Returns:NkHandle a `NkHandle` view of the `userdata` field. Annotations @NativeType:nk_handle

userdata	back to summary
public NkAllocator userdata(NkHandle value) Copies the specified `NkHandle` to the `userdata` field.

userdata	back to summary
public NkAllocator userdata(Consumer<NkHandle> consumer) Passes the `userdata` field to the specified `Consumer`.

org.lwjgl.nuklear back to summary

public Class NkAllocator.Buffer

Class Inheritance

extends StructBuffer<NkAllocator, NkAllocator.Buffer>
implements NativeResource

All Implemented Interfaces

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

An array of NkAllocator structs.

Field Summary

Modifier and Type	Field and Description
private static final NkAllocator	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `NkAllocator.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 NkPluginAlloc	Returns: the value of the `alloc` field. alloc()
public NkAllocator.Buffer	alloc(NkPluginAllocI value) Sets the specified value to the `alloc` field.
protected NkAllocator	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public NkPluginFree	Returns: the value of the `mfree` field. mfree()
public NkAllocator.Buffer	mfree(NkPluginFreeI value) Sets the specified value to the `mfree` field.
protected NkAllocator.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public NkHandle	Returns: a `NkHandle` view of the `userdata` field. userdata()
public NkAllocator.Buffer	userdata(NkHandle value) Copies the specified `NkHandle` to the `userdata` field.
public NkAllocator.Buffer	userdata(Consumer<NkHandle> consumer) Passes the `userdata` field to the specified `Consumer`.

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 NkAllocator ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new NkAllocator.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 NkAllocator#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

alloc	back to summary
public NkPluginAlloc alloc() Returns:NkPluginAlloc the value of the `alloc` field. Annotations @Nullable @NativeType:nk_plugin_alloc

alloc	back to summary
public NkAllocator.Buffer alloc(NkPluginAllocI value) Sets the specified value to the `alloc` field.

getElementFactory

back to summary

protected NkAllocator getElementFactory()

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

Annotations

@Override

mfree	back to summary
public NkPluginFree mfree() Returns:NkPluginFree the value of the `mfree` field. Annotations @Nullable @NativeType:nk_plugin_free

mfree	back to summary
public NkAllocator.Buffer mfree(NkPluginFreeI value) Sets the specified value to the `mfree` field.

self

back to summary

protected NkAllocator.Buffer self()

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

Annotations

@Override

userdata	back to summary
public NkHandle userdata() Returns:NkHandle a `NkHandle` view of the `userdata` field. Annotations @NativeType:nk_handle

userdata	back to summary
public NkAllocator.Buffer userdata(NkHandle value) Copies the specified `NkHandle` to the `userdata` field.

userdata	back to summary
public NkAllocator.Buffer userdata(Consumer<NkHandle> consumer) Passes the `userdata` field to the specified `Consumer`.

public Class NkAllocator

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class NkAllocator.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail