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

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

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

Method Summary

Modifier and Type	Method and Description
public static NkCursor	calloc() Returns a new `NkCursor` instance allocated with `memCalloc`.
public static NkCursor.Buffer	calloc(int the buffer capacity capacity) Returns a new `NkCursor.Buffer` instance allocated with `memCalloc`.
public static NkCursor	calloc(MemoryStack the stack from which to allocate stack) Returns a new `NkCursor` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static NkCursor.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `NkCursor.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static NkCursor	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static NkCursor	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkCursor.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static NkCursor.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected NkCursor	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 NkCursor	create() Returns a new `NkCursor` instance allocated with `BufferUtils`.
public static NkCursor	create(long address) Returns a new `NkCursor` instance for the specified memory address.
public static NkCursor.Buffer	create(int the buffer capacity capacity) Returns a new `NkCursor.Buffer` instance allocated with `BufferUtils`.
public static NkCursor.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `NkCursor.Buffer` instance at the specified memory.
public static NkCursor	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static NkCursor.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public NkImage	Returns: a `NkImage` view of the `img` field. img()
public NkCursor	img(NkImage value) Copies the specified `NkImage` to the `img` field.
public NkCursor	img(Consumer<NkImage> consumer) Passes the `img` field to the specified `Consumer`.
public static NkCursor	malloc() Returns a new `NkCursor` instance allocated with `memAlloc`.
public static NkCursor.Buffer	malloc(int the buffer capacity capacity) Returns a new `NkCursor.Buffer` instance allocated with `memAlloc`.
public static NkCursor	malloc(MemoryStack the stack from which to allocate stack) Returns a new `NkCursor` instance allocated on the specified `MemoryStack`.
public static NkCursor.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `NkCursor.Buffer` instance allocated on the specified `MemoryStack`.
public static NkCursor	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static NkCursor	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkCursor.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static NkCursor.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkImage	nimg(long struct) Unsafe version of `img`.
public static void	nimg(long struct, NkImage value) Unsafe version of `img`.
public static NkVec2	noffset(long struct) Unsafe version of `offset`.
public static void	noffset(long struct, NkVec2 value) Unsafe version of `offset`.
public static NkVec2	nsize(long struct) Unsafe version of `size`.
public static void	nsize(long struct, NkVec2 value) Unsafe version of `size`.
public NkVec2	Returns: a `NkVec2` view of the `offset` field. offset()
public NkCursor	offset(NkVec2 value) Copies the specified `NkVec2` to the `offset` field.
public NkCursor	offset(Consumer<NkVec2> consumer) Passes the `offset` field to the specified `Consumer`.
public NkCursor	set(NkImage img, NkVec2 size, NkVec2 offset) Initializes this struct with the specified values.
public NkCursor	Returns: this struct set(NkCursor the source struct src) Copies the specified struct data to this struct.
public NkVec2	Returns: a `NkVec2` view of the `size` field. size()
public NkCursor	size(NkVec2 value) Copies the specified `NkVec2` to the `size` field.
public NkCursor	size(Consumer<NkVec2> consumer) Passes the `size` field to the specified `Consumer`.
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.

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

OFFSET	back to summary
public static final int OFFSET 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.

Constructor Detail

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

NkCursor back to summary

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

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

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

calloc back to summary

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

public static NkCursor.Buffer calloc(int capacity)

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

public static NkCursor calloc(MemoryStack stack)

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

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

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

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

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

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

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

create back to summary

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

public static NkCursor.Buffer create(int capacity)

Returns a new NkCursor.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static NkCursor createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

img	back to summary
public NkImage img() Returns:NkImage a `NkImage` view of the `img` field. Annotations @NativeType:struct nk_image

img	back to summary
public NkCursor img(NkImage value) Copies the specified `NkImage` to the `img` field.

img	back to summary
public NkCursor img(Consumer<NkImage> consumer) Passes the `img` field to the specified `Consumer`.

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

malloc back to summary

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

public static NkCursor.Buffer malloc(int capacity)

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

public static NkCursor malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

nimg	back to summary
public static NkImage nimg(long struct) Unsafe version of `img`.

nimg	back to summary
public static void nimg(long struct, NkImage value) Unsafe version of `img`.

noffset	back to summary
public static NkVec2 noffset(long struct) Unsafe version of `offset`.

noffset	back to summary
public static void noffset(long struct, NkVec2 value) Unsafe version of `offset`.

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

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

offset	back to summary
public NkVec2 offset() Returns:NkVec2 a `NkVec2` view of the `offset` field. Annotations @NativeType:struct nk_vec2

offset	back to summary
public NkCursor offset(NkVec2 value) Copies the specified `NkVec2` to the `offset` field.

offset	back to summary
public NkCursor offset(Consumer<NkVec2> consumer) Passes the `offset` field to the specified `Consumer`.

set	back to summary
public NkCursor set(NkImage img, NkVec2 size, NkVec2 offset) Initializes this struct with the specified values.

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

set

back to summary

public NkCursor set(NkCursor src)

Copies the specified struct data to this struct.

Parameters

src:NkCursor: the source struct

Returns:NkCursor

this struct

size	back to summary
public NkVec2 size() Returns:NkVec2 a `NkVec2` view of the `size` field. Annotations @NativeType:struct nk_vec2

size	back to summary
public NkCursor size(NkVec2 value) Copies the specified `NkVec2` to the `size` field.

size	back to summary
public NkCursor size(Consumer<NkVec2> consumer) Passes the `size` field to the specified `Consumer`.

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

org.lwjgl.nuklear back to summary

public Class NkCursor.Buffer

Class Inheritance

extends StructBuffer<NkCursor, NkCursor.Buffer>
implements NativeResource

All Implemented Interfaces

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

An array of NkCursor structs.

Field Summary

Modifier and Type	Field and Description
private static final NkCursor	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `NkCursor.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
protected NkCursor	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public NkImage	Returns: a `NkImage` view of the `img` field. img()
public NkCursor.Buffer	img(NkImage value) Copies the specified `NkImage` to the `img` field.
public NkCursor.Buffer	img(Consumer<NkImage> consumer) Passes the `img` field to the specified `Consumer`.
public NkVec2	Returns: a `NkVec2` view of the `offset` field. offset()
public NkCursor.Buffer	offset(NkVec2 value) Copies the specified `NkVec2` to the `offset` field.
public NkCursor.Buffer	offset(Consumer<NkVec2> consumer) Passes the `offset` field to the specified `Consumer`.
protected NkCursor.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public NkVec2	Returns: a `NkVec2` view of the `size` field. size()
public NkCursor.Buffer	size(NkVec2 value) Copies the specified `NkVec2` to the `size` field.
public NkCursor.Buffer	size(Consumer<NkVec2> consumer) Passes the `size` 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 NkCursor ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

