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

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

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

Method Summary

Modifier and Type	Method and Description
public NkBuffer	Returns: a `NkBuffer` view of the `buffer` field. buffer()
public static NkStr	calloc() Returns a new `NkStr` instance allocated with `memCalloc`.
public static NkStr.Buffer	calloc(int the buffer capacity capacity) Returns a new `NkStr.Buffer` instance allocated with `memCalloc`.
public static NkStr	calloc(MemoryStack the stack from which to allocate stack) Returns a new `NkStr` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static NkStr.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `NkStr.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static NkStr	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static NkStr	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkStr.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static NkStr.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected NkStr	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 NkStr	create() Returns a new `NkStr` instance allocated with `BufferUtils`.
public static NkStr	create(long address) Returns a new `NkStr` instance for the specified memory address.
public static NkStr.Buffer	create(int the buffer capacity capacity) Returns a new `NkStr.Buffer` instance allocated with `BufferUtils`.
public static NkStr.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `NkStr.Buffer` instance at the specified memory.
public static NkStr	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static NkStr.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	len() in codepoints/runes/glyphs
public static NkStr	malloc() Returns a new `NkStr` instance allocated with `memAlloc`.
public static NkStr.Buffer	malloc(int the buffer capacity capacity) Returns a new `NkStr.Buffer` instance allocated with `memAlloc`.
public static NkStr	malloc(MemoryStack the stack from which to allocate stack) Returns a new `NkStr` instance allocated on the specified `MemoryStack`.
public static NkStr.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `NkStr.Buffer` instance allocated on the specified `MemoryStack`.
public static NkStr	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static NkStr	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkStr.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static NkStr.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkBuffer	nbuffer(long struct) Unsafe version of `buffer`.
public static int	nlen(long struct) Unsafe version of `len`.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

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

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

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

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

Constructor Detail

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

NkStr back to summary

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

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

buffer	back to summary
public NkBuffer buffer() Returns:NkBuffer a `NkBuffer` view of the `buffer` field. Annotations @NativeType:struct nk_buffer

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

calloc back to summary

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

public static NkStr.Buffer calloc(int capacity)

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

public static NkStr calloc(MemoryStack stack)

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

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

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

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

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

public static NkStr.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 NkStr 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 NkStr 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 NkStr create() Returns a new `NkStr` instance allocated with `BufferUtils`.

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

create back to summary

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

public static NkStr.Buffer create(int capacity)

Returns a new NkStr.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static NkStr createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

len	back to summary
public int len() in codepoints/runes/glyphs

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

malloc back to summary

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

public static NkStr.Buffer malloc(int capacity)

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

public static NkStr malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

nbuffer	back to summary
public static NkBuffer nbuffer(long struct) Unsafe version of `buffer`.

nlen	back to summary
public static int nlen(long struct) Unsafe version of `len`.

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

org.lwjgl.nuklear back to summary

public Class NkStr.Buffer

Class Inheritance

extends StructBuffer<NkStr, NkStr.Buffer>
implements NativeResource

All Implemented Interfaces

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

An array of NkStr structs.

Field Summary

Modifier and Type	Field and Description
private static final NkStr	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `NkStr.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 NkBuffer	Returns: a `NkBuffer` view of the `buffer` field. buffer()
protected NkStr	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `NkStr#len` field. len()
protected NkStr.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

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

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `NkStr.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 `NkStr#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

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

buffer	back to summary
public NkBuffer buffer() Returns:NkBuffer a `NkBuffer` view of the `buffer` field. Annotations @NativeType:struct nk_buffer

getElementFactory	back to summary
protected NkStr getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected NkStr getElementFactory()

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

Annotations

@Override

len	back to summary
public int len() Returns:int the value of the `NkStr#len` field.

self	back to summary
protected NkStr.Buffer self() Implements abstract org.lwjgl.system.CustomBuffer.self. Annotations @Override

self

back to summary

protected NkStr.Buffer self()

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

Annotations

@Override

public Class NkStr

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class NkStr.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail