STBTTBitmap (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class STBTTBitmap
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Bitmap data.
Member documentation
- w – the bitmap width
- h – the bitmap height
- stride – the row stride, in bytes
- pixels – the bitmap data
Layout
```
 struct stbtt__bitmap {
     int w;
     int h;
     int stride;
     unsigned char * pixels;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`H` The struct member offsets.
`static int`	`PIXELS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STRIDE` The struct member offsets.
`static int`	`W` 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

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

Constructors
Constructor and Description
`STBTTBitmap(java.nio.ByteBuffer container)` Creates a `STBTTBitmap` 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 STBTTBitmap`	`calloc()` Returns a new `STBTTBitmap` instance allocated with `memCalloc`.
`static STBTTBitmap.Buffer`	`calloc(int capacity)` Returns a new `STBTTBitmap.Buffer` instance allocated with `memCalloc`.
`static STBTTBitmap`	`callocStack()` Returns a new `STBTTBitmap` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBTTBitmap.Buffer`	`callocStack(int capacity)` Returns a new `STBTTBitmap.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static STBTTBitmap.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTBitmap.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static STBTTBitmap`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTBitmap` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static STBTTBitmap`	`create()` Returns a new `STBTTBitmap` instance allocated with `BufferUtils`.
`static STBTTBitmap.Buffer`	`create(int capacity)` Returns a new `STBTTBitmap.Buffer` instance allocated with `BufferUtils`.
`static STBTTBitmap`	`create(long address)` Returns a new `STBTTBitmap` instance for the specified memory address.
`static STBTTBitmap.Buffer`	`create(long address, int capacity)` Create a `STBTTBitmap.Buffer` instance at the specified memory.
`static STBTTBitmap`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static STBTTBitmap.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`h()` Returns the value of the `h` field.
`STBTTBitmap`	`h(int value)` Sets the specified value to the `h` field.
`static STBTTBitmap`	`malloc()` Returns a new `STBTTBitmap` instance allocated with `memAlloc`.
`static STBTTBitmap.Buffer`	`malloc(int capacity)` Returns a new `STBTTBitmap.Buffer` instance allocated with `memAlloc`.
`static STBTTBitmap`	`mallocStack()` Returns a new `STBTTBitmap` instance allocated on the thread-local `MemoryStack`.
`static STBTTBitmap.Buffer`	`mallocStack(int capacity)` Returns a new `STBTTBitmap.Buffer` instance allocated on the thread-local `MemoryStack`.
`static STBTTBitmap.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTBitmap.Buffer` instance allocated on the specified `MemoryStack`.
`static STBTTBitmap`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `STBTTBitmap` instance allocated on the specified `MemoryStack`.
`static int`	`nh(long struct)` Unsafe version of `h()`.
`static void`	`nh(long struct, int value)` Unsafe version of `h`.
`static void`	`npixels(long struct, java.nio.ByteBuffer value)` Unsafe version of `pixels`.
`static java.nio.ByteBuffer`	`npixels(long struct, int capacity)` Unsafe version of `pixels`.
`static int`	`nstride(long struct)` Unsafe version of `stride()`.
`static void`	`nstride(long struct, int value)` Unsafe version of `stride`.
`static int`	`nw(long struct)` Unsafe version of `w()`.
`static void`	`nw(long struct, int value)` Unsafe version of `w`.
`STBTTBitmap`	`pixels(java.nio.ByteBuffer value)` Sets the address of the specified `ByteBuffer` to the `pixels` field.
`java.nio.ByteBuffer`	`pixels(int capacity)` Returns a `ByteBuffer` view of the data pointed to by the `pixels` field.
`STBTTBitmap`	`set(int w, int h, int stride, java.nio.ByteBuffer pixels)` Initializes this struct with the specified values.
`STBTTBitmap`	`set(STBTTBitmap src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`stride()` Returns the value of the `stride` field.
`STBTTBitmap`	`stride(int value)` Sets the specified value to the `stride` 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.
`int`	`w()` Returns the value of the `w` field.
`STBTTBitmap`	`w(int value)` Sets the specified value to the `w` 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.
  - W
```
public static final int W
```
    The struct member offsets.
  - H
```
public static final int H
```
    The struct member offsets.
  - STRIDE
```
public static final int STRIDE
```
    The struct member offsets.
  - PIXELS
```
public static final int PIXELS
```
    The struct member offsets.
- Constructor Detail
  - STBTTBitmap
```
public STBTTBitmap(java.nio.ByteBuffer container)
```
    Creates a STBTTBitmap 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
  - w
```
public int w()
```
    Returns the value of the w field.
  - h
```
public int h()
```
    Returns the value of the h field.
  - stride
```
public int stride()
```
    Returns the value of the stride 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
  - w
```
public STBTTBitmap w(int value)
```
    Sets the specified value to the w field.
  - h
```
public STBTTBitmap h(int value)
```
    Sets the specified value to the h field.
  - stride
```
public STBTTBitmap stride(int value)
```
    Sets the specified value to the stride field.
  - pixels
```
public STBTTBitmap pixels(java.nio.ByteBuffer value)
```
    Sets the address of the specified ByteBuffer to the pixels field.
  - set
```
public STBTTBitmap set(int w,
                       int h,
                       int stride,
                       java.nio.ByteBuffer pixels)
```
    Initializes this struct with the specified values.
  - set
```
public STBTTBitmap set(STBTTBitmap src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static STBTTBitmap malloc()
```
    Returns a new STBTTBitmap instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static STBTTBitmap calloc()
```
    Returns a new STBTTBitmap instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static STBTTBitmap create()
```
    Returns a new STBTTBitmap instance allocated with BufferUtils.
  - create
```
public static STBTTBitmap create(long address)
```
    Returns a new STBTTBitmap instance for the specified memory address.
  - createSafe
```
@Nullable
public static STBTTBitmap createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static STBTTBitmap.Buffer malloc(int capacity)
```
    Returns a new STBTTBitmap.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static STBTTBitmap.Buffer calloc(int capacity)
```
    Returns a new STBTTBitmap.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBTTBitmap.Buffer create(int capacity)
```
    Returns a new STBTTBitmap.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static STBTTBitmap.Buffer create(long address,
                                        int capacity)
```
    Create a STBTTBitmap.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static STBTTBitmap.Buffer createSafe(long address,
                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static STBTTBitmap mallocStack()
```
    Returns a new STBTTBitmap instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static STBTTBitmap callocStack()
```
    Returns a new STBTTBitmap instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static STBTTBitmap mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTBitmap instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static STBTTBitmap callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTBitmap instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static STBTTBitmap.Buffer mallocStack(int capacity)
```
    Returns a new STBTTBitmap.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static STBTTBitmap.Buffer callocStack(int capacity)
```
    Returns a new STBTTBitmap.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static STBTTBitmap.Buffer mallocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTBitmap.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static STBTTBitmap.Buffer callocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new STBTTBitmap.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
  - nw
```
public static int nw(long struct)
```
    Unsafe version of w().
  - nh
```
public static int nh(long struct)
```
    Unsafe version of h().
  - nstride
```
public static int nstride(long struct)
```
    Unsafe version of stride().
  - npixels
```
public static java.nio.ByteBuffer npixels(long struct,
                                          int capacity)
```
    Unsafe version of pixels.
  - nw
```
public static void nw(long struct,
                      int value)
```
    Unsafe version of w.
  - nh
```
public static void nh(long struct,
                      int value)
```
    Unsafe version of h.
  - nstride
```
public static void nstride(long struct,
                           int value)
```
    Unsafe version of stride.
  - npixels
```
public static void npixels(long struct,
                           java.nio.ByteBuffer value)
```
    Unsafe version of pixels.
  - 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 STBTTBitmap

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

W

H

STRIDE

PIXELS

Constructor Detail

STBTTBitmap

Method Detail

sizeof

w

h

stride

pixels

w

h

stride

pixels

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nw

nh

nstride

npixels

nw

nh

nstride

npixels

validate

validate