Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkKey

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

Layout


struct nk_key {
    nk_bool down;
    unsigned int clicked;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NkKey.Buffer

An array of NkKey structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CLICKED

The struct member offsets.

public static final int
DOWN

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
NkKey(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the clicked field.
clicked
()

protected NkKey
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 NkKey
create(long address)

Returns a new NkKey instance for the specified memory address.

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

Create a NkKey.Buffer instance at the specified memory.

public static NkKey
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean

Returns:

the value of the down field.
down
()

public static int
nclicked(long struct)

Unsafe version of clicked.

public static boolean
ndown(long struct)

Unsafe version of down.

public int
sizeof()

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

Returns sizeof(struct).
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.

CLICKEDback to summary
public static final int CLICKED

The struct member offsets.

DOWNback to summary
public static final int DOWN

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

NkKeyback to summary
protected NkKey(long address, ByteBuffer container)
NkKeyback to summary
public NkKey(ByteBuffer container)

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

clickedback to summary
public int clicked()
Returns:int

the value of the clicked field.

Annotations
@NativeType:unsigned int
createback to summary
protected NkKey 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 NkKey create(long address)

Returns a new NkKey instance for the specified memory address.

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

Create a NkKey.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkKey createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
downback to summary
public boolean down()
Returns:boolean

the value of the down field.

Annotations
@NativeType:nk_bool
nclickedback to summary
public static int nclicked(long struct)

Unsafe version of clicked.

ndownback to summary
public static boolean ndown(long struct)

Unsafe version of down.

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
org.lwjgl.nuklear back to summary

public Class NkKey.Buffer

extends StructBuffer<NkKey, NkKey.Buffer>
Class Inheritance

An array of NkKey structs.

Field Summary

Modifier and TypeField and Description
private static final NkKey

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkKey.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
public int

Returns:

the value of the clicked field.
clicked
()

public boolean

Returns:

the value of the down field.
down
()

protected NkKey
protected NkKey.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final NkKey ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

clickedback to summary
public int clicked()
Returns:int

the value of the clicked field.

Annotations
@NativeType:unsigned int
downback to summary
public boolean down()
Returns:boolean

the value of the down field.

Annotations
@NativeType:nk_bool
getElementFactoryback to summary
protected NkKey getElementFactory()

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

Annotations
@Override
selfback to summary
protected NkKey.Buffer self()

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

Annotations
@Override