com.bonzaiengine.font

Interface IFont

All Known Implementing Classes:

BmfFont, SdFont

public interface IFont

Method Summary

Modifier and Type	Method and Description
int	getFontSize()
float	getHeightOverBaseLine(int fontSize)
float	getHeightUnderBaseLine(int fontSize)
float	getLineHeight(int fontSize)
TextSize	getTextSize(TextSize dst, FontPacket packet, boolean spaceAtEnd)
boolean	isBold()
boolean	isFailed()
boolean	isItalic()
boolean	isLoaded()
boolean	isLoadedOrLoad()
void	render(IGL gl, Array<FontPacket> packets, boolean forceBlend)
void	render(IGL gl, FontPacket[] packets, boolean forceBlend)
void	render(IGL gl, FontPacket packet, boolean forceBlend)
void	setFontSize(int size)
float	trim(java.lang.String text, int fontSize, int maxWidth)

Method Detail

isLoadedOrLoad

boolean isLoadedOrLoad()

Returns:

true if the IFont is loaded

isLoaded

boolean isLoaded()

Returns:

true if the IFont is loaded

isFailed

boolean isFailed()

Returns:

true if errors occures while loading this IFont

render

void render(IGL gl,
            FontPacket packet,
            boolean forceBlend)

Parameters:

gl - OpenGL context

packet - font packet to render

forceBlend - fore alpha blending (else alpha testing can be used)

render

void render(IGL gl,
            FontPacket[] packets,
            boolean forceBlend)

Parameters:

gl - OpenGL context

packets - array of FontPacket to render

render

void render(IGL gl,
            Array<FontPacket> packets,
            boolean forceBlend)

Parameters:

gl - OpenGL context

packets - list of FontPacket to render

getTextSize

TextSize getTextSize(TextSize dst,
                     FontPacket packet,
                     boolean spaceAtEnd)

Parameters:

dst - destination to store result

fontSize - -1 for default font size, else the font size in pixel

spaceAtEnd - true to take into account space at ends (default may vary from implementation, false for BMFont/SDFont)

See Also:

#getTextSize(TextSize, String, int)

getFontSize

int getFontSize()

Returns:

the font size in pixels

setFontSize

void setFontSize(int size)

Parameters:

size - new size in pixel, -1 to use default size

getLineHeight

float getLineHeight(int fontSize)

Returns:

the line height in pixels, which is equals to #getHeightOverBaseLine() + #getHeightUnderBaseLine()

getHeightOverBaseLine

float getHeightOverBaseLine(int fontSize)

Returns:

the height in pixels over the baseline

getHeightUnderBaseLine

float getHeightUnderBaseLine(int fontSize)

Returns:

the height in pixels under the base line

isBold

boolean isBold()

Returns:

true if font is bold

isItalic

boolean isItalic()

Returns:

true if font is italic

trim

float trim(java.lang.String text,
           int fontSize,
           int maxWidth)

Returns:

the number of characters within maxWidth