PixiJS

Class: BitmapFontManagerClass

BitmapFontManagerClass

The BitmapFontManager is a helper class that exists to install and uninstall fonts into the cache for BitmapText objects.

new BitmapFontManagerClass ()

Members

ALPHA Array<Array<string>> readonly

This character set includes all the letters in the alphabet (both lower- and upper- case).

Example
BitmapFont.from('ExampleFont', style, { chars: BitmapFont.ALPHA })

ALPHANUMERIC Array<Array<string>> readonly

This character set is the union of BitmapFont.ALPHA and BitmapFont.NUMERIC.

ASCII Array<Array<string>> readonly

This character set consists of all the ASCII table.

See:

NUMERIC Array<Array<string>> readonly

This character set includes all decimal digits (from 0 to 9).

Example
BitmapFont.from('ExampleFont', style, { chars: BitmapFont.NUMERIC })

Methods

install (…options) BitmapFont

ts:145

Generates a bitmap-font for the given style and character set

Name Type Description
options [string | BitmapFontInstallOptions, unknown, unknown]

Setup options for font generation.
Returns:
Type Description
BitmapFont Font generated by style options.
Example
 import { BitmapFontManager, BitmapText } from 'pixi.js';

 BitmapFontManager.install('TitleFont', {
     fontFamily: 'Arial',
     fontSize: 12,
     strokeThickness: 2,
     fill: 'purple',
 });

 const title = new BitmapText({ text: 'This is the title', fontFamily: 'TitleFont' });

install (name, style, options) BitmapFont Deprecated`` : since 7.0.0

ts:162
Name Type Attributes Description
name string
style TextStyle | TextStyleOptions <optional>
options BitmapFontInstallOptions <optional>
Returns:
Type Description
BitmapFont

uninstall (name)

ts:217

Uninstalls a bitmap font from the cache.

Name Type Description
name string

The name of the bitmap font to uninstall.