Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkMemory

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

Layout


struct nk_memory {
    void * ptr;
    nk_size size;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NkMemory.Buffer

An array of NkMemory structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PTR

The struct member offsets.

public static final int
SIZE

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

public
NkMemory(ByteBuffer container)

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

Method Summary

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

Returns a new NkMemory instance for the specified memory address.

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

Create a NkMemory.Buffer instance at the specified memory.

public static NkMemory
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static ByteBuffer
nptr(long struct)

Unsafe version of ptr.

public static long
nsize(long struct)

Unsafe version of size.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the ptr field.
ptr
()

public long

Returns:

the value of the size field.
size
()

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.

PTRback to summary
public static final int PTR

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

NkMemoryback to summary
protected NkMemory(long address, ByteBuffer container)
NkMemoryback to summary
public NkMemory(ByteBuffer container)

Creates a NkMemory 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 NkMemory 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 NkMemory create(long address)

Returns a new NkMemory instance for the specified memory address.

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

Create a NkMemory.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkMemory createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
nptrback to summary
public static ByteBuffer nptr(long struct)

Unsafe version of ptr.

Annotations
@Nullable
nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

ptrback to summary
public ByteBuffer ptr()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the ptr field.

Annotations
@Nullable
@NativeType:void *
sizeback to summary
public long size()
Returns:long

the value of the size field.

Annotations
@NativeType:nk_size
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 NkMemory.Buffer

extends StructBuffer<NkMemory, NkMemory.Buffer>
Class Inheritance

An array of NkMemory structs.

Field Summary

Modifier and TypeField and Description
private static final NkMemory

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkMemory.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 NkMemory
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the ptr field.
ptr
()

protected NkMemory.Buffer
public long

Returns:

the value of the size field.
size
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final NkMemory ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
ptrback to summary
public ByteBuffer ptr()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the ptr field.

Annotations
@Nullable
@NativeType:void *
selfback to summary
protected NkMemory.Buffer self()

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

Annotations
@Override
sizeback to summary
public long size()
Returns:long

the value of the size field.

Annotations
@NativeType:nk_size