org.mini2Dx.core.font

Interface GameFont

All Known Implementing Classes:

BitmapFont, MonospaceFont

public interface GameFont

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes of this font instance and its resources
void	draw(Graphics g, java.lang.String str, float x, float y) Draws text to the Graphics context using this font
void	draw(Graphics g, java.lang.String str, float x, float y, float targetWidth) Draws text to the Graphics context using this font
void	draw(Graphics g, java.lang.String str, float x, float y, float targetWidth, int horizontalAlignment, boolean wrap) Draws text to the Graphics context using this font
float	getCapHeight() Returns the height of a capital letter above the baseline
com.badlogic.gdx.graphics.Color	getColor() Returns the Color the font will be rendered with
float	getLineHeight() Returns the line height of the font
FontGlyphLayout	getSharedGlyphLayout() Returns a FontGlyphLayout instance associated with this GameFont instance
GameFontCache	newCache() Creates a GameFontCache for this font
FontGlyphLayout	newGlyphLayout() Creates a FontGlyphLayout for this font
void	setColor(com.badlogic.gdx.graphics.Color color) Sets the Color to render the font with
boolean	useIntegerPositions() Returns if characters use integer positions

Method Detail

draw

void draw(Graphics g,
          java.lang.String str,
          float x,
          float y)

Draws text to the Graphics context using this font

Parameters:

g - The Graphics context

str - The text to render

x - The x coordinate to draw at

y - The y coordinate to draw at

draw

void draw(Graphics g,
          java.lang.String str,
          float x,
          float y,
          float targetWidth)

Draws text to the Graphics context using this font

Parameters:

g - The Graphics context

str - The text to render

x - The x coordinate to draw at

y - The y coordinate to draw at

targetWidth - The target width to render with (Note: text will wrap if exceeding this width)

draw

void draw(Graphics g,
          java.lang.String str,
          float x,
          float y,
          float targetWidth,
          int horizontalAlignment,
          boolean wrap)

Draws text to the Graphics context using this font

Parameters:

g - The Graphics context

str - The text to render

x - The x coordinate to draw at

y - The y coordinate to draw at

targetWidth - The target width to render with

horizontalAlignment - The horizontal alignment within the targetWidth. See Align

wrap - True if text should wrap if exceeding targetWidth, false if it should clip

newGlyphLayout

FontGlyphLayout newGlyphLayout()

Creates a FontGlyphLayout for this font

Returns:

A new FontGlyphLayout instance

getSharedGlyphLayout

FontGlyphLayout getSharedGlyphLayout()

Returns a FontGlyphLayout instance associated with this GameFont instance

Returns:

A FontGlyphLayout instance attached to this font

newCache

GameFontCache newCache()

Creates a GameFontCache for this font

Returns:

A new GameFontCache instance

getColor

com.badlogic.gdx.graphics.Color getColor()

Returns the Color the font will be rendered with

Returns:

Color.BLACK by default

setColor

void setColor(com.badlogic.gdx.graphics.Color color)

Sets the Color to render the font with

Parameters:

color -

getLineHeight

float getLineHeight()

Returns the line height of the font

Returns:

getCapHeight

float getCapHeight()

Returns the height of a capital letter above the baseline

Returns:

useIntegerPositions

boolean useIntegerPositions()

Returns if characters use integer positions

Returns:

False if characters can be placed on half-pixels

dispose

void dispose()

Disposes of this font instance and its resources