getElementFactory

back to summary

protected NkCursor getElementFactory()

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

Annotations

@Override

img	back to summary
public NkImage img() Returns:NkImage a `NkImage` view of the `img` field. Annotations @NativeType:struct nk_image

img	back to summary
public NkCursor.Buffer img(NkImage value) Copies the specified `NkImage` to the `img` field.

img	back to summary
public NkCursor.Buffer img(Consumer<NkImage> consumer) Passes the `img` field to the specified `Consumer`.

offset	back to summary
public NkVec2 offset() Returns:NkVec2 a `NkVec2` view of the `offset` field. Annotations @NativeType:struct nk_vec2

offset	back to summary
public NkCursor.Buffer offset(NkVec2 value) Copies the specified `NkVec2` to the `offset` field.

offset	back to summary
public NkCursor.Buffer offset(Consumer<NkVec2> consumer) Passes the `offset` field to the specified `Consumer`.

self

back to summary

protected NkCursor.Buffer self()

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

Annotations

@Override

size	back to summary
public NkVec2 size() Returns:NkVec2 a `NkVec2` view of the `size` field. Annotations @NativeType:struct nk_vec2

size	back to summary
public NkCursor.Buffer size(NkVec2 value) Copies the specified `NkVec2` to the `size` field.

size	back to summary
public NkCursor.Buffer size(Consumer<NkVec2> consumer) Passes the `size` field to the specified `Consumer`.

public Class NkCursor

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class NkCursor.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail