Top Description Inners Fields Constructors Methods
org.lwjgl.stb

public Class STBTTBitmap

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

Bitmap data.

Layout


struct stbtt__bitmap {
    int w;
    int h;
    int stride;
    unsigned char * pixels;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
STBTTBitmap.Buffer

An array of STBTTBitmap structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
H

The struct member offsets.

public static final int
PIXELS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STRIDE

The struct member offsets.

public static final int
W

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
STBTTBitmap(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static STBTTBitmap
calloc()

Returns a new STBTTBitmap instance allocated with memCalloc.

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

Returns a new STBTTBitmap.Buffer instance allocated with memCalloc.

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

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

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

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

public static STBTTBitmap
callocStack()

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

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

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

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

Returns a new STBTTBitmap instance allocated with BufferUtils.

public static STBTTBitmap
create(long address)

Returns a new STBTTBitmap instance for the specified memory address.

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

Returns a new STBTTBitmap.Buffer instance allocated with BufferUtils.

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

Create a STBTTBitmap.Buffer instance at the specified memory.

public static STBTTBitmap
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
h()

the bitmap height

public STBTTBitmap
h(int value)

Sets the specified value to the h field.

public static STBTTBitmap
malloc()

Returns a new STBTTBitmap instance allocated with memAlloc.

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

Returns a new STBTTBitmap.Buffer instance allocated with memAlloc.

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

Returns a new STBTTBitmap instance allocated on the specified MemoryStack.

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

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

public static STBTTBitmap
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static int
nh(long struct)

Unsafe version of h.

public static void
nh(long struct, int value)

Unsafe version of h.

public static ByteBuffer
npixels(long struct, int capacity)

Unsafe version of pixels.

public static void
npixels(long struct, ByteBuffer value)

Unsafe version of pixels.

public static int
nstride(long struct)

Unsafe version of stride.

public static void
nstride(long struct, int value)

Unsafe version of stride.

public static int
nw(long struct)

Unsafe version of w.

public static void
nw(long struct, int value)

Unsafe version of w.

public ByteBuffer

Returns:

the bitmap data
pixels
(int
the number of elements in the returned buffer
capacity
)

public STBTTBitmap
pixels(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pixels field.

public STBTTBitmap
set(int w, int h, int stride, ByteBuffer pixels)

Initializes this struct with the specified values.

public STBTTBitmap

Returns:

this struct
set
(STBTTBitmap
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public int
stride()

the row stride, in bytes

public STBTTBitmap
stride(int value)

Sets the specified value to the stride field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

public int
w()

the bitmap width

public STBTTBitmap
w(int value)

Sets the specified value to the w field.

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

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

Hback to summary
public static final int H

The struct member offsets.

PIXELSback to summary
public static final int PIXELS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STRIDEback to summary
public static final int STRIDE

The struct member offsets.

Wback to summary
public static final int W

The struct member offsets.

Constructor Detail

STBTTBitmapback to summary
protected STBTTBitmap(long address, ByteBuffer container)
STBTTBitmapback to summary
public STBTTBitmap(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

callocback to summary
public static STBTTBitmap calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static STBTTBitmap calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new STBTTBitmap instance allocated with BufferUtils.

createback to summary
public static STBTTBitmap create(long address)

Returns a new STBTTBitmap instance for the specified memory address.

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

Returns a new STBTTBitmap.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a STBTTBitmap.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static STBTTBitmap createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
hback to summary
public int h()

the bitmap height

hback to summary
public STBTTBitmap h(int value)

Sets the specified value to the h field.

mallocback to summary
public static STBTTBitmap malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static STBTTBitmap malloc(MemoryStack stack)

Returns a new STBTTBitmap instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nhback to summary
public static int nh(long struct)

Unsafe version of h.

nhback to summary
public static void nh(long struct, int value)

Unsafe version of h.

npixelsback to summary
public static ByteBuffer npixels(long struct, int capacity)

Unsafe version of pixels.

npixelsback to summary
public static void npixels(long struct, ByteBuffer value)

Unsafe version of pixels.

nstrideback to summary
public static int nstride(long struct)

Unsafe version of stride.

nstrideback to summary
public static void nstride(long struct, int value)

Unsafe version of stride.

nwback to summary
public static int nw(long struct)

Unsafe version of w.

nwback to summary
public static void nw(long struct, int value)

Unsafe version of w.

pixelsback to summary
public ByteBuffer pixels(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

the bitmap data

Annotations
@NativeType:unsigned char *
pixelsback to summary
public STBTTBitmap pixels(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pixels field.

setback to summary
public STBTTBitmap set(int w, int h, int stride, ByteBuffer pixels)

Initializes this struct with the specified values.

setback to summary
public STBTTBitmap set(STBTTBitmap src)

Copies the specified struct data to this struct.

Parameters
src:STBTTBitmap

the source struct

Returns:STBTTBitmap

this struct

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
strideback to summary
public int stride()

the row stride, in bytes

strideback to summary
public STBTTBitmap stride(int value)

Sets the specified value to the stride field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

wback to summary
public int w()

the bitmap width

wback to summary
public STBTTBitmap w(int value)

Sets the specified value to the w field.

org.lwjgl.stb back to summary

public Class STBTTBitmap.Buffer

extends StructBuffer<STBTTBitmap, STBTTBitmap.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of STBTTBitmap structs.

Field Summary

Modifier and TypeField and Description
private static final STBTTBitmap

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new STBTTBitmap.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
protected STBTTBitmap
public int

Returns:

the value of the STBTTBitmap#h field.
h
()

public STBTTBitmap.Buffer
h(int value)

Sets the specified value to the STBTTBitmap#h field.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the STBTTBitmap#pixels field.
pixels
(int
the number of elements in the returned buffer
capacity
)

public STBTTBitmap.Buffer
pixels(ByteBuffer value)

Sets the address of the specified ByteBuffer to the STBTTBitmap#pixels field.

protected STBTTBitmap.Buffer
public int

Returns:

the value of the STBTTBitmap#stride field.
stride
()

public STBTTBitmap.Buffer
stride(int value)

Sets the specified value to the STBTTBitmap#stride field.

public int

Returns:

the value of the STBTTBitmap#w field.
w
()

public STBTTBitmap.Buffer
w(int value)

Sets the specified value to the STBTTBitmap#w field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final STBTTBitmap ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected STBTTBitmap getElementFactory()

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

Annotations
@Override
hback to summary
public int h()
Returns:int

the value of the STBTTBitmap#h field.

hback to summary
public STBTTBitmap.Buffer h(int value)

Sets the specified value to the STBTTBitmap#h field.

pixelsback to summary
public ByteBuffer pixels(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the STBTTBitmap#pixels field.

Annotations
@NativeType:unsigned char *
pixelsback to summary
public STBTTBitmap.Buffer pixels(ByteBuffer value)

Sets the address of the specified ByteBuffer to the STBTTBitmap#pixels field.

selfback to summary
protected STBTTBitmap.Buffer self()

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

Annotations
@Override
strideback to summary
public int stride()
Returns:int

the value of the STBTTBitmap#stride field.

strideback to summary
public STBTTBitmap.Buffer stride(int value)

Sets the specified value to the STBTTBitmap#stride field.

wback to summary
public int w()
Returns:int

the value of the STBTTBitmap#w field.

wback to summary
public STBTTBitmap.Buffer w(int value)

Sets the specified value to the STBTTBitmap#w field.