org.mini2Dx.libgdx.font

Class LibgdxBitmapFont

java.lang.Object

org.mini2Dx.libgdx.font.LibgdxBitmapFont

All Implemented Interfaces:

GameFont

public class LibgdxBitmapFont
extends java.lang.Object
implements GameFont

Field Summary

Fields

Modifier and Type	Field and Description
com.badlogic.gdx.graphics.g2d.BitmapFont	bitmapFont

Constructor Summary

Constructors

Constructor and Description
LibgdxBitmapFont()
LibgdxBitmapFont(com.badlogic.gdx.graphics.g2d.BitmapFont.BitmapFontData data, org.mini2Dx.gdx.utils.Array<TextureRegion> pageRegions, boolean integer)
LibgdxBitmapFont(com.badlogic.gdx.graphics.g2d.BitmapFont.BitmapFontData data, TextureRegion region, boolean integer)
LibgdxBitmapFont(com.badlogic.gdx.graphics.g2d.BitmapFont bitmapFont)
LibgdxBitmapFont(FileHandle fileHandle)

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
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
boolean	load(AssetManager assetManager) Loads the GameFont via the AssetManager
boolean	loadExternal() Loads the GameFont using Files.external(String)
boolean	loadInternal() Loads the GameFont using Files.internal(String)
GameFontCache	newCache() Creates a GameFontCache for this font
FontGlyphLayout	newGlyphLayout() Creates a FontGlyphLayout for this font
void	setColor(Color color) Sets the Color to render the font with
boolean	useIntegerPositions() Returns if characters use integer positions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bitmapFont

public final com.badlogic.gdx.graphics.g2d.BitmapFont bitmapFont

Constructor Detail

LibgdxBitmapFont

public LibgdxBitmapFont()

LibgdxBitmapFont

public LibgdxBitmapFont(FileHandle fileHandle)

LibgdxBitmapFont

public LibgdxBitmapFont(com.badlogic.gdx.graphics.g2d.BitmapFont.BitmapFontData data,
                        TextureRegion region,
                        boolean integer)

LibgdxBitmapFont

public LibgdxBitmapFont(com.badlogic.gdx.graphics.g2d.BitmapFont.BitmapFontData data,
                        org.mini2Dx.gdx.utils.Array<TextureRegion> pageRegions,
                        boolean integer)

LibgdxBitmapFont

public LibgdxBitmapFont(com.badlogic.gdx.graphics.g2d.BitmapFont bitmapFont)

Method Detail

loadInternal

public boolean loadInternal()

Description copied from interface: GameFont

Loads the GameFont using Files.internal(String)

Specified by:

loadInternal in interface GameFont

Returns:

True on success

loadExternal

public boolean loadExternal()

Description copied from interface: GameFont

Loads the GameFont using Files.external(String)

Specified by:

loadExternal in interface GameFont

Returns:

True on success

load

public boolean load(AssetManager assetManager)

Description copied from interface: GameFont

Loads the GameFont via the AssetManager

Specified by:

load in interface GameFont

Parameters:

assetManager - The AssetManager to use

Returns:

True on success

draw

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

Description copied from interface: GameFont

Draws text to the Graphics context using this font

Specified by:

draw in interface GameFont

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

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

Description copied from interface: GameFont

Draws text to the Graphics context using this font

Specified by:

draw in interface GameFont

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

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

Description copied from interface: GameFont

Draws text to the Graphics context using this font

Specified by:

draw in interface GameFont

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

public FontGlyphLayout newGlyphLayout()

Description copied from interface: GameFont

Creates a FontGlyphLayout for this font

Specified by:

newGlyphLayout in interface GameFont

Returns:

A new FontGlyphLayout instance

getSharedGlyphLayout

public FontGlyphLayout getSharedGlyphLayout()

Description copied from interface: GameFont

Returns a FontGlyphLayout instance associated with this GameFont instance

Specified by:

getSharedGlyphLayout in interface GameFont

Returns:

A FontGlyphLayout instance attached to this font

newCache

public GameFontCache newCache()

Description copied from interface: GameFont

Creates a GameFontCache for this font

Specified by:

newCache in interface GameFont

Returns:

A new GameFontCache instance

getColor

public Color getColor()

Description copied from interface: GameFont

Returns the Color the font will be rendered with

Specified by:

getColor in interface GameFont

Returns:

Black by default

setColor

public void setColor(Color color)

Description copied from interface: GameFont

Sets the Color to render the font with

Specified by:

setColor in interface GameFont

getLineHeight

public float getLineHeight()

Description copied from interface: GameFont

Returns the line height of the font

Specified by:

getLineHeight in interface GameFont

Returns:

getCapHeight

public float getCapHeight()

Description copied from interface: GameFont

Returns the height of a capital letter above the baseline

Specified by:

getCapHeight in interface GameFont

Returns:

useIntegerPositions

public boolean useIntegerPositions()

Description copied from interface: GameFont

Returns if characters use integer positions

Specified by:

useIntegerPositions in interface GameFont

Returns:

False if characters can be placed on half-pixels

dispose

public void dispose()

Description copied from interface: GameFont

Disposes of this font instance and its resources

Specified by:

dispose in interface GameFont