Top Description Inners Fields Constructors Methods
org.lwjgl.stb

public Class STBRPContext

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

Layout


struct stbrp_context {
    int width;
    int height;
    int align;
    int init_mode;
    int heuristic;
    int num_nodes;
    stbrp_node * active_head;
    stbrp_node * free_head;
    stbrp_node extra[2];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
STBRPContext.Buffer

An array of STBRPContext structs.

Field Summary

Modifier and TypeField and Description
public static final int
ACTIVE_HEAD

The struct member offsets.

public static final int
ALIGN

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
EXTRA

The struct member offsets.

public static final int
FREE_HEAD

The struct member offsets.

public static final int
HEIGHT

The struct member offsets.

public static final int
HEURISTIC

The struct member offsets.

public static final int
INIT_MODE

The struct member offsets.

public static final int
NUM_NODES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
WIDTH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
STBRPContext(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public STBRPNode

Returns:

a STBRPNode view of the struct pointed to by the active_head field.
active_head()

public int

Returns:

the value of the align field.
align()

public static STBRPContext
calloc()

Returns a new STBRPContext instance allocated with memCalloc.

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

Returns a new STBRPContext.Buffer instance allocated with memCalloc.

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

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

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

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

public static STBRPContext
callocStack()

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

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

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

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

Returns a new STBRPContext instance allocated with BufferUtils.

public static STBRPContext
create(long address)

Returns a new STBRPContext instance for the specified memory address.

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

Returns a new STBRPContext.Buffer instance allocated with BufferUtils.

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

Create a STBRPContext.Buffer instance at the specified memory.

public static STBRPContext
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public STBRPNode.Buffer
extra()

we allocate two extra nodes so optimal user-node-count is width not width+2

public STBRPNode
extra(int index)

we allocate two extra nodes so optimal user-node-count is width not width+2

public STBRPNode

Returns:

a STBRPNode view of the struct pointed to by the free_head field.
free_head()

public int

Returns:

the value of the height field.
height()

public int

Returns:

the value of the heuristic field.
heuristic()

public int

Returns:

the value of the init_mode field.
init_mode()

public static STBRPContext
malloc()

Returns a new STBRPContext instance allocated with memAlloc.

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

Returns a new STBRPContext.Buffer instance allocated with memAlloc.

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

Returns a new STBRPContext instance allocated on the specified MemoryStack.

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

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

public static STBRPContext
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static STBRPNode
nactive_head(long struct)

Unsafe version of active_head.

public static int
nalign(long struct)

Unsafe version of align.

public static STBRPNode.Buffer
nextra(long struct)

Unsafe version of extra.

public static STBRPNode
nextra(long struct, int index)

Unsafe version of extra.

public static STBRPNode
nfree_head(long struct)

Unsafe version of free_head.

public static int
nheight(long struct)

Unsafe version of height.

public static int
nheuristic(long struct)

Unsafe version of heuristic.

public static int
ninit_mode(long struct)

Unsafe version of init_mode.

public static int
nnum_nodes(long struct)

Unsafe version of num_nodes.

public int

Returns:

the value of the num_nodes field.
num_nodes()

public static int
nwidth(long struct)

Unsafe version of width.

public int
sizeof()

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

Returns sizeof(struct).
public int

Returns:

the value of the width field.
width()

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

ACTIVE_HEADback to summary
public static final int ACTIVE_HEAD

The struct member offsets.

ALIGNback to summary
public static final int ALIGN

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

EXTRAback to summary
public static final int EXTRA

The struct member offsets.

FREE_HEADback to summary
public static final int FREE_HEAD

The struct member offsets.

HEIGHTback to summary
public static final int HEIGHT

The struct member offsets.

HEURISTICback to summary
public static final int HEURISTIC

The struct member offsets.

INIT_MODEback to summary
public static final int INIT_MODE

The struct member offsets.

NUM_NODESback to summary
public static final int NUM_NODES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

WIDTHback to summary
public static final int WIDTH

The struct member offsets.

Constructor Detail

STBRPContextback to summary
protected STBRPContext(long address, ByteBuffer container)
STBRPContextback to summary
public STBRPContext(ByteBuffer container)

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

active_headback to summary
public STBRPNode active_head()
Returns:STBRPNode

a STBRPNode view of the struct pointed to by the active_head field.

Annotations
@Nullable
@NativeType:stbrp_node *
alignback to summary
public int align()
Returns:int

the value of the align field.

callocback to summary
public static STBRPContext calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static STBRPContext calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new STBRPContext instance allocated with BufferUtils.

createback to summary
public static STBRPContext create(long address)

Returns a new STBRPContext instance for the specified memory address.

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

Returns a new STBRPContext.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a STBRPContext.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static STBRPContext createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
extraback to summary
public STBRPNode.Buffer extra()

we allocate two extra nodes so optimal user-node-count is width not width+2

Annotations
@NativeType:stbrp_node[2]
extraback to summary
public STBRPNode extra(int index)

we allocate two extra nodes so optimal user-node-count is width not width+2

Annotations
@NativeType:stbrp_node
free_headback to summary
public STBRPNode free_head()
Returns:STBRPNode

a STBRPNode view of the struct pointed to by the free_head field.

Annotations
@Nullable
@NativeType:stbrp_node *
heightback to summary
public int height()
Returns:int

the value of the height field.

heuristicback to summary
public int heuristic()
Returns:int

the value of the heuristic field.

init_modeback to summary
public int init_mode()
Returns:int

the value of the init_mode field.

mallocback to summary
public static STBRPContext malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static STBRPContext malloc(MemoryStack stack)

Returns a new STBRPContext instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nactive_headback to summary
public static STBRPNode nactive_head(long struct)

Unsafe version of active_head.

Annotations
@Nullable
nalignback to summary
public static int nalign(long struct)

Unsafe version of align.

nextraback to summary
public static STBRPNode.Buffer nextra(long struct)

Unsafe version of extra.

nextraback to summary
public static STBRPNode nextra(long struct, int index)

Unsafe version of extra.

nfree_headback to summary
public static STBRPNode nfree_head(long struct)

Unsafe version of free_head.

Annotations
@Nullable
nheightback to summary
public static int nheight(long struct)

Unsafe version of height.

nheuristicback to summary
public static int nheuristic(long struct)

Unsafe version of heuristic.

ninit_modeback to summary
public static int ninit_mode(long struct)

Unsafe version of init_mode.

nnum_nodesback to summary
public static int nnum_nodes(long struct)

Unsafe version of num_nodes.

num_nodesback to summary
public int num_nodes()
Returns:int

the value of the num_nodes field.

nwidthback to summary
public static int nwidth(long struct)

Unsafe version of width.

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

the value of the width field.

org.lwjgl.stb back to summary

public Class STBRPContext.Buffer

extends StructBuffer<STBRPContext, STBRPContext.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of STBRPContext structs.

Field Summary

Modifier and TypeField and Description
private static final STBRPContext
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new STBRPContext.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 STBRPNode

Returns:

a STBRPNode view of the struct pointed to by the active_head field.
active_head()

public int

Returns:

the value of the align field.
align()

public STBRPNode.Buffer

Returns:

a STBRPNode.Buffer view of the STBRPContext#extra field.
extra()

public STBRPNode

Returns:

a STBRPNode view of the struct at the specified index of the STBRPContext#extra field.
extra(int index)

public STBRPNode

Returns:

a STBRPNode view of the struct pointed to by the free_head field.
free_head()

protected STBRPContext
getElementFactory()

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

public int

Returns:

the value of the height field.
height()

public int

Returns:

the value of the heuristic field.
heuristic()

public int

Returns:

the value of the init_mode field.
init_mode()

public int

Returns:

the value of the num_nodes field.
num_nodes()

protected STBRPContext.Buffer
self()

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

public int

Returns:

the value of the width field.
width()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final STBRPContext ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

active_headback to summary
public STBRPNode active_head()
Returns:STBRPNode

a STBRPNode view of the struct pointed to by the active_head field.

Annotations
@Nullable
@NativeType:stbrp_node *
alignback to summary
public int align()
Returns:int

the value of the align field.

extraback to summary
public STBRPNode.Buffer extra()
Returns:STBRPNode.Buffer

a STBRPNode.Buffer view of the STBRPContext#extra field.

Annotations
@NativeType:stbrp_node[2]
extraback to summary
public STBRPNode extra(int index)
Returns:STBRPNode

a STBRPNode view of the struct at the specified index of the STBRPContext#extra field.

Annotations
@NativeType:stbrp_node
free_headback to summary
public STBRPNode free_head()
Returns:STBRPNode

a STBRPNode view of the struct pointed to by the free_head field.

Annotations
@Nullable
@NativeType:stbrp_node *
getElementFactoryback to summary
protected STBRPContext getElementFactory()

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

Annotations
@Override
heightback to summary
public int height()
Returns:int

the value of the height field.

heuristicback to summary
public int heuristic()
Returns:int

the value of the heuristic field.

init_modeback to summary
public int init_mode()
Returns:int

the value of the init_mode field.

num_nodesback to summary
public int num_nodes()
Returns:int

the value of the num_nodes field.

selfback to summary
protected STBRPContext.Buffer self()

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

Annotations
@Override
widthback to summary
public int width()
Returns:int

the value of the width field.