PixiJS

Class: BitmapFont

PIXI.BitmapFont

BitmapFont represents a typeface available for use with the BitmapText class. Use the install method for adding a font to be used.

new PIXI.BitmapFont (data, textures)

BitmapFont.js:17
Name Type Description
data PIXI.BitmapFontData
textures Array.<PIXI.Texture> | Object.<string, PIXI.Texture>

Members

PIXI.BitmapFont.ALPHA Array.<Array.<string>> staticreadonly

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

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

PIXI.BitmapFont.ALPHANUMERIC Array.<Array.<string>> staticreadonly

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

PIXI.BitmapFont.ASCII Array.<Array.<string>> staticreadonly

This character set consists of all the ASCII table.

See:

PIXI.BitmapFont.available Object.<string, PIXI.BitmapFont> staticreadonly

Collection of available/installed fonts.

PIXI.BitmapFont.defaultOptions PIXI.IBitmapFontOptions staticreadonly

Collection of default options when using BitmapFont.from.

Properties:
Name Type Default Description
resolution number 1
textureWidth number 512
textureHeight number 512
padding number 4
chars string | Array.<string> | Array.<Array.<string>> PIXI.BitmapFont.ALPHANUMERIC

PIXI.BitmapFont.NUMERIC Array.<Array.<string>> staticreadonly

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

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

chars object readonly

The map of characters by character code.

font string readonly

The name of the font face.

lineHeight number readonly

The line-height of the font face in pixels.

size number readonly

The size of the font face in pixels.

Methods

PIXI.BitmapFont.from (name, style, options)PIXI.BitmapFont static

BitmapFont.js:208

Generates a bitmap-font for the given style and character set. This does not support kernings yet. With style properties, only the following non-layout properties are used:

Name Type Description
name string

The name of the custom font to use with BitmapText.
style object | PIXI.TextStyle optional

Style options to render with BitmapFont.
options PIXI.IBitmapFontOptions optional

Setup options for font or name of the font.

Name Type Default Description
chars string | Array.<string> | Array.<Array.<string>> PIXI.BitmapFont.ALPHANUMERIC optional

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!
resolution number 1 optional

Render resolution for glyphs.
textureWidth number 512 optional

Optional width of atlas, smaller values to reduce memory.
textureHeight number 512 optional

Optional height of atlas, smaller values to reduce memory.
padding number 4 optional

Padding between glyphs on texture atlas.
Returns:
Type Description
PIXI.BitmapFont Font generated by style options.
Example
PIXI.BitmapFont.from("TitleFont", {
    fontFamily: "Arial",
    fontSize: 12,
    strokeThickness: 2,
    fill: "purple"
});

const title = new PIXI.BitmapText("This is the title", { fontName: "TitleFont" });

PIXI.BitmapFont.install (data, textures)PIXI.BitmapFont static

BitmapFont.js:130

Register a new bitmap font.

Name Type Description
data XMLDocument | string | PIXI.BitmapFontData

The characters map that could be provided as xml or raw string.
textures Object.<string, PIXI.Texture> | PIXI.Texture | Array.<PIXI.Texture>

List of textures for each page.
Returns:
Type Description
PIXI.BitmapFont Result font object with font, size, lineHeight and char fields.

PIXI.BitmapFont.uninstall (name) static

BitmapFont.js:156

Remove bitmap font by name.

Name Type Description
name string

destroy ()

BitmapFont.js:106

Remove references to created glyph textures.