Top Description Inners Fields Constructors Methods
org.lwjgl.util.freetype

public Class FT_Bitmap

extends Struct<FT_Bitmap>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

A structure used to describe a bitmap or pixmap to the raster. Note that we now manage pixmaps of various depths through the pixel_mode field.

Layout


struct FT_Bitmap {
    unsigned int rows;
    unsigned int width;
    int pitch;
    unsigned char * buffer;
    unsigned short num_grays;
    unsigned char pixel_mode;
    unsigned char palette_mode;
    void * palette;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
FT_Bitmap.Buffer

An array of FT_Bitmap structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BUFFER

The struct member offsets.

public static final int
NUM_GRAYS

The struct member offsets.

public static final int
PALETTE

The struct member offsets.

public static final int
PALETTE_MODE

The struct member offsets.

public static final int
PITCH

The struct member offsets.

public static final int
PIXEL_MODE

The struct member offsets.

public static final int
ROWS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
WIDTH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
FT_Bitmap(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public ByteBuffer

Returns:

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

public static FT_Bitmap
calloc()

Returns a new FT_Bitmap instance allocated with memCalloc.

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

Returns a new FT_Bitmap.Buffer instance allocated with memCalloc.

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

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

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

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

protected FT_Bitmap
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 FT_Bitmap
create()

Returns a new FT_Bitmap instance allocated with BufferUtils.

public static FT_Bitmap
create(long address)

Returns a new FT_Bitmap instance for the specified memory address.

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

Returns a new FT_Bitmap.Buffer instance allocated with BufferUtils.

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

Create a FT_Bitmap.Buffer instance at the specified memory.

public static FT_Bitmap
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static FT_Bitmap
malloc()

Returns a new FT_Bitmap instance allocated with memAlloc.

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

Returns a new FT_Bitmap.Buffer instance allocated with memAlloc.

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

Returns a new FT_Bitmap instance allocated on the specified MemoryStack.

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

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

public static ByteBuffer
nbuffer(long struct, int capacity)

Unsafe version of buffer.

public static short
nnum_grays(long struct)

Unsafe version of num_grays.

public static long
npalette(long struct)

Unsafe version of palette.

public static byte
npalette_mode(long struct)

Unsafe version of palette_mode.

public static int
npitch(long struct)

Unsafe version of pitch.

public static byte
npixel_mode(long struct)

Unsafe version of pixel_mode.

public static int
nrows(long struct)

Unsafe version of rows.

public short

Returns:

the value of the num_grays field.
num_grays
()

public static int
nwidth(long struct)

Unsafe version of width.

public long

Returns:

the value of the palette field.
palette
()

public byte

Returns:

the value of the palette_mode field.
palette_mode
()

public int

Returns:

the value of the pitch field.
pitch
()

public byte

Returns:

the value of the pixel_mode field.
pixel_mode
()

public int

Returns:

the value of the rows field.
rows
()

public int
sizeof()

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

Returns sizeof(struct).
public int

Returns:

the value of the width field.
width
()

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.

BUFFERback to summary
public static final int BUFFER

The struct member offsets.

NUM_GRAYSback to summary
public static final int NUM_GRAYS

The struct member offsets.

PALETTEback to summary
public static final int PALETTE

The struct member offsets.

PALETTE_MODEback to summary
public static final int PALETTE_MODE

The struct member offsets.

PITCHback to summary
public static final int PITCH

The struct member offsets.

PIXEL_MODEback to summary
public static final int PIXEL_MODE

The struct member offsets.

ROWSback to summary
public static final int ROWS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

WIDTHback to summary
public static final int WIDTH

The struct member offsets.

Constructor Detail

FT_Bitmapback to summary
protected FT_Bitmap(long address, ByteBuffer container)
FT_Bitmapback to summary
public FT_Bitmap(ByteBuffer container)

Creates a FT_Bitmap 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

bufferback to summary
public ByteBuffer buffer(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 buffer field.

Annotations
@Nullable
@NativeType:unsigned char *
callocback to summary
public static FT_Bitmap calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static FT_Bitmap calloc(MemoryStack stack)

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

Returns a new FT_Bitmap.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

createback to summary
protected FT_Bitmap 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 FT_Bitmap create()

Returns a new FT_Bitmap instance allocated with BufferUtils.

createback to summary
public static FT_Bitmap create(long address)

Returns a new FT_Bitmap instance for the specified memory address.

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

Returns a new FT_Bitmap.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a FT_Bitmap.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FT_Bitmap createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static FT_Bitmap malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static FT_Bitmap malloc(MemoryStack stack)

Returns a new FT_Bitmap instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbufferback to summary
public static ByteBuffer nbuffer(long struct, int capacity)

Unsafe version of buffer.

Annotations
@Nullable
nnum_graysback to summary
public static short nnum_grays(long struct)

Unsafe version of num_grays.

npaletteback to summary
public static long npalette(long struct)

Unsafe version of palette.

npalette_modeback to summary
public static byte npalette_mode(long struct)

Unsafe version of palette_mode.

npitchback to summary
public static int npitch(long struct)

Unsafe version of pitch.

npixel_modeback to summary
public static byte npixel_mode(long struct)

Unsafe version of pixel_mode.

nrowsback to summary
public static int nrows(long struct)

Unsafe version of rows.

num_graysback to summary
public short num_grays()
Returns:short

the value of the num_grays field.

Annotations
@NativeType:unsigned short
nwidthback to summary
public static int nwidth(long struct)

Unsafe version of width.

paletteback to summary
public long palette()
Returns:long

the value of the palette field.

Annotations
@NativeType:void *
palette_modeback to summary
public byte palette_mode()
Returns:byte

the value of the palette_mode field.

Annotations
@NativeType:unsigned char
pitchback to summary
public int pitch()
Returns:int

the value of the pitch field.

pixel_modeback to summary
public byte pixel_mode()
Returns:byte

the value of the pixel_mode field.

Annotations
@NativeType:unsigned char
rowsback to summary
public int rows()
Returns:int

the value of the rows field.

Annotations
@NativeType:unsigned int
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
widthback to summary
public int width()
Returns:int

the value of the width field.

Annotations
@NativeType:unsigned int
org.lwjgl.util.freetype back to summary

public Class FT_Bitmap.Buffer

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

An array of FT_Bitmap structs.

Field Summary

Modifier and TypeField and Description
private static final FT_Bitmap

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new FT_Bitmap.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
public ByteBuffer

Returns:

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

protected FT_Bitmap
public short

Returns:

the value of the num_grays field.
num_grays
()

public long

Returns:

the value of the palette field.
palette
()

public byte

Returns:

the value of the palette_mode field.
palette_mode
()

public int

Returns:

the value of the pitch field.
pitch
()

public byte

Returns:

the value of the pixel_mode field.
pixel_mode
()

public int

Returns:

the value of the rows field.
rows
()

protected FT_Bitmap.Buffer
public int

Returns:

the value of the width field.
width
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final FT_Bitmap ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

bufferback to summary
public ByteBuffer buffer(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 buffer field.

Annotations
@Nullable
@NativeType:unsigned char *
getElementFactoryback to summary
protected FT_Bitmap getElementFactory()

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

Annotations
@Override
num_graysback to summary
public short num_grays()
Returns:short

the value of the num_grays field.

Annotations
@NativeType:unsigned short
paletteback to summary
public long palette()
Returns:long

the value of the palette field.

Annotations
@NativeType:void *
palette_modeback to summary
public byte palette_mode()
Returns:byte

the value of the palette_mode field.

Annotations
@NativeType:unsigned char
pitchback to summary
public int pitch()
Returns:int

the value of the pitch field.

pixel_modeback to summary
public byte pixel_mode()
Returns:byte

the value of the pixel_mode field.

Annotations
@NativeType:unsigned char
rowsback to summary
public int rows()
Returns:int

the value of the rows field.

Annotations
@NativeType:unsigned int
selfback to summary
protected FT_Bitmap.Buffer self()

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

Annotations
@Override
widthback to summary
public int width()
Returns:int

the value of the width field.

Annotations
@NativeType:unsigned int