Modifier and Type	Class and Description
public static class	BitmapFontWriter.FontInfo The font "info" line; everything except padding and override metrics are ignored by libGDX's BitmapFont reader, it is otherwise just useful for clean and organized output.
public static enum	BitmapFontWriter.OutputFormat The output format.
public static class	BitmapFontWriter.Padding The Padding parameter for FontInfo.
public static class	BitmapFontWriter.Spacing The spacing parameter for FontInfo.

Modifier and Type	Field and Description
private static BitmapFontWriter.OutputFormat	format The output format

Access	Constructor and Description
public	BitmapFontWriter()

Method Summary

Modifier and Type	Method and Description
public static BitmapFontWriter.OutputFormat	Returns: the output format getOutputFormat() Returns the currently used output format.
private static String	quote(Object params)
private static String	quote(Object params, boolean spaceAfter)
public static void	setOutputFormat(BitmapFontWriter.OutputFormat the output format to use fmt) Sets the AngelCodeFont output format for subsequent writes; can be text (for libGDX) or XML (for other engines, like Pixi.js).
public static void	writeFont(BitmapFont.BitmapFontData the bitmap font fontData, String[] the references to each texture page image file, generally in the same folder as outFntFile pageRefs, FileHandle the font file to save to (typically ends with '.fnt') outFntFile, BitmapFontWriter.FontInfo the optional info for the file header; can be null info, int the width of your texture pages scaleW, int the height of your texture pages scaleH) Writes the given BitmapFontData to a file, using the specified `pageRefs` strings as the image paths for each texture page.
public static void	writeFont(BitmapFont.BitmapFontData the font data fontData, Pixmap[] the pixmaps to write as PNGs pages, FileHandle the output file for the font definition outFntFile, BitmapFontWriter.FontInfo the optional font info for the header file, can be null info) A utility method which writes the given font data to a file.
public static String[]	Returns: the array of string references to be used with `writeFont` writePixmaps(Pixmap[] the pages of pixmap data to write pages, FileHandle the output directory outputDir, String the file names for the output images fileName) A utility method to write the given array of pixmaps to the given output directory, with the specified file name.
public static String[]	Returns: the file refs writePixmaps(Array<PixmapPacker.Page> the pages containing the Pixmaps pages, FileHandle the output directory outputDir, String the file name fileName) A convenience method to write pixmaps by page; typically returned from a PixmapPacker when used alongside FreeTypeFontGenerator.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

format	back to summary
private static BitmapFontWriter.OutputFormat format The output format

Constructor Detail

BitmapFontWriter	back to summary
public BitmapFontWriter()

Method Detail

getOutputFormat	back to summary
public static BitmapFontWriter.OutputFormat getOutputFormat() Returns the currently used output format. Returns:BitmapFontWriter.OutputFormat the output format

getOutputFormat

back to summary

public static BitmapFontWriter.OutputFormat getOutputFormat()

Returns the currently used output format.

Returns:BitmapFontWriter.OutputFormat: the output format

quote	back to summary
private static String quote(Object params)

quote	back to summary
private static String quote(Object params, boolean spaceAfter)

setOutputFormat	back to summary
public static void setOutputFormat(BitmapFontWriter.OutputFormat fmt) Sets the AngelCodeFont output format for subsequent writes; can be text (for libGDX) or XML (for other engines, like Pixi.js). Parameters fmt:BitmapFontWriter.OutputFormat the output format to use

setOutputFormat

back to summary

public static void setOutputFormat(BitmapFontWriter.OutputFormat fmt)

Sets the AngelCodeFont output format for subsequent writes; can be text (for libGDX) or XML (for other engines, like Pixi.js).

Parameters

fmt:BitmapFontWriter.OutputFormat: the output format to use

writeFont back to summary

writeFont	back to summary
public static void writeFont(BitmapFont.BitmapFontData fontData, String[] pageRefs, FileHandle outFntFile, BitmapFontWriter.FontInfo info, int scaleW, int scaleH) Writes the given BitmapFontData to a file, using the specified `pageRefs` strings as the image paths for each texture page. The glyphs in BitmapFontData have a "page" id, which references the index of the pageRef you specify here. The FontInfo parameter is useful for cleaner output; such as including a size and font face name hint. However, it can be null to use default values. libGDX ignores most of the "info" line when reading back fonts, only padding is used. Padding also affects the size, location, and offset of the glyphs that are output. Likewise, the scaleW and scaleH are only for cleaner output. They are currently ignored by libGDX's reader. For maximum compatibility with other BMFont tools, you should use the width and height of your texture pages (each page should be the same size). Parameters fontData:BitmapFont.BitmapFontData the bitmap font pageRefs:String[] the references to each texture page image file, generally in the same folder as outFntFile outFntFile:FileHandle the font file to save to (typically ends with '.fnt') info:BitmapFontWriter.FontInfo the optional info for the file header; can be null scaleW:int the width of your texture pages scaleH:int the height of your texture pages

