org.mini2Dx.core.font

Class BitmapFont

java.lang.Object

com.badlogic.gdx.graphics.g2d.BitmapFont

org.mini2Dx.core.font.BitmapFont

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable, GameFont

public class BitmapFont
extends com.badlogic.gdx.graphics.g2d.BitmapFont
implements GameFont

BMFont implementation of GameFont. See here

Nested Class Summary

Nested classes/interfaces inherited from class com.badlogic.gdx.graphics.g2d.BitmapFont

com.badlogic.gdx.graphics.g2d.BitmapFont.BitmapFontData, com.badlogic.gdx.graphics.g2d.BitmapFont.Glyph

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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
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
boolean	useIntegerPositions() Returns if characters use integer positions

Methods inherited from class com.badlogic.gdx.graphics.g2d.BitmapFont

dispose, draw, draw, draw, draw, draw, getAscent, getCache, getCapHeight, getColor, getData, getDescent, getLineHeight, getRegion, getRegion, getRegions, getScaleX, getScaleY, getSpaceWidth, getXHeight, isFlipped, load, newFontCache, ownsTexture, setColor, setColor, setFixedWidthGlyphs, setOwnsTexture, setUseIntegerPositions, toString, usesIntegerPositions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mini2Dx.core.font.GameFont

dispose, getCapHeight, getColor, getLineHeight, setColor

Constructor Detail

BitmapFont

public BitmapFont()

BitmapFont

public BitmapFont(com.badlogic.gdx.files.FileHandle fileHandle)

BitmapFont

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

BitmapFont

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

Method Detail

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

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