Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkInput

extends Struct<NkInput>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct nk_input
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct nk_input {
    struct nk_keyboard keyboard;
    struct nk_mouse mouse;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NkInput.Buffer

An array of NkInput structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
KEYBOARD

The struct member offsets.

public static final int
MOUSE

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
NkInput(long address, ByteBuffer container)

public
NkInput(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static NkInput
calloc()

Returns a new NkInput instance allocated with memCalloc.

public static NkInput.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new NkInput.Buffer instance allocated with memCalloc.

public static NkInput
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new NkInput instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static NkInput.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new NkInput.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static NkInput
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static NkInput
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static NkInput.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static NkInput.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected NkInput
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 NkInput
create()

Returns a new NkInput instance allocated with BufferUtils.

public static NkInput
create(long address)

Returns a new NkInput instance for the specified memory address.

public static NkInput.Buffer
create(int
the buffer capacity
capacity
)

Returns a new NkInput.Buffer instance allocated with BufferUtils.

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

Create a NkInput.Buffer instance at the specified memory.

public static NkInput
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public NkKeyboard

Returns:

a NkKeyboard view of the keyboard field.
keyboard
()

public static NkInput
malloc()

Returns a new NkInput instance allocated with memAlloc.

public static NkInput.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new NkInput.Buffer instance allocated with memAlloc.

public static NkInput
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new NkInput instance allocated on the specified MemoryStack.

public static NkInput.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new NkInput.Buffer instance allocated on the specified MemoryStack.

public static NkInput
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static NkInput
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static NkInput.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static NkInput.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public NkMouse

Returns:

a NkMouse view of the mouse field.
mouse
()

public static NkKeyboard
nkeyboard(long struct)

Unsafe version of keyboard.

public static NkMouse
nmouse(long struct)

Unsafe version of mouse.

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.

KEYBOARDback to summary
public static final int KEYBOARD

The struct member offsets.

MOUSEback to summary
public static final int MOUSE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

NkInputback to summary
protected NkInput(long address, ByteBuffer container)
NkInputback to summary
public NkInput(ByteBuffer container)

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

callocback to summary
public static NkInput calloc()

Returns a new NkInput instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static NkInput.Buffer calloc(int capacity)

Returns a new NkInput.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static NkInput calloc(MemoryStack stack)

Returns a new NkInput instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static NkInput.Buffer calloc(int capacity, MemoryStack stack)

Returns a new NkInput.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

callocStackback to summary
public static NkInput callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static NkInput callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static NkInput.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static NkInput.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected NkInput 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 NkInput create()

Returns a new NkInput instance allocated with BufferUtils.

createback to summary
public static NkInput create(long address)

Returns a new NkInput instance for the specified memory address.

createback to summary
public static NkInput.Buffer create(int capacity)

Returns a new NkInput.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a NkInput.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkInput createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
keyboardback to summary
public NkKeyboard keyboard()
Returns:NkKeyboard

a NkKeyboard view of the keyboard field.

Annotations
@NativeType:struct nk_keyboard
mallocback to summary
public static NkInput malloc()

Returns a new NkInput instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static NkInput.Buffer malloc(int capacity)

Returns a new NkInput.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static NkInput malloc(MemoryStack stack)

Returns a new NkInput instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static NkInput.Buffer malloc(int capacity, MemoryStack stack)

Returns a new NkInput.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static NkInput mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static NkInput mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static NkInput.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static NkInput.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mouseback to summary
public NkMouse mouse()
Returns:NkMouse

a NkMouse view of the mouse field.

Annotations
@NativeType:struct nk_mouse
nkeyboardback to summary
public static NkKeyboard nkeyboard(long struct)

Unsafe version of keyboard.

nmouseback to summary
public static NkMouse nmouse(long struct)

Unsafe version of mouse.

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 NkInput.Buffer

extends StructBuffer<NkInput, NkInput.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of NkInput structs.

Field Summary

Modifier and TypeField and Description
private static final NkInput

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkInput.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 NkInput
public NkKeyboard

Returns:

a NkKeyboard view of the keyboard field.
keyboard
()

public NkMouse

Returns:

a NkMouse view of the mouse field.
mouse
()

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

Field Detail

ELEMENT_FACTORYback to summary
private static final NkInput ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
keyboardback to summary
public NkKeyboard keyboard()
Returns:NkKeyboard

a NkKeyboard view of the keyboard field.

Annotations
@NativeType:struct nk_keyboard
mouseback to summary
public NkMouse mouse()
Returns:NkMouse

a NkMouse view of the mouse field.

Annotations
@NativeType:struct nk_mouse
selfback to summary
protected NkInput.Buffer self()

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

Annotations
@Override