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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	H The struct member offsets.
public static final int	HANDLE The struct member offsets.
public static final int	REGION The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	W The struct member offsets.

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

Method Summary

Modifier and Type	Method and Description
public static NkImage	calloc() Returns a new `NkImage` instance allocated with `memCalloc`.
public static NkImage.Buffer	calloc(int the buffer capacity capacity) Returns a new `NkImage.Buffer` instance allocated with `memCalloc`.
public static NkImage	calloc(MemoryStack the stack from which to allocate stack) Returns a new `NkImage` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static NkImage.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `NkImage.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static NkImage	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static NkImage	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkImage.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static NkImage.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected NkImage	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 NkImage	create() Returns a new `NkImage` instance allocated with `BufferUtils`.
public static NkImage	create(long address) Returns a new `NkImage` instance for the specified memory address.
public static NkImage.Buffer	create(int the buffer capacity capacity) Returns a new `NkImage.Buffer` instance allocated with `BufferUtils`.
public static NkImage.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `NkImage.Buffer` instance at the specified memory.
public static NkImage	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static NkImage.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public short	Returns: the value of the `h` field. h()
public NkImage	h(short value) Sets the specified value to the `h` field.
public NkHandle	Returns: a `NkHandle` view of the `handle` field. handle()
public NkImage	handle(NkHandle value) Copies the specified `NkHandle` to the `handle` field.
public NkImage	handle(Consumer<NkHandle> consumer) Passes the `handle` field to the specified `Consumer`.
public static NkImage	malloc() Returns a new `NkImage` instance allocated with `memAlloc`.
public static NkImage.Buffer	malloc(int the buffer capacity capacity) Returns a new `NkImage.Buffer` instance allocated with `memAlloc`.
public static NkImage	malloc(MemoryStack the stack from which to allocate stack) Returns a new `NkImage` instance allocated on the specified `MemoryStack`.
public static NkImage.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `NkImage.Buffer` instance allocated on the specified `MemoryStack`.
public static NkImage	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static NkImage	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static NkImage.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static NkImage.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static short	nh(long struct) Unsafe version of `h`.
public static void	nh(long struct, short value) Unsafe version of `h`.
public static NkHandle	nhandle(long struct) Unsafe version of `handle`.
public static void	nhandle(long struct, NkHandle value) Unsafe version of `handle`.
public static ShortBuffer	nregion(long struct) Unsafe version of `region`.
public static short	nregion(long struct, int index) Unsafe version of `region`.
public static void	nregion(long struct, ShortBuffer value) Unsafe version of `region`.
public static void	nregion(long struct, int index, short value) Unsafe version of `region`.
public static short	nw(long struct) Unsafe version of `w`.
public static void	nw(long struct, short value) Unsafe version of `w`.
public ShortBuffer	Returns: a `ShortBuffer` view of the `region` field. region()
public short	Returns: the value at the specified index of the `region` field. region(int index)
public NkImage	region(ShortBuffer value) Copies the specified `ShortBuffer` to the `region` field.
public NkImage	region(int index, short value) Sets the specified value at the specified index of the `region` field.
public NkImage	set(NkHandle handle, short w, short h, ShortBuffer region) Initializes this struct with the specified values.
public NkImage	Returns: this struct set(NkImage 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 short	Returns: the value of the `w` field. w()
public NkImage	w(short value) Sets the specified value to the `w` field.

Field Detail

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

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

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

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

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

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

Constructor Detail

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

NkImage back to summary

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

Creates a NkImage 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 NkImage calloc() Returns a new `NkImage` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

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

public static NkImage.Buffer calloc(int capacity)

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

public static NkImage calloc(MemoryStack stack)

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

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

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

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

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

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

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

create back to summary

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

public static NkImage.Buffer create(int capacity)

Returns a new NkImage.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static NkImage createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

h	back to summary
public short h() Returns:short the value of the `h` field. Annotations @NativeType:nk_ushort

h	back to summary
public NkImage h(short value) Sets the specified value to the `h` field.

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

handle	back to summary
public NkImage handle(NkHandle value) Copies the specified `NkHandle` to the `handle` field.

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

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

malloc back to summary

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

public static NkImage.Buffer malloc(int capacity)

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

public static NkImage malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

nh	back to summary
public static short nh(long struct) Unsafe version of `h`.

nh	back to summary
public static void nh(long struct, short value) Unsafe version of `h`.

nhandle	back to summary
public static NkHandle nhandle(long struct) Unsafe version of `handle`.

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

nregion	back to summary
public static ShortBuffer nregion(long struct) Unsafe version of `region`.

nregion	back to summary
public static short nregion(long struct, int index) Unsafe version of `region`.

nregion	back to summary
public static void nregion(long struct, ShortBuffer value) Unsafe version of `region`.

nregion	back to summary
public static void nregion(long struct, int index, short value) Unsafe version of `region`.

nw	back to summary
public static short nw(long struct) Unsafe version of `w`.

nw	back to summary
public static void nw(long struct, short value) Unsafe version of `w`.

region	back to summary
public ShortBuffer region() Returns:ShortBuffer a `ShortBuffer` view of the `region` field. Annotations @NativeType:nk_ushort[4]

region	back to summary
public short region(int index) Returns:short the value at the specified index of the `region` field. Annotations @NativeType:nk_ushort

region	back to summary
public NkImage region(ShortBuffer value) Copies the specified `ShortBuffer` to the `region` field.

region	back to summary
public NkImage region(int index, short value) Sets the specified value at the specified index of the `region` field.

set	back to summary
public NkImage set(NkHandle handle, short w, short h, ShortBuffer region) Initializes this struct with the specified values.

set

back to summary

public NkImage set(NkImage src)

Copies the specified struct data to this struct.

Parameters

src:NkImage: the source struct

Returns:NkImage

this struct

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

w	back to summary
public short w() Returns:short the value of the `w` field. Annotations @NativeType:nk_ushort

w	back to summary
public NkImage w(short value) Sets the specified value to the `w` field.

org.lwjgl.nuklear back to summary

public Class NkImage.Buffer

Class Inheritance

extends StructBuffer<NkImage, NkImage.Buffer>
implements NativeResource

All Implemented Interfaces

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

An array of NkImage structs.

Field Summary

Modifier and Type	Field and Description
private static final NkImage	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `NkImage.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 NkImage	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public short	Returns: the value of the `h` field. h()
public NkImage.Buffer	h(short value) Sets the specified value to the `h` field.
public NkHandle	Returns: a `NkHandle` view of the `handle` field. handle()
public NkImage.Buffer	handle(NkHandle value) Copies the specified `NkHandle` to the `handle` field.
public NkImage.Buffer	handle(Consumer<NkHandle> consumer) Passes the `handle` field to the specified `Consumer`.
public ShortBuffer	Returns: a `ShortBuffer` view of the `region` field. region()
public short	Returns: the value at the specified index of the `region` field. region(int index)
public NkImage.Buffer	region(ShortBuffer value) Copies the specified `ShortBuffer` to the `region` field.
public NkImage.Buffer	region(int index, short value) Sets the specified value at the specified index of the `region` field.
protected NkImage.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public short	Returns: the value of the `w` field. w()
public NkImage.Buffer	w(short value) Sets the specified value to the `w` field.

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

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new NkImage.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 NkImage#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 NkImage getElementFactory()

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

Annotations

@Override

h	back to summary
public short h() Returns:short the value of the `h` field. Annotations @NativeType:nk_ushort

h	back to summary
public NkImage.Buffer h(short value) Sets the specified value to the `h` field.

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

handle	back to summary
public NkImage.Buffer handle(NkHandle value) Copies the specified `NkHandle` to the `handle` field.

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

region	back to summary
public ShortBuffer region() Returns:ShortBuffer a `ShortBuffer` view of the `region` field. Annotations @NativeType:nk_ushort[4]

region	back to summary
public short region(int index) Returns:short the value at the specified index of the `region` field. Annotations @NativeType:nk_ushort

region	back to summary
public NkImage.Buffer region(ShortBuffer value) Copies the specified `ShortBuffer` to the `region` field.

region	back to summary
public NkImage.Buffer region(int index, short value) Sets the specified value at the specified index of the `region` field.

self

back to summary

protected NkImage.Buffer self()

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

Annotations

@Override

w	back to summary
public short w() Returns:short the value of the `w` field. Annotations @NativeType:nk_ushort

w	back to summary
public NkImage.Buffer w(short value) Sets the specified value to the `w` field.

public Class NkImage

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class NkImage.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail