STBTTPackContext (LWJGL 3.2.4 SNAPSHOT

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

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

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

An opaque structure which holds all the context needed from PackBegin to PackEnd.

Layout


 struct stbtt_pack_context {
     void * user_allocator_context;
     stbrp_context * pack_info;
     int width;
     int height;
     int stride_in_bytes;
     int padding;
     int skip_missing;
     unsigned int h_oversample;
     unsigned int v_oversample;
     unsigned char * pixels;
     stbrp_node * nodes;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class STBTTPackContext.Buffer
An array of STBTTPackContext 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`	`STBTTPackContext.Buffer` An array of `STBTTPackContext` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`H_OVERSAMPLE` The struct member offsets.
`static int`	`HEIGHT` The struct member offsets.
`static int`	`NODES` The struct member offsets.
`static int`	`PACK_INFO` The struct member offsets.
`static int`	`PADDING` The struct member offsets.
`static int`	`PIXELS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`SKIP_MISSING` The struct member offsets.
`static int`	`STRIDE_IN_BYTES` The struct member offsets.
`static int`	`USER_ALLOCATOR_CONTEXT` The struct member offsets.
`static int`	`V_OVERSAMPLE` The struct member offsets.
`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

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

Constructors
Constructor and Description
`STBTTPackContext(java.nio.ByteBuffer container)` Creates a `STBTTPackContext` 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
`static STBTTPackContext`	`calloc()` Returns a new `STBTTPackContext` instance allocated with `memCalloc`.
`static STBTTPackContext.Buffer`	`calloc(int capacity)` Returns a new `STBTTPackContext.Buffer` instance allocated with `memCalloc`.
`static STBTTPackContext`	`callocStack()` Returns a new `STBTTPackContext` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBTTPackContext.Buffer`	`callocStack(int capacity)` Returns a new `STBTTPackContext.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBTTPackContext.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTPackContext.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static STBTTPackContext`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTPackContext` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static STBTTPackContext`	`create()` Returns a new `STBTTPackContext` instance allocated with `BufferUtils`.
`static STBTTPackContext.Buffer`	`create(int capacity)` Returns a new `STBTTPackContext.Buffer` instance allocated with `BufferUtils`.
`static STBTTPackContext`	`create(long address)` Returns a new `STBTTPackContext` instance for the specified memory address.
`static STBTTPackContext.Buffer`	`create(long address, int capacity)` Create a `STBTTPackContext.Buffer` instance at the specified memory.
`static STBTTPackContext`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static STBTTPackContext.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`h_oversample()` Returns the value of the `h_oversample` field.
`int`	`height()` Returns the value of the `height` field.
`static STBTTPackContext`	`malloc()` Returns a new `STBTTPackContext` instance allocated with `memAlloc`.
`static STBTTPackContext.Buffer`	`malloc(int capacity)` Returns a new `STBTTPackContext.Buffer` instance allocated with `memAlloc`.
`static STBTTPackContext`	`mallocStack()` Returns a new `STBTTPackContext` instance allocated on the thread-local `MemoryStack`.
`static STBTTPackContext.Buffer`	`mallocStack(int capacity)` Returns a new `STBTTPackContext.Buffer` instance allocated on the thread-local `MemoryStack`.
`static STBTTPackContext.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTPackContext.Buffer` instance allocated on the specified `MemoryStack`.
`static STBTTPackContext`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTPackContext` instance allocated on the specified `MemoryStack`.
`static int`	`nh_oversample(long struct)` Unsafe version of `h_oversample()`.
`static int`	`nheight(long struct)` Unsafe version of `height()`.
`static STBRPNode.Buffer`	`nnodes(long struct, int capacity)` Unsafe version of `nodes(int)`.
`STBRPNode.Buffer`	`nodes(int capacity)` Returns a `STBRPNode.Buffer` view of the struct array pointed to by the `nodes` field.
`static STBRPContext`	`npack_info(long struct)` Unsafe version of `pack_info()`.
`static int`	`npadding(long struct)` Unsafe version of `padding()`.
`static java.nio.ByteBuffer`	`npixels(long struct, int capacity)` Unsafe version of `pixels`.
`static int`	`nskip_missing(long struct)` Unsafe version of `skip_missing()`.
`static int`	`nstride_in_bytes(long struct)` Unsafe version of `stride_in_bytes()`.
`static long`	`nuser_allocator_context(long struct)` Unsafe version of `user_allocator_context()`.
`static int`	`nv_oversample(long struct)` Unsafe version of `v_oversample()`.
`static int`	`nwidth(long struct)` Unsafe version of `width()`.
`STBRPContext`	`pack_info()` Returns a `STBRPContext` view of the struct pointed to by the `pack_info` field.
`int`	`padding()` Returns the value of the `padding` field.
`java.nio.ByteBuffer`	`pixels(int capacity)` Returns a `ByteBuffer` view of the data pointed to by the `pixels` field.
`int`	`sizeof()`
`boolean`	`skip_missing()` Returns the value of the `skip_missing` field.
`int`	`stride_in_bytes()` Returns the value of the `stride_in_bytes` field.
`long`	`user_allocator_context()` Returns the value of the `user_allocator_context` field.
`int`	`v_oversample()` Returns the value of the `v_oversample` field.
`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.
  - USER_ALLOCATOR_CONTEXT
```
public static final int USER_ALLOCATOR_CONTEXT
```
    The struct member offsets.
  - PACK_INFO
```
public static final int PACK_INFO
```
    The struct member offsets.
  - WIDTH
```
public static final int WIDTH
```
    The struct member offsets.
  - HEIGHT
```
public static final int HEIGHT
```
    The struct member offsets.
  - STRIDE_IN_BYTES
```
public static final int STRIDE_IN_BYTES
```
    The struct member offsets.
  - PADDING
```
public static final int PADDING
```
    The struct member offsets.
  - SKIP_MISSING
```
public static final int SKIP_MISSING
```
    The struct member offsets.
  - H_OVERSAMPLE
```
public static final int H_OVERSAMPLE
```
    The struct member offsets.
  - V_OVERSAMPLE
```
public static final int V_OVERSAMPLE
```
    The struct member offsets.
  - PIXELS
```
public static final int PIXELS
```
    The struct member offsets.
  - NODES
```
public static final int NODES
```
    The struct member offsets.
- Constructor Detail
  - STBTTPackContext
```
public STBTTPackContext(java.nio.ByteBuffer container)
```
    Creates a STBTTPackContext 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
  - user_allocator_context
```
public long user_allocator_context()
```
    Returns the value of the user_allocator_context field.
  - pack_info
```
public STBRPContext pack_info()
```
    Returns a STBRPContext view of the struct pointed to by the pack_info field.
  - width
```
public int width()
```
    Returns the value of the width field.
  - height
```
public int height()
```
    Returns the value of the height field.
  - stride_in_bytes
```
public int stride_in_bytes()
```
    Returns the value of the stride_in_bytes field.
  - padding
```
public int padding()
```
    Returns the value of the padding field.
  - skip_missing
```
public boolean skip_missing()
```
    Returns the value of the skip_missing field.
  - h_oversample
```
public int h_oversample()
```
    Returns the value of the h_oversample field.
  - v_oversample
```
public int v_oversample()
```
    Returns the value of the v_oversample field.
  - pixels
```
public java.nio.ByteBuffer pixels(int capacity)
```
    Returns a ByteBuffer view of the data pointed to by the pixels field.
    
    Parameters:
    
    capacity - the number of elements in the returned buffer
  - nodes
```
public STBRPNode.Buffer nodes(int capacity)
```
    Returns a STBRPNode.Buffer view of the struct array pointed to by the nodes field.
    
    Parameters:
    
    capacity - the number of elements in the returned buffer
  - malloc
```
public static STBTTPackContext malloc()
```
    Returns a new STBTTPackContext instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static STBTTPackContext calloc()
```
    Returns a new STBTTPackContext instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static STBTTPackContext create()
```
    Returns a new STBTTPackContext instance allocated with BufferUtils.
  - create
```
public static STBTTPackContext create(long address)
```
    Returns a new STBTTPackContext instance for the specified memory address.
  - createSafe
```
@Nullable
public static STBTTPackContext createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static STBTTPackContext.Buffer malloc(int capacity)
```
    Returns a new STBTTPackContext.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static STBTTPackContext.Buffer calloc(int capacity)
```
    Returns a new STBTTPackContext.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBTTPackContext.Buffer create(int capacity)
```
    Returns a new STBTTPackContext.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBTTPackContext.Buffer create(long address,
                                             int capacity)
```
    Create a STBTTPackContext.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static STBTTPackContext.Buffer createSafe(long address,
                                                           int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static STBTTPackContext mallocStack()
```
    Returns a new STBTTPackContext instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static STBTTPackContext callocStack()
```
    Returns a new STBTTPackContext instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static STBTTPackContext mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTPackContext instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static STBTTPackContext callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTPackContext instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static STBTTPackContext.Buffer mallocStack(int capacity)
```
    Returns a new STBTTPackContext.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static STBTTPackContext.Buffer callocStack(int capacity)
```
    Returns a new STBTTPackContext.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static STBTTPackContext.Buffer mallocStack(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTPackContext.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static STBTTPackContext.Buffer callocStack(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTPackContext.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
  - nuser_allocator_context
```
public static long nuser_allocator_context(long struct)
```
    Unsafe version of user_allocator_context().
  - npack_info
```
public static STBRPContext npack_info(long struct)
```
    Unsafe version of pack_info().
  - nwidth
```
public static int nwidth(long struct)
```
    Unsafe version of width().
  - nheight
```
public static int nheight(long struct)
```
    Unsafe version of height().
  - nstride_in_bytes
```
public static int nstride_in_bytes(long struct)
```
    Unsafe version of stride_in_bytes().
  - npadding
```
public static int npadding(long struct)
```
    Unsafe version of padding().
  - nskip_missing
```
public static int nskip_missing(long struct)
```
    Unsafe version of skip_missing().
  - nh_oversample
```
public static int nh_oversample(long struct)
```
    Unsafe version of h_oversample().
  - nv_oversample
```
public static int nv_oversample(long struct)
```
    Unsafe version of v_oversample().
  - npixels
```
public static java.nio.ByteBuffer npixels(long struct,
                                          int capacity)
```
    Unsafe version of pixels.
  - nnodes
```
public static STBRPNode.Buffer nnodes(long struct,
                                      int capacity)
```
    Unsafe version of nodes(int).

Class STBTTPackContext

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

USER_ALLOCATOR_CONTEXT

PACK_INFO

WIDTH

HEIGHT

STRIDE_IN_BYTES

PADDING

SKIP_MISSING

H_OVERSAMPLE

V_OVERSAMPLE

PIXELS

NODES

Constructor Detail

STBTTPackContext

Method Detail

sizeof

user_allocator_context

pack_info

width

height

stride_in_bytes

padding

skip_missing

h_oversample

v_oversample

pixels

nodes

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nuser_allocator_context

npack_info

nwidth

nheight

nstride_in_bytes

npadding

nskip_missing

nh_oversample

nv_oversample

npixels

nnodes