PixiJS

Interface: BitmapFontInstallOptions

BitmapFontInstallOptions

The options for installing a new BitmapFont. Once installed the font will be available for use in the BitmapText. It can be accessed by the fontFamily property of the TextStyle.

Install a new BitmapFont will create the characters provided for the font and store them in the cache. But don't worry, if a character is requested that hasn't been generated yet, it will be created on the fly.

Properties:
Name Type Default Description
chars string | (string | string[])[] BitmapFont.ALPHANUMERIC

Characters included in the font set. You can also use ranges. For example, [['a', 'z'], ['A', 'Z'], "!@#$%^&*()~{}[] "]. Don't forget to include spaces ' ' in your character set!
name string

the name of the font, this will be the name you use in the fontFamily of text style to access this font
padding number 4

Padding between glyphs on texture atlas. Lower values could mean more visual artifacts and bleeding from other glyphs, larger values increase the space required on the texture.
resolution number 1

Render resolution for glyphs.
skipKerning boolean false

Skip generation of kerning information for the BitmapFont. If true, this could potentially increase the performance, but may impact the rendered text appearance.
style TextStyle | TextStyleOptions

Style options to render with BitmapFont.

Members

chars string | (string | string[])[]

Characters included in the font set. You can also use ranges. For example, [['a', 'z'], ['A', 'Z'], "!@#$%^&*()~{}[] "]. Don't forget to include spaces ' ' in your character set!

Default Value:
  • BitmapFont.ALPHANUMERIC

name string

the name of the font, this will be the name you use in the fontFamily of text style to access this font

padding number

Padding between glyphs on texture atlas. Lower values could mean more visual artifacts and bleeding from other glyphs, larger values increase the space required on the texture.

Default Value:
  • 4

resolution number

Render resolution for glyphs.

Default Value:
  • 1

skipKerning boolean

Skip generation of kerning information for the BitmapFont. If true, this could potentially increase the performance, but may impact the rendered text appearance.

Default Value:
  • false

style TextStyle | TextStyleOptions

Style options to render with BitmapFont.