public static void writeFont(BitmapFont.BitmapFontData fontData, String[] pageRefs, FileHandle outFntFile, BitmapFontWriter.FontInfo info, int scaleW, int scaleH)

Writes the given BitmapFontData to a file, using the specified pageRefs strings as the image paths for each texture page. The glyphs in BitmapFontData have a "page" id, which references the index of the pageRef you specify here. The FontInfo parameter is useful for cleaner output; such as including a size and font face name hint. However, it can be null to use default values. libGDX ignores most of the "info" line when reading back fonts, only padding is used. Padding also affects the size, location, and offset of the glyphs that are output. Likewise, the scaleW and scaleH are only for cleaner output. They are currently ignored by libGDX's reader. For maximum compatibility with other BMFont tools, you should use the width and height of your texture pages (each page should be the same size).

Parameters

fontData:BitmapFont.BitmapFontData: the bitmap font
pageRefs:String[]: the references to each texture page image file, generally in the same folder as outFntFile
outFntFile:FileHandle: the font file to save to (typically ends with '.fnt')
info:BitmapFontWriter.FontInfo: the optional info for the file header; can be null
scaleW:int: the width of your texture pages
scaleH:int: the height of your texture pages

writeFont back to summary

writeFont	back to summary
public static void writeFont(BitmapFont.BitmapFontData fontData, Pixmap[] pages, FileHandle outFntFile, BitmapFontWriter.FontInfo info) A utility method which writes the given font data to a file. The specified pixmaps are written to the parent directory of `outFntFile`, using that file's name without an extension for the PNG file name(s). The specified FontInfo is optional, and can be null. Typical usage looks like this: BitmapFontWriter.writeFont(myFontData, myFontPixmaps, Gdx.files.external("fonts/output.fnt"), new FontInfo("Arial", 16)); Parameters fontData:BitmapFont.BitmapFontData the font data pages:Pixmap[] the pixmaps to write as PNGs outFntFile:FileHandle the output file for the font definition info:BitmapFontWriter.FontInfo the optional font info for the header file, can be null

public static void writeFont(BitmapFont.BitmapFontData fontData, Pixmap[] pages, FileHandle outFntFile, BitmapFontWriter.FontInfo info)

A utility method which writes the given font data to a file. The specified pixmaps are written to the parent directory of outFntFile, using that file's name without an extension for the PNG file name(s). The specified FontInfo is optional, and can be null. Typical usage looks like this:

BitmapFontWriter.writeFont(myFontData, myFontPixmaps, Gdx.files.external("fonts/output.fnt"), new FontInfo("Arial", 16));

Parameters

fontData:BitmapFont.BitmapFontData: the font data
pages:Pixmap[]: the pixmaps to write as PNGs
outFntFile:FileHandle: the output file for the font definition
info:BitmapFontWriter.FontInfo: the optional font info for the header file, can be null

writePixmaps back to summary

writePixmaps	back to summary
public static String[] writePixmaps(Pixmap[] pages, FileHandle outputDir, String fileName) A utility method to write the given array of pixmaps to the given output directory, with the specified file name. If the pages array is of length 1, then the resulting file ref will look like: "fileName.png". If the pages array is greater than length 1, the resulting file refs will be appended with "_N", such as "fileName_0.png", "fileName_1.png", "fileName_2.png" etc. The returned string array can then be passed to the `writeFont` method. Note None of the pixmaps will be disposed. Parameters pages:Pixmap[] the pages of pixmap data to write outputDir:FileHandle the output directory fileName:String the file names for the output images Returns:String[] the array of string references to be used with `writeFont`

public static String[] writePixmaps(Pixmap[] pages, FileHandle outputDir, String fileName)

A utility method to write the given array of pixmaps to the given output directory, with the specified file name. If the pages array is of length 1, then the resulting file ref will look like: "fileName.png". If the pages array is greater than length 1, the resulting file refs will be appended with "_N", such as "fileName_0.png", "fileName_1.png", "fileName_2.png" etc. The returned string array can then be passed to the writeFont method.

Note

None of the pixmaps will be disposed.

Parameters

pages:Pixmap[]: the pages of pixmap data to write
outputDir:FileHandle: the output directory
fileName:String: the file names for the output images

Returns:String[]

the array of string references to be used with writeFont

writePixmaps	back to summary
public static String[] writePixmaps(Array<PixmapPacker.Page> pages, FileHandle outputDir, String fileName) A convenience method to write pixmaps by page; typically returned from a PixmapPacker when used alongside FreeTypeFontGenerator. Parameters pages:Array<PixmapPacker.Page> the pages containing the Pixmaps outputDir:FileHandle the output directory fileName:String the file name Returns:String[] the file refs

writePixmaps

back to summary

public static String[] writePixmaps(Array<PixmapPacker.Page> pages, FileHandle outputDir, String fileName)

A convenience method to write pixmaps by page; typically returned from a PixmapPacker when used alongside FreeTypeFontGenerator.

Parameters

pages:Array<PixmapPacker.Page>: the pages containing the Pixmaps
outputDir:FileHandle: the output directory
fileName:String: the file name

Returns:String[]

the file refs

com.badlogic.gdx.tools.bmfont back to summary

public Class BitmapFontWriter.FontInfo

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.tools.bmfont.BitmapFontWriter.FontInfo

The font "info" line; everything except padding and override metrics are ignored by libGDX's BitmapFont reader, it is otherwise just useful for clean and organized output.

Field Summary

Modifier and Type	Field and Description
public int	aa Amount of anti-aliasing that was applied to the font
public float	ascent
public boolean	bold Whether the font is bold
public float	capHeight
public String	charset The charset; or null/empty for default
public float	descent
public float	down
public String	face Face name
public boolean	hasOverrideMetrics Override metrics
public boolean	italic Whether the font is italic
public float	lineHeight
public int	outline
public BitmapFontWriter.Padding	padding Padding that was applied to the font
public int	size Font size (pt)
public boolean	smooth Whether smoothing is applied
public float	spaceXAdvance
public BitmapFontWriter.Spacing	spacing Horizontal/vertical spacing that was applied to font
public int	stretchH Stretch for height; default to 100%
public boolean	unicode Whether the font uses unicode glyphs
public float	xHeight

Constructor Summary

Access	Constructor and Description
public	FontInfo()
public	FontInfo(String face, int size)

Method Summary

Modifier and Type	Method and Description
public void	overrideMetrics(BitmapFont.BitmapFontData data)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

aa	back to summary
public int aa Amount of anti-aliasing that was applied to the font

ascent	back to summary
public float ascent

bold	back to summary
public boolean bold Whether the font is bold

capHeight	back to summary
public float capHeight

charset	back to summary
public String charset The charset; or null/empty for default

descent	back to summary
public float descent

down	back to summary
public float down

face	back to summary
public String face Face name

hasOverrideMetrics	back to summary
public boolean hasOverrideMetrics Override metrics

italic	back to summary
public boolean italic Whether the font is italic

lineHeight	back to summary
public float lineHeight

outline	back to summary
public int outline

padding	back to summary
public BitmapFontWriter.Padding padding Padding that was applied to the font

size	back to summary
public int size Font size (pt)

smooth	back to summary
public boolean smooth Whether smoothing is applied

spaceXAdvance	back to summary
public float spaceXAdvance

spacing	back to summary
public BitmapFontWriter.Spacing spacing Horizontal/vertical spacing that was applied to font

stretchH	back to summary
public int stretchH Stretch for height; default to 100%

unicode	back to summary
public boolean unicode Whether the font uses unicode glyphs

xHeight	back to summary
public float xHeight

Constructor Detail

FontInfo	back to summary
public FontInfo()

FontInfo	back to summary
public FontInfo(String face, int size)

Method Detail

overrideMetrics	back to summary
public void overrideMetrics(BitmapFont.BitmapFontData data)

com.badlogic.gdx.tools.bmfont back to summary

public final Enum BitmapFontWriter.OutputFormat

Class Inheritance

extends Enum<BitmapFontWriter.OutputFormat>

java.lang.Object
java.lang.Enum
com.badlogic.gdx.tools.bmfont.BitmapFontWriter.OutputFormat

The output format.

Field Summary

Modifier and Type	Field and Description
public static final BitmapFontWriter.OutputFormat	Text AngelCodeFont text format
public static final BitmapFontWriter.OutputFormat	XML AngelCodeFont XML format

Constructor Summary

Access	Constructor and Description
private	OutputFormat()

Method Summary

Modifier and Type	Method and Description
public static BitmapFontWriter.OutputFormat	valueOf(String name)
public static BitmapFontWriter.OutputFormat[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

Text	back to summary
public static final BitmapFontWriter.OutputFormat Text AngelCodeFont text format

XML	back to summary
public static final BitmapFontWriter.OutputFormat XML AngelCodeFont XML format

Constructor Detail

OutputFormat	back to summary
private OutputFormat()

Method Detail

valueOf	back to summary
public static BitmapFontWriter.OutputFormat valueOf(String name)

values	back to summary
public static BitmapFontWriter.OutputFormat[] values()

com.badlogic.gdx.tools.bmfont back to summary

public Class BitmapFontWriter.Padding

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.tools.bmfont.BitmapFontWriter.Padding

The Padding parameter for FontInfo.

Field Summary

Modifier and Type	Field and Description
public int	down
public int	left
public int	right
public int	up

Constructor Summary

Access	Constructor and Description
public	Padding()
public	Padding(int up, int down, int left, int right)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

down	back to summary
public int down

left	back to summary
public int left

right	back to summary
public int right

up	back to summary
public int up

Constructor Detail

Padding	back to summary
public Padding()

Padding	back to summary
public Padding(int up, int down, int left, int right)

public Class BitmapFontWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class BitmapFontWriter.FontInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum BitmapFontWriter.OutputFormat

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class BitmapFontWriter.Padding

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public Class BitmapFontWriter.Spacing

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail