Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkMemoryStatus

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

Layout


struct nk_memory_status {
    void * memory;
    unsigned int type;
    nk_size size;
    nk_size allocated;
    nk_size needed;
    nk_size calls;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ALLOCATED

The struct member offsets.

public static final int
CALLS

The struct member offsets.

public static final int
MEMORY

The struct member offsets.

public static final int
NEEDED

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
NkMemoryStatus(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the allocated field.
allocated
()

public static NkMemoryStatus
calloc()

Returns a new NkMemoryStatus instance allocated with memCalloc.

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

Returns a new NkMemoryStatus.Buffer instance allocated with memCalloc.

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

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

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

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

public static NkMemoryStatus
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public long

Returns:

the value of the calls field.
calls
()

protected NkMemoryStatus
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 NkMemoryStatus
create()

Returns a new NkMemoryStatus instance allocated with BufferUtils.

public static NkMemoryStatus
create(long address)

Returns a new NkMemoryStatus instance for the specified memory address.

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

Returns a new NkMemoryStatus.Buffer instance allocated with BufferUtils.

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

Create a NkMemoryStatus.Buffer instance at the specified memory.

public static NkMemoryStatus
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static NkMemoryStatus
malloc()

Returns a new NkMemoryStatus instance allocated with memAlloc.

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

Returns a new NkMemoryStatus.Buffer instance allocated with memAlloc.

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

Returns a new NkMemoryStatus instance allocated on the specified MemoryStack.

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

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

public static NkMemoryStatus
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public ByteBuffer

Returns:

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

public static long
nallocated(long struct)

Unsafe version of allocated.

public static long
ncalls(long struct)

Unsafe version of calls.

public long

Returns:

the value of the needed field.
needed
()

public static ByteBuffer
nmemory(long struct)

Unsafe version of memory.

public static long
nneeded(long struct)

Unsafe version of needed.

public static long
nsize(long struct)

Unsafe version of size.

public static int
ntype(long struct)

Unsafe version of type.

public long

Returns:

the value of the size field.
size
()

public int
sizeof()

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

Returns sizeof(struct).
public int

Returns:

the value of the type field.
type
()

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.

ALLOCATEDback to summary
public static final int ALLOCATED

The struct member offsets.

CALLSback to summary
public static final int CALLS

The struct member offsets.

MEMORYback to summary
public static final int MEMORY

The struct member offsets.

NEEDEDback to summary
public static final int NEEDED

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.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

NkMemoryStatusback to summary
protected NkMemoryStatus(long address, ByteBuffer container)
NkMemoryStatusback to summary
public NkMemoryStatus(ByteBuffer container)

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

allocatedback to summary
public long allocated()
Returns:long

the value of the allocated field.

Annotations
@NativeType:nk_size
callocback to summary
public static NkMemoryStatus calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static NkMemoryStatus calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callsback to summary
public long calls()
Returns:long

the value of the calls field.

Annotations
@NativeType:nk_size
createback to summary
protected NkMemoryStatus 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 NkMemoryStatus create()

Returns a new NkMemoryStatus instance allocated with BufferUtils.

createback to summary
public static NkMemoryStatus create(long address)

Returns a new NkMemoryStatus instance for the specified memory address.

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

Returns a new NkMemoryStatus.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a NkMemoryStatus.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkMemoryStatus createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static NkMemoryStatus malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static NkMemoryStatus malloc(MemoryStack stack)

Returns a new NkMemoryStatus instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
memoryback to summary
public ByteBuffer memory()
Returns:ByteBuffer

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

Annotations
@NativeType:void *
nallocatedback to summary
public static long nallocated(long struct)

Unsafe version of allocated.

ncallsback to summary
public static long ncalls(long struct)

Unsafe version of calls.

neededback to summary
public long needed()
Returns:long

the value of the needed field.

Annotations
@NativeType:nk_size
nmemoryback to summary
public static ByteBuffer nmemory(long struct)

Unsafe version of memory.

nneededback to summary
public static long nneeded(long struct)

Unsafe version of needed.

nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

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
typeback to summary
public int type()
Returns:int

the value of the type field.

Annotations
@NativeType:unsigned int
org.lwjgl.nuklear back to summary

public Class NkMemoryStatus.Buffer

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

An array of NkMemoryStatus structs.

Field Summary

Modifier and TypeField and Description
private static final NkMemoryStatus

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkMemoryStatus.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 long

Returns:

the value of the allocated field.
allocated
()

public long

Returns:

the value of the calls field.
calls
()

protected NkMemoryStatus
public ByteBuffer

Returns:

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

public long

Returns:

the value of the needed field.
needed
()

protected NkMemoryStatus.Buffer
public long

Returns:

the value of the size field.
size
()

public int

Returns:

the value of the type field.
type
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final NkMemoryStatus ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

allocatedback to summary
public long allocated()
Returns:long

the value of the allocated field.

Annotations
@NativeType:nk_size
callsback to summary
public long calls()
Returns:long

the value of the calls field.

Annotations
@NativeType:nk_size
getElementFactoryback to summary
protected NkMemoryStatus getElementFactory()

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

Annotations
@Override
memoryback to summary
public ByteBuffer memory()
Returns:ByteBuffer

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

Annotations
@NativeType:void *
neededback to summary
public long needed()
Returns:long

the value of the needed field.

Annotations
@NativeType:nk_size
selfback to summary
protected NkMemoryStatus.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
typeback to summary
public int type()
Returns:int

the value of the type field.

Annotations
@NativeType:unsigned int