Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkHandle

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

Layout


union nk_handle {
    void * ptr;
    int id;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NkHandle.Buffer

An array of NkHandle structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ID

The struct member offsets.

public static final int
PTR

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

public
NkHandle(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static NkHandle
calloc()

Returns a new NkHandle instance allocated with memCalloc.

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

Returns a new NkHandle.Buffer instance allocated with memCalloc.

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

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

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

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

public static NkHandle
callocStack()

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

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

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

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

Returns a new NkHandle instance allocated with BufferUtils.

public static NkHandle
create(long address)

Returns a new NkHandle instance for the specified memory address.

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

Returns a new NkHandle.Buffer instance allocated with BufferUtils.

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

Create a NkHandle.Buffer instance at the specified memory.

public static NkHandle
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the id field.
id
()

public NkHandle
id(int value)

Sets the specified value to the id field.

public static NkHandle
malloc()

Returns a new NkHandle instance allocated with memAlloc.

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

Returns a new NkHandle.Buffer instance allocated with memAlloc.

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

Returns a new NkHandle instance allocated on the specified MemoryStack.

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

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

public static NkHandle
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static int
nid(long struct)

Unsafe version of id.

public static void
nid(long struct, int value)

Unsafe version of id.

public static long
nptr(long struct)

Unsafe version of ptr.

public static void
nptr(long struct, long value)

Unsafe version of ptr.

public long

Returns:

the value of the ptr field.
ptr
()

public NkHandle
ptr(long value)

Sets the specified value to the ptr field.

public NkHandle

Returns:

this struct
set
(NkHandle
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).
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.

IDback to summary
public static final int ID

The struct member offsets.

PTRback to summary
public static final int PTR

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

NkHandleback to summary
protected NkHandle(long address, ByteBuffer container)
NkHandleback to summary
public NkHandle(ByteBuffer container)

Creates a NkHandle 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 NkHandle calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static NkHandle calloc(MemoryStack stack)

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

Returns a new NkHandle.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 NkHandle callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static NkHandle.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 NkHandle 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 NkHandle create()

Returns a new NkHandle instance allocated with BufferUtils.

createback to summary
public static NkHandle create(long address)

Returns a new NkHandle instance for the specified memory address.

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

Returns a new NkHandle.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a NkHandle.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkHandle createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
idback to summary
public int id()
Returns:int

the value of the id field.

idback to summary
public NkHandle id(int value)

Sets the specified value to the id field.

mallocback to summary
public static NkHandle malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static NkHandle malloc(MemoryStack stack)

Returns a new NkHandle instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new NkHandle.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 NkHandle mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nidback to summary
public static int nid(long struct)

Unsafe version of id.

nidback to summary
public static void nid(long struct, int value)

Unsafe version of id.

nptrback to summary
public static long nptr(long struct)

Unsafe version of ptr.

nptrback to summary
public static void nptr(long struct, long value)

Unsafe version of ptr.

ptrback to summary
public long ptr()
Returns:long

the value of the ptr field.

Annotations
@NativeType:void *
ptrback to summary
public NkHandle ptr(long value)

Sets the specified value to the ptr field.

setback to summary
public NkHandle set(NkHandle src)

Copies the specified struct data to this struct.

Parameters
src:NkHandle

the source struct

Returns:NkHandle

this struct

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

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

An array of NkHandle structs.

Field Summary

Modifier and TypeField and Description
private static final NkHandle

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the id field.
id
()

public NkHandle.Buffer
id(int value)

Sets the specified value to the id field.

public long

Returns:

the value of the ptr field.
ptr
()

public NkHandle.Buffer
ptr(long value)

Sets the specified value to the ptr field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final NkHandle ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
idback to summary
public int id()
Returns:int

the value of the id field.

idback to summary
public NkHandle.Buffer id(int value)

Sets the specified value to the id field.

ptrback to summary
public long ptr()
Returns:long

the value of the ptr field.

Annotations
@NativeType:void *
ptrback to summary
public NkHandle.Buffer ptr(long value)

Sets the specified value to the ptr field.

selfback to summary
protected NkHandle.Buffer self()

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

Annotations
@Override