STBTTPackRange (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class STBTTPackRange
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
A range of packed character data, used by PackFontRanges
Member documentation
- font_size – the font size
- first_unicode_codepoint_in_range – if non-zero, then the chars are continuous, and this is the first codepoint
- array_of_unicode_codepoints – if non-zero, then this is an array of unicode codepoints
- num_chars – the number of codepoints in the range
- chardata_for_range – output
- h_oversample – used internally
- v_oversample – used internally
Layout
```
 struct stbtt_pack_range {
     float font_size;
     int first_unicode_codepoint_in_range;
     int * array_of_unicode_codepoints;
     int num_chars;
     stbtt_packedchar * chardata_for_range;
     unsigned char h_oversample;
     unsigned char v_oversample;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ARRAY_OF_UNICODE_CODEPOINTS` The struct member offsets.
`static int`	`CHARDATA_FOR_RANGE` The struct member offsets.
`static int`	`FIRST_UNICODE_CODEPOINT_IN_RANGE` The struct member offsets.
`static int`	`FONT_SIZE` The struct member offsets.
`static int`	`H_OVERSAMPLE` The struct member offsets.
`static int`	`NUM_CHARS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`V_OVERSAMPLE` 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

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

Constructors
Constructor and Description
`STBTTPackRange(java.nio.ByteBuffer container)` Creates a `STBTTPackRange` 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
`java.nio.IntBuffer`	`array_of_unicode_codepoints()` Returns a `IntBuffer` view of the data pointed to by the `array_of_unicode_codepoints` field.
`STBTTPackRange`	`array_of_unicode_codepoints(java.nio.IntBuffer value)` Sets the address of the specified `IntBuffer` to the `array_of_unicode_codepoints` field.
`static STBTTPackRange`	`calloc()` Returns a new `STBTTPackRange` instance allocated with `memCalloc`.
`static STBTTPackRange.Buffer`	`calloc(int capacity)` Returns a new `STBTTPackRange.Buffer` instance allocated with `memCalloc`.
`static STBTTPackRange`	`callocStack()` Returns a new `STBTTPackRange` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBTTPackRange.Buffer`	`callocStack(int capacity)` Returns a new `STBTTPackRange.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBTTPackRange.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTPackRange.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static STBTTPackRange`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTPackRange` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`STBTTPackedchar.Buffer`	`chardata_for_range()` Returns a `STBTTPackedchar.Buffer` view of the struct array pointed to by the `chardata_for_range` field.
`STBTTPackRange`	`chardata_for_range(STBTTPackedchar.Buffer value)` Sets the address of the specified `STBTTPackedchar.Buffer` to the `chardata_for_range` field.
`static STBTTPackRange`	`create()` Returns a new `STBTTPackRange` instance allocated with `BufferUtils`.
`static STBTTPackRange.Buffer`	`create(int capacity)` Returns a new `STBTTPackRange.Buffer` instance allocated with `BufferUtils`.
`static STBTTPackRange`	`create(long address)` Returns a new `STBTTPackRange` instance for the specified memory address.
`static STBTTPackRange.Buffer`	`create(long address, int capacity)` Create a `STBTTPackRange.Buffer` instance at the specified memory.
`static STBTTPackRange`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static STBTTPackRange.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`first_unicode_codepoint_in_range()` Returns the value of the `first_unicode_codepoint_in_range` field.
`STBTTPackRange`	`first_unicode_codepoint_in_range(int value)` Sets the specified value to the `first_unicode_codepoint_in_range` field.
`float`	`font_size()` Returns the value of the `font_size` field.
`STBTTPackRange`	`font_size(float value)` Sets the specified value to the `font_size` field.
`byte`	`h_oversample()` Returns the value of the `h_oversample` field.
`STBTTPackRange`	`h_oversample(byte value)` Sets the specified value to the `h_oversample` field.
`static STBTTPackRange`	`malloc()` Returns a new `STBTTPackRange` instance allocated with `memAlloc`.
`static STBTTPackRange.Buffer`	`malloc(int capacity)` Returns a new `STBTTPackRange.Buffer` instance allocated with `memAlloc`.
`static STBTTPackRange`	`mallocStack()` Returns a new `STBTTPackRange` instance allocated on the thread-local `MemoryStack`.
`static STBTTPackRange.Buffer`	`mallocStack(int capacity)` Returns a new `STBTTPackRange.Buffer` instance allocated on the thread-local `MemoryStack`.
`static STBTTPackRange.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTPackRange.Buffer` instance allocated on the specified `MemoryStack`.
`static STBTTPackRange`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTPackRange` instance allocated on the specified `MemoryStack`.
`static java.nio.IntBuffer`	`narray_of_unicode_codepoints(long struct)` Unsafe version of `array_of_unicode_codepoints`.
`static void`	`narray_of_unicode_codepoints(long struct, java.nio.IntBuffer value)` Unsafe version of `array_of_unicode_codepoints`.
`static STBTTPackedchar.Buffer`	`nchardata_for_range(long struct)` Unsafe version of `chardata_for_range()`.
`static void`	`nchardata_for_range(long struct, STBTTPackedchar.Buffer value)` Unsafe version of `chardata_for_range`.
`static int`	`nfirst_unicode_codepoint_in_range(long struct)` Unsafe version of `first_unicode_codepoint_in_range()`.
`static void`	`nfirst_unicode_codepoint_in_range(long struct, int value)` Unsafe version of `first_unicode_codepoint_in_range`.
`static float`	`nfont_size(long struct)` Unsafe version of `font_size()`.
`static void`	`nfont_size(long struct, float value)` Unsafe version of `font_size`.
`static byte`	`nh_oversample(long struct)` Unsafe version of `h_oversample()`.
`static void`	`nh_oversample(long struct, byte value)` Unsafe version of `h_oversample`.
`static int`	`nnum_chars(long struct)` Unsafe version of `num_chars()`.
`static void`	`nnum_chars(long struct, int value)` Sets the specified value to the `num_chars` field of the specified `struct`.
`int`	`num_chars()` Returns the value of the `num_chars` field.
`STBTTPackRange`	`num_chars(int value)` Sets the specified value to the `num_chars` field.
`static byte`	`nv_oversample(long struct)` Unsafe version of `v_oversample()`.
`static void`	`nv_oversample(long struct, byte value)` Unsafe version of `v_oversample`.
`STBTTPackRange`	`set(float font_size, int first_unicode_codepoint_in_range, java.nio.IntBuffer array_of_unicode_codepoints, int num_chars, STBTTPackedchar.Buffer chardata_for_range, byte h_oversample, byte v_oversample)` Initializes this struct with the specified values.
`STBTTPackRange`	`set(STBTTPackRange src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`byte`	`v_oversample()` Returns the value of the `v_oversample` field.
`STBTTPackRange`	`v_oversample(byte value)` Sets the specified value to the `v_oversample` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

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.
  - FONT_SIZE
```
public static final int FONT_SIZE
```
    The struct member offsets.
  - FIRST_UNICODE_CODEPOINT_IN_RANGE
```
public static final int FIRST_UNICODE_CODEPOINT_IN_RANGE
```
    The struct member offsets.
  - ARRAY_OF_UNICODE_CODEPOINTS
```
public static final int ARRAY_OF_UNICODE_CODEPOINTS
```
    The struct member offsets.
  - NUM_CHARS
```
public static final int NUM_CHARS
```
    The struct member offsets.
  - CHARDATA_FOR_RANGE
```
public static final int CHARDATA_FOR_RANGE
```
    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.
- Constructor Detail
  - STBTTPackRange
```
public STBTTPackRange(java.nio.ByteBuffer container)
```
    Creates a STBTTPackRange 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
  - font_size
```
public float font_size()
```
    Returns the value of the font_size field.
  - first_unicode_codepoint_in_range
```
public int first_unicode_codepoint_in_range()
```
    Returns the value of the first_unicode_codepoint_in_range field.
  - array_of_unicode_codepoints
```
@Nullable
public java.nio.IntBuffer array_of_unicode_codepoints()
```
    Returns a IntBuffer view of the data pointed to by the array_of_unicode_codepoints field.
  - num_chars
```
public int num_chars()
```
    Returns the value of the num_chars field.
  - chardata_for_range
```
public STBTTPackedchar.Buffer chardata_for_range()
```
    Returns a STBTTPackedchar.Buffer view of the struct array pointed to by the chardata_for_range field.
  - h_oversample
```
public byte h_oversample()
```
    Returns the value of the h_oversample field.
  - v_oversample
```
public byte v_oversample()
```
    Returns the value of the v_oversample field.
  - font_size
```
public STBTTPackRange font_size(float value)
```
    Sets the specified value to the font_size field.
  - first_unicode_codepoint_in_range
```
public STBTTPackRange first_unicode_codepoint_in_range(int value)
```
    Sets the specified value to the first_unicode_codepoint_in_range field.
  - array_of_unicode_codepoints
```
public STBTTPackRange array_of_unicode_codepoints(@Nullable
                                                  java.nio.IntBuffer value)
```
    Sets the address of the specified IntBuffer to the array_of_unicode_codepoints field.
  - num_chars
```
public STBTTPackRange num_chars(int value)
```
    Sets the specified value to the num_chars field.
  - chardata_for_range
```
public STBTTPackRange chardata_for_range(STBTTPackedchar.Buffer value)
```
    Sets the address of the specified STBTTPackedchar.Buffer to the chardata_for_range field.
  - h_oversample
```
public STBTTPackRange h_oversample(byte value)
```
    Sets the specified value to the h_oversample field.
  - v_oversample
```
public STBTTPackRange v_oversample(byte value)
```
    Sets the specified value to the v_oversample field.
  - set
```
public STBTTPackRange set(float font_size,
                          int first_unicode_codepoint_in_range,
                          @Nullable
                          java.nio.IntBuffer array_of_unicode_codepoints,
                          int num_chars,
                          STBTTPackedchar.Buffer chardata_for_range,
                          byte h_oversample,
                          byte v_oversample)
```
    Initializes this struct with the specified values.
  - set
```
public STBTTPackRange set(STBTTPackRange src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static STBTTPackRange malloc()
```
    Returns a new STBTTPackRange instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static STBTTPackRange calloc()
```
    Returns a new STBTTPackRange instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static STBTTPackRange create()
```
    Returns a new STBTTPackRange instance allocated with BufferUtils.
  - create
```
public static STBTTPackRange create(long address)
```
    Returns a new STBTTPackRange instance for the specified memory address.
  - createSafe
```
@Nullable
public static STBTTPackRange createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static STBTTPackRange.Buffer malloc(int capacity)
```
    Returns a new STBTTPackRange.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static STBTTPackRange.Buffer calloc(int capacity)
```
    Returns a new STBTTPackRange.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBTTPackRange.Buffer create(int capacity)
```
    Returns a new STBTTPackRange.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBTTPackRange.Buffer create(long address,
                                           int capacity)
```
    Create a STBTTPackRange.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static STBTTPackRange.Buffer createSafe(long address,
                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static STBTTPackRange mallocStack()
```
    Returns a new STBTTPackRange instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static STBTTPackRange callocStack()
```
    Returns a new STBTTPackRange instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static STBTTPackRange mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTPackRange instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static STBTTPackRange callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTPackRange instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static STBTTPackRange.Buffer mallocStack(int capacity)
```
    Returns a new STBTTPackRange.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static STBTTPackRange.Buffer callocStack(int capacity)
```
    Returns a new STBTTPackRange.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static STBTTPackRange.Buffer mallocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTPackRange.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static STBTTPackRange.Buffer callocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTPackRange.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
  - nfont_size
```
public static float nfont_size(long struct)
```
    Unsafe version of font_size().
  - nfirst_unicode_codepoint_in_range
```
public static int nfirst_unicode_codepoint_in_range(long struct)
```
    Unsafe version of first_unicode_codepoint_in_range().
  - narray_of_unicode_codepoints
```
@Nullable
public static java.nio.IntBuffer narray_of_unicode_codepoints(long struct)
```
    Unsafe version of array_of_unicode_codepoints.
  - nnum_chars
```
public static int nnum_chars(long struct)
```
    Unsafe version of num_chars().
  - nchardata_for_range
```
public static STBTTPackedchar.Buffer nchardata_for_range(long struct)
```
    Unsafe version of chardata_for_range().
  - nh_oversample
```
public static byte nh_oversample(long struct)
```
    Unsafe version of h_oversample().
  - nv_oversample
```
public static byte nv_oversample(long struct)
```
    Unsafe version of v_oversample().
  - nfont_size
```
public static void nfont_size(long struct,
                              float value)
```
    Unsafe version of font_size.
  - nfirst_unicode_codepoint_in_range
```
public static void nfirst_unicode_codepoint_in_range(long struct,
                                                     int value)
```
    Unsafe version of first_unicode_codepoint_in_range.
  - narray_of_unicode_codepoints
```
public static void narray_of_unicode_codepoints(long struct,
                                                @Nullable
                                                java.nio.IntBuffer value)
```
    Unsafe version of array_of_unicode_codepoints.
  - nnum_chars
```
public static void nnum_chars(long struct,
                              int value)
```
    Sets the specified value to the num_chars field of the specified struct.
  - nchardata_for_range
```
public static void nchardata_for_range(long struct,
                                       STBTTPackedchar.Buffer value)
```
    Unsafe version of chardata_for_range.
  - nh_oversample
```
public static void nh_oversample(long struct,
                                 byte value)
```
    Unsafe version of h_oversample.
  - nv_oversample
```
public static void nv_oversample(long struct,
                                 byte value)
```
    Unsafe version of v_oversample.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class STBTTPackRange

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

FONT_SIZE

FIRST_UNICODE_CODEPOINT_IN_RANGE

ARRAY_OF_UNICODE_CODEPOINTS

NUM_CHARS

CHARDATA_FOR_RANGE

H_OVERSAMPLE

V_OVERSAMPLE

Constructor Detail

STBTTPackRange

Method Detail

sizeof

font_size

first_unicode_codepoint_in_range

array_of_unicode_codepoints

num_chars

chardata_for_range

h_oversample

v_oversample

font_size

first_unicode_codepoint_in_range

array_of_unicode_codepoints

num_chars

chardata_for_range

h_oversample

v_oversample

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nfont_size

nfirst_unicode_codepoint_in_range

narray_of_unicode_codepoints

nnum_chars

nchardata_for_range

nh_oversample

nv_oversample

nfont_size

nfirst_unicode_codepoint_in_range

narray_of_unicode_codepoints

nnum_chars

nchardata_for_range

nh_oversample

nv_oversample

validate

validate