[ view source ]

class BitmapFontData

package ceramic

@:directlyUsed@:structInit

Available on all targets

Data structure containing information about a bitmap font, including character metrics, kerning and texture pages. Used by the Ceramic engine to render text using bitmap fonts.

Variables

face:String

The name of the font face

path:String

Path to the font file

pointSize:Float

Font size in points

baseSize:Float

Base size of the font in pixels

chars:IntMap<BitmapFontCharacter>

Map of font characters indexed by their character code

charCount:Int

Total number of characters in the font

distanceField:Null<BitmapFontDistanceFieldData>

Optional signed distance field data when font uses SDF rendering

pages:Array<BitmapFontDataPage>

Array of texture pages containing the font glyphs

lineHeight:Float

Height of a line of text in pixels

kernings:IntMap<IntFloatMap>

Kerning information between character pairs. First key is the first character code, second key is the second character code, value is the kerning offset in pixels.