STBRPContext (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.stb.STBRPContext

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class STBRPContext
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

The opaque stbrp_context struct.

Member documentation

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

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 Class Summary

Nested Classes
Modifier and Type Class and Description

static class STBRPContext.Buffer
An array of STBRPContext structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`STBRPContext.Buffer` An array of `STBRPContext` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACTIVE_HEAD` The struct member offsets.
`static int`	`ALIGN` The struct member offsets.
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`EXTRA` The struct member offsets.
`static int`	`FREE_HEAD` The struct member offsets.
`static int`	`HEIGHT` The struct member offsets.
`static int`	`HEURISTIC` The struct member offsets.
`static int`	`INIT_MODE` The struct member offsets.
`static int`	`NUM_NODES` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`WIDTH` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

STBRPContext(java.nio.ByteBuffer container)
Creates a STBRPContext instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`STBRPContext(java.nio.ByteBuffer container)` Creates a `STBRPContext` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`STBRPNode`	`active_head()` Returns a `STBRPNode` view of the struct pointed to by the `active_head` field.
`int`	`align()` Returns the value of the `align` field.
`static STBRPContext`	`calloc()` Returns a new `STBRPContext` instance allocated with `memCalloc`.
`static STBRPContext.Buffer`	`calloc(int capacity)` Returns a new `STBRPContext.Buffer` instance allocated with `memCalloc`.
`static STBRPContext`	`callocStack()` Returns a new `STBRPContext` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBRPContext.Buffer`	`callocStack(int capacity)` Returns a new `STBRPContext.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBRPContext.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBRPContext.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static STBRPContext`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBRPContext` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static STBRPContext`	`create()` Returns a new `STBRPContext` instance allocated with `BufferUtils`.
`static STBRPContext.Buffer`	`create(int capacity)` Returns a new `STBRPContext.Buffer` instance allocated with `BufferUtils`.
`static STBRPContext`	`create(long address)` Returns a new `STBRPContext` instance for the specified memory address.
`static STBRPContext.Buffer`	`create(long address, int capacity)` Create a `STBRPContext.Buffer` instance at the specified memory.
`static STBRPContext`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static STBRPContext.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`STBRPNode.Buffer`	`extra()` Returns a `STBRPNode`.Buffer view of the `extra` field.
`STBRPNode`	`extra(int index)` Returns a `STBRPNode` view of the struct at the specified index of the `extra` field.
`STBRPNode`	`free_head()` Returns a `STBRPNode` view of the struct pointed to by the `free_head` field.
`int`	`height()` Returns the value of the `height` field.
`int`	`heuristic()` Returns the value of the `heuristic` field.
`int`	`init_mode()` Returns the value of the `init_mode` field.
`static STBRPContext`	`malloc()` Returns a new `STBRPContext` instance allocated with `memAlloc`.
`static STBRPContext.Buffer`	`malloc(int capacity)` Returns a new `STBRPContext.Buffer` instance allocated with `memAlloc`.
`static STBRPContext`	`mallocStack()` Returns a new `STBRPContext` instance allocated on the thread-local `MemoryStack`.
`static STBRPContext.Buffer`	`mallocStack(int capacity)` Returns a new `STBRPContext.Buffer` instance allocated on the thread-local `MemoryStack`.
`static STBRPContext.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBRPContext.Buffer` instance allocated on the specified `MemoryStack`.
`static STBRPContext`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBRPContext` instance allocated on the specified `MemoryStack`.
`static STBRPNode`	`nactive_head(long struct)` Unsafe version of `active_head()`.
`static int`	`nalign(long struct)` Unsafe version of `align()`.
`static STBRPNode.Buffer`	`nextra(long struct)` Unsafe version of `extra()`.
`static STBRPNode`	`nextra(long struct, int index)` Unsafe version of `extra`.
`static STBRPNode`	`nfree_head(long struct)` Unsafe version of `free_head()`.
`static int`	`nheight(long struct)` Unsafe version of `height()`.
`static int`	`nheuristic(long struct)` Unsafe version of `heuristic()`.
`static int`	`ninit_mode(long struct)` Unsafe version of `init_mode()`.
`static int`	`nnum_nodes(long struct)` Unsafe version of `num_nodes()`.
`int`	`num_nodes()` Returns the value of the `num_nodes` field.
`static int`	`nwidth(long struct)` Unsafe version of `width()`.
`int`	`sizeof()`
`int`	`width()` Returns the value of the `width` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - WIDTH
```
public static final int WIDTH
```
    The struct member offsets.
  - HEIGHT
```
public static final int HEIGHT
```
    The struct member offsets.
  - ALIGN
```
public static final int ALIGN
```
    The struct member offsets.
  - INIT_MODE
```
public static final int INIT_MODE
```
    The struct member offsets.
  - HEURISTIC
```
public static final int HEURISTIC
```
    The struct member offsets.
  - NUM_NODES
```
public static final int NUM_NODES
```
    The struct member offsets.
  - ACTIVE_HEAD
```
public static final int ACTIVE_HEAD
```
    The struct member offsets.
  - FREE_HEAD
```
public static final int FREE_HEAD
```
    The struct member offsets.
  - EXTRA
```
public static final int EXTRA
```
    The struct member offsets.
- Constructor Detail
  - STBRPContext
```
public STBRPContext(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - width
```
public int width()
```
    Returns the value of the width field.
  - height
```
public int height()
```
    Returns the value of the height field.
  - align
```
public int align()
```
    Returns the value of the align field.
  - init_mode
```
public int init_mode()
```
    Returns the value of the init_mode field.
  - heuristic
```
public int heuristic()
```
    Returns the value of the heuristic field.
  - num_nodes
```
public int num_nodes()
```
    Returns the value of the num_nodes field.
  - active_head
```
@Nullable
public STBRPNode active_head()
```
    Returns a STBRPNode view of the struct pointed to by the active_head field.
  - free_head
```
@Nullable
public STBRPNode free_head()
```
    Returns a STBRPNode view of the struct pointed to by the free_head field.
  - extra
```
public STBRPNode.Buffer extra()
```
    Returns a STBRPNode.Buffer view of the extra field.
  - extra
```
public STBRPNode extra(int index)
```
    Returns a STBRPNode view of the struct at the specified index of the extra field.
  - malloc
```
public static STBRPContext malloc()
```
    Returns a new STBRPContext instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static STBRPContext calloc()
```
    Returns a new STBRPContext instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static STBRPContext create()
```
    Returns a new STBRPContext instance allocated with BufferUtils.
  - create
```
public static STBRPContext create(long address)
```
    Returns a new STBRPContext instance for the specified memory address.
  - createSafe
```
@Nullable
public static STBRPContext createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static STBRPContext.Buffer malloc(int capacity)
```
    Returns a new STBRPContext.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static STBRPContext.Buffer calloc(int capacity)
```
    Returns a new STBRPContext.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBRPContext.Buffer create(int capacity)
```
    Returns a new STBRPContext.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBRPContext.Buffer create(long address,
                                         int capacity)
```
    Create a STBRPContext.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static STBRPContext.Buffer createSafe(long address,
                                                       int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static STBRPContext mallocStack()
```
    Returns a new STBRPContext instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static STBRPContext callocStack()
```
    Returns a new STBRPContext instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static STBRPContext mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBRPContext instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static STBRPContext callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBRPContext instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static STBRPContext.Buffer mallocStack(int capacity)
```
    Returns a new STBRPContext.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static STBRPContext.Buffer callocStack(int capacity)
```
    Returns a new STBRPContext.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static STBRPContext.Buffer mallocStack(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBRPContext.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static STBRPContext.Buffer callocStack(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBRPContext.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nwidth
```
public static int nwidth(long struct)
```
    Unsafe version of width().
  - nheight
```
public static int nheight(long struct)
```
    Unsafe version of height().
  - nalign
```
public static int nalign(long struct)
```
    Unsafe version of align().
  - ninit_mode
```
public static int ninit_mode(long struct)
```
    Unsafe version of init_mode().
  - nheuristic
```
public static int nheuristic(long struct)
```
    Unsafe version of heuristic().
  - nnum_nodes
```
public static int nnum_nodes(long struct)
```
    Unsafe version of num_nodes().
  - nactive_head
```
@Nullable
public static STBRPNode nactive_head(long struct)
```
    Unsafe version of active_head().
  - nfree_head
```
@Nullable
public static STBRPNode nfree_head(long struct)
```
    Unsafe version of free_head().
  - nextra
```
public static STBRPNode.Buffer nextra(long struct)
```
    Unsafe version of extra().
  - nextra
```
public static STBRPNode nextra(long struct,
                               int index)
```
    Unsafe version of extra.

Class STBRPContext

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

WIDTH

HEIGHT

ALIGN

INIT_MODE

HEURISTIC

NUM_NODES

ACTIVE_HEAD

FREE_HEAD

EXTRA

Constructor Detail

STBRPContext

Method Detail

sizeof

width

height

align

init_mode

heuristic

num_nodes

active_head

free_head

extra

extra

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nwidth

nheight

nalign

ninit_mode

nheuristic

nnum_nodes

nactive_head

nfree_head

nextra

nextra