org.lwjgl.nuklear

Class NkKeyboard

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.nuklear.NkKeyboard

All Implemented Interfaces:

org.lwjgl.system.Pointer

public class NkKeyboard
extends org.lwjgl.system.Struct

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NkKeyboard.Buffer An array of NkKeyboard structs.

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALIGNOF The struct alignment in bytes.
static int	KEYS The struct member offsets.
static int	SIZEOF The struct size in bytes.
static int	TEXT The struct member offsets.
static int	TEXT_LEN The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor and Description
NkKeyboard(java.nio.ByteBuffer container) Creates a NkKeyboard instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method and Description
static NkKeyboard	create(long address) Returns a new NkKeyboard instance for the specified memory address.
static NkKeyboard.Buffer	create(long address, int capacity) Create a NkKeyboard.Buffer instance at the specified memory.
static NkKeyboard	createSafe(long address) Like create, but returns null if address is NULL.
static NkKeyboard.Buffer	createSafe(long address, int capacity) Like create, but returns null if address is NULL.
NkKey.Buffer	keys() Returns a NkKey.Buffer view of the keys field.
NkKey	keys(int index) Returns a NkKey view of the struct at the specified index of the keys field.
static NkKey.Buffer	nkeys(long struct) Unsafe version of keys().
static NkKey	nkeys(long struct, int index) Unsafe version of keys.
static int	ntext_len(long struct) Unsafe version of text_len().
static java.nio.ByteBuffer	ntext(long struct) Unsafe version of text().
static byte	ntext(long struct, int index) Unsafe version of text.
int	sizeof()
int	text_len() Returns the value of the text_len field.
java.nio.ByteBuffer	text() Returns a ByteBuffer view of the text field.
byte	text(int index) Returns the value at the specified index of the text field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

KEYS

public static final int KEYS

The struct member offsets.

TEXT

public static final int TEXT

The struct member offsets.

TEXT_LEN

public static final int TEXT_LEN

The struct member offsets.

Constructor Detail

NkKeyboard

public NkKeyboard(java.nio.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

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct

keys

public NkKey.Buffer keys()

Returns a NkKey.Buffer view of the keys field.

keys

public NkKey keys(int index)

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

text

public java.nio.ByteBuffer text()

Returns a ByteBuffer view of the text field.

text

public byte text(int index)

Returns the value at the specified index of the text field.

text_len

public int text_len()

Returns the value of the text_len field.

create

public static NkKeyboard create(long address)

Returns a new NkKeyboard instance for the specified memory address.

createSafe

@Nullable
public static NkKeyboard createSafe(long address)

Like create, but returns null if address is NULL.

create

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

Create a NkKeyboard.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

nkeys

public static NkKey.Buffer nkeys(long struct)

Unsafe version of keys().

nkeys

public static NkKey nkeys(long struct,
                          int index)

Unsafe version of keys.

ntext

public static java.nio.ByteBuffer ntext(long struct)

Unsafe version of text().

ntext

public static byte ntext(long struct,
                         int index)

Unsafe version of text.

ntext_len

public static int ntext_len(long struct)

Unsafe version of text_len().