Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkKeyboard

extends Struct<NkKeyboard>
Class Inheritance
Annotations
@NativeType:struct nk_keyboard
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Layout


struct nk_keyboard {
    struct nk_key keys[NK_KEY_MAX];
    char text[NK_INPUT_MAX];
    int text_len;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NkKeyboard.Buffer

An array of NkKeyboard structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
KEYS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TEXT

The struct member offsets.

public static final int
TEXT_LEN

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
NkKeyboard(long address, ByteBuffer container)

public
NkKeyboard(ByteBuffer container)

Creates a NkKeyboard instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
protected NkKeyboard
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 NkKeyboard
create(long address)

Returns a new NkKeyboard instance for the specified memory address.

public static NkKeyboard.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a NkKeyboard.Buffer instance at the specified memory.

public static NkKeyboard
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public NkKey.Buffer

Returns:

a NkKey.Buffer view of the keys field.
keys
()

public NkKey

Returns:

a NkKey view of the struct at the specified index of the keys field.
keys
(int index)

public static NkKey.Buffer
nkeys(long struct)

Unsafe version of keys.

public static NkKey
nkeys(long struct, int index)

Unsafe version of keys.

public static ByteBuffer
ntext(long struct)

Unsafe version of text.

public static byte
ntext(long struct, int index)

Unsafe version of text.

public static int
ntext_len(long struct)

Unsafe version of text_len.

public int
sizeof()

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

Returns sizeof(struct).
public ByteBuffer

Returns:

a ByteBuffer view of the text field.
text
()

public byte

Returns:

the value at the specified index of the text field.
text
(int index)

public int

Returns:

the value of the text_len field.
text_len
()

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

KEYSback to summary
public static final int KEYS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TEXTback to summary
public static final int TEXT

The struct member offsets.

TEXT_LENback to summary
public static final int TEXT_LEN

The struct member offsets.

Constructor Detail

NkKeyboardback to summary
protected NkKeyboard(long address, ByteBuffer container)
NkKeyboardback to summary
public NkKeyboard(ByteBuffer container)

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

createback to summary
protected NkKeyboard 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
createback to summary
public static NkKeyboard create(long address)

Returns a new NkKeyboard instance for the specified memory address.

createback to summary
public static NkKeyboard.Buffer create(long address, int capacity)

Create a NkKeyboard.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkKeyboard createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static NkKeyboard.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
keysback to summary
public NkKey.Buffer keys()
Returns:NkKey.Buffer

a NkKey.Buffer view of the keys field.

Annotations
@NativeType:struct nk_key[NK_KEY_MAX]
keysback to summary
public NkKey keys(int index)
Returns:NkKey

a NkKey view of the struct at the specified index of the keys field.

Annotations
@NativeType:struct nk_key
nkeysback to summary
public static NkKey.Buffer nkeys(long struct)

Unsafe version of keys.

nkeysback to summary
public static NkKey nkeys(long struct, int index)

Unsafe version of keys.

ntextback to summary
public static ByteBuffer ntext(long struct)

Unsafe version of text.

ntextback to summary
public static byte ntext(long struct, int index)

Unsafe version of text.

ntext_lenback to summary
public static int ntext_len(long struct)

Unsafe version of text_len.

sizeofback to summary
public int sizeof()

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

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

Returns sizeof(struct).

Annotations
@Override
textback to summary
public ByteBuffer text()
Returns:ByteBuffer

a ByteBuffer view of the text field.

Annotations
@NativeType:char[NK_INPUT_MAX]
textback to summary
public byte text(int index)
Returns:byte

the value at the specified index of the text field.

Annotations
@NativeType:char
text_lenback to summary
public int text_len()
Returns:int

the value of the text_len field.

org.lwjgl.nuklear back to summary

public Class NkKeyboard.Buffer

extends StructBuffer<NkKeyboard, NkKeyboard.Buffer>
Class Inheritance

An array of NkKeyboard structs.

Field Summary

Modifier and TypeField and Description
private static final NkKeyboard

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkKeyboard.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 TypeMethod and Description
protected NkKeyboard
public NkKey.Buffer

Returns:

a NkKey.Buffer view of the keys field.
keys
()

public NkKey

Returns:

a NkKey view of the struct at the specified index of the keys field.
keys
(int index)

protected NkKeyboard.Buffer
public ByteBuffer

Returns:

a ByteBuffer view of the text field.
text
()

public byte

Returns:

the value at the specified index of the text field.
text
(int index)

public int

Returns:

the value of the text_len field.
text_len
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final NkKeyboard ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new NkKeyboard.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 NkKeyboard#SIZEOF, and its mark will be undefined.

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

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

Method Detail

getElementFactoryback to summary
protected NkKeyboard getElementFactory()

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

Annotations
@Override
keysback to summary
public NkKey.Buffer keys()
Returns:NkKey.Buffer

a NkKey.Buffer view of the keys field.

Annotations
@NativeType:struct nk_key[NK_KEY_MAX]
keysback to summary
public NkKey keys(int index)
Returns:NkKey

a NkKey view of the struct at the specified index of the keys field.

Annotations
@NativeType:struct nk_key
selfback to summary
protected NkKeyboard.Buffer self()

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

Annotations
@Override
textback to summary
public ByteBuffer text()
Returns:ByteBuffer

a ByteBuffer view of the text field.

Annotations
@NativeType:char[NK_INPUT_MAX]
textback to summary
public byte text(int index)
Returns:byte

the value at the specified index of the text field.

Annotations
@NativeType:char
text_lenback to summary
public int text_len()
Returns:int

the value of the text_len field.