InstallBitmapFontOptions
Defined in: renderer/src/assets.ts:43
Options for installBitmapFont.
Properties
Section titled “Properties”chars?
Section titled “chars?”
optionalchars?:string| (string|string[])[]
Defined in: renderer/src/assets.ts:57
Character set to bake. Accepts Pixi’s range syntax, e.g.
[["a", "z"], ["A", "Z"], "0123456789 .,!?"]. Defaults to Pixi’s
alphanumeric set — remember to include a space.
family?
Section titled “family?”
optionalfamily?:string
Defined in: renderer/src/assets.ts:75
@font-face family the loaded .ttf registers under. Defaults to
name, so the loaded face and the baked bitmap font share one
coherent identifier.
name:
string
Defined in: renderer/src/assets.ts:49
Name to register the baked font under. This is what you pass as the
bitmap.font discriminator on UIText / TextComponent, and what
installBitmapFont returns.
padding?
Section titled “padding?”
optionalpadding?:number
Defined in: renderer/src/assets.ts:64
Glyph padding in the atlas. Default 4.
resolution?
Section titled “resolution?”
optionalresolution?:number
Defined in: renderer/src/assets.ts:62
Atlas resolution multiplier. 2 keeps glyphs crisp when the text is
upscaled by a pixel-art camera. Default 2.
optionalsize?:number
Defined in: renderer/src/assets.ts:51
Glyph size (px) to bake the atlas at. Default 32.
style?
Section titled “style?”
optionalstyle?:Partial<TextStyleOptions>
Defined in: renderer/src/assets.ts:69
Extra TextStyle props baked into every glyph (fill, stroke, weight,
drop shadow…). fontFamily / fontSize are managed by this helper.