Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

pack-priv Class NkPool

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

Layout


struct nk_pool {
    struct nk_allocator alloc;
    enum nk_allocation_type type;
    unsigned int page_count;
    struct nk_page * pages;
    struct nk_page_element * freelist;
    unsigned capacity;
    nk_size size;
    nk_size cap;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NkPool.Buffer

An array of NkPool structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ALLOC

The struct member offsets.

public static final int
CAP

The struct member offsets.

public static final int
CAPACITY

The struct member offsets.

public static final int
FREELIST

The struct member offsets.

public static final int
PAGE_COUNT

The struct member offsets.

public static final int
PAGES

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

pack-priv
NkPool(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public NkAllocator

Returns:

a NkAllocator view of the alloc field.
alloc()

public long

Returns:

the value of the cap field.
cap()

public int

Returns:

the value of the capacity field.
capacity$()

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

Returns a new NkPool instance for the specified memory address.

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

Create a NkPool.Buffer instance at the specified memory.

public static NkPool
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long

Returns:

the value of the freelist field.
freelist()

public static NkAllocator
nalloc(long struct)

Unsafe version of alloc.

public static long
ncap(long struct)

Unsafe version of cap.

public static int
ncapacity$(long struct)

Unsafe version of capacity$.

public static long
nfreelist(long struct)

Unsafe version of freelist.

public static int
npage_count(long struct)

Unsafe version of page_count.

public static long
npages(long struct)

Unsafe version of pages.

public static long
nsize(long struct)

Unsafe version of size.

public static int
ntype(long struct)

Unsafe version of type.

public int

Returns:

the value of the page_count field.
page_count()

public long

Returns:

the value of the pages field.
pages()

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.

ALLOCback to summary
public static final int ALLOC

The struct member offsets.

CAPback to summary
public static final int CAP

The struct member offsets.

CAPACITYback to summary
public static final int CAPACITY

The struct member offsets.

FREELISTback to summary
public static final int FREELIST

The struct member offsets.

PAGE_COUNTback to summary
public static final int PAGE_COUNT

The struct member offsets.

PAGESback to summary
public static final int PAGES

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

NkPoolback to summary
protected NkPool(long address, ByteBuffer container)
NkPoolback to summary
pack-priv NkPool(ByteBuffer container)

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

allocback to summary
public NkAllocator alloc()
Returns:NkAllocator

a NkAllocator view of the alloc field.

Annotations
@NativeType:struct nk_allocator
capback to summary
public long cap()
Returns:long

the value of the cap field.

Annotations
@NativeType:nk_size
capacity$back to summary
public int capacity$()
Returns:int

the value of the capacity field.

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

Returns a new NkPool instance for the specified memory address.

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

Create a NkPool.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkPool createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
freelistback to summary
public long freelist()
Returns:long

the value of the freelist field.

Annotations
@NativeType:struct nk_page_element *
nallocback to summary
public static NkAllocator nalloc(long struct)

Unsafe version of alloc.

ncapback to summary
public static long ncap(long struct)

Unsafe version of cap.

ncapacity$back to summary
public static int ncapacity$(long struct)

Unsafe version of capacity$.

nfreelistback to summary
public static long nfreelist(long struct)

Unsafe version of freelist.

npage_countback to summary
public static int npage_count(long struct)

Unsafe version of page_count.

npagesback to summary
public static long npages(long struct)

Unsafe version of pages.

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.

page_countback to summary
public int page_count()
Returns:int

the value of the page_count field.

Annotations
@NativeType:unsigned int
pagesback to summary
public long pages()
Returns:long

the value of the pages field.

Annotations
@NativeType:struct nk_page *
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:enum nk_allocation_type
org.lwjgl.nuklear back to summary

public Class NkPool.Buffer

extends StructBuffer<NkPool, NkPool.Buffer>
Class Inheritance
An array of NkPool structs.

Field Summary

Modifier and TypeField and Description
private static final NkPool
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkPool.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 NkAllocator

Returns:

a NkAllocator view of the alloc field.
alloc()

public long

Returns:

the value of the cap field.
cap()

public int

Returns:

the value of the capacity field.
capacity$()

public long

Returns:

the value of the freelist field.
freelist()

protected NkPool
getElementFactory()

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

public int

Returns:

the value of the page_count field.
page_count()

public long

Returns:

the value of the pages field.
pages()

protected NkPool.Buffer
self()

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

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 NkPool ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

allocback to summary
public NkAllocator alloc()
Returns:NkAllocator

a NkAllocator view of the alloc field.

Annotations
@NativeType:struct nk_allocator
capback to summary
public long cap()
Returns:long

the value of the cap field.

Annotations
@NativeType:nk_size
capacity$back to summary
public int capacity$()
Returns:int

the value of the capacity field.

Annotations
@NativeType:unsigned
freelistback to summary
public long freelist()
Returns:long

the value of the freelist field.

Annotations
@NativeType:struct nk_page_element *
getElementFactoryback to summary
protected NkPool getElementFactory()

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

Annotations
@Override
page_countback to summary
public int page_count()
Returns:int

the value of the page_count field.

Annotations
@NativeType:unsigned int
pagesback to summary
public long pages()
Returns:long

the value of the pages field.

Annotations
@NativeType:struct nk_page *
selfback to summary
protected NkPool.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:enum nk_allocation_type