Class BitmapFontManagerAdvanced

Static ReadonlyALPHA

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

Static ReadonlyALPHANUMERIC

Static ReadonlyASCII

StaticdefaultOptions

Static ReadonlyNUMERIC

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

StaticgetFont

• getFont(text: string, style: TextStyle): BitmapFont

  Get a font for the specified text and style.

  Parameters

  • text: string

    The text to get the font for
  • style: TextStyle

    The style to use

  Returns BitmapFont

StaticgetLayout

• getLayout(
      text: string,
      style: TextStyle,
      trimEnd?: boolean,
  ): BitmapTextLayoutData

  Get the layout of a text for the specified style.

  Parameters

  • text: string

    The text to get the layout for
  • style: TextStyle

    The style to use
  • trimEnd: boolean = true

    Whether to ignore whitespaces at the end of each line

  Returns BitmapTextLayoutData

Staticinstall

• install(options: BitmapFontInstallOptions): BitmapFont

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

  Parameters

  • options: BitmapFontInstallOptions

    Setup options for font generation.

  Returns 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' });
  Copy

• install(
      name: string,
      style?: TextStyle | TextStyleOptions,
      options?: BitmapFontInstallOptions,
  ): BitmapFont

  Parameters

  • name: string
  • Optionalstyle: TextStyle | TextStyleOptions
  • Optionaloptions: BitmapFontInstallOptions

  Returns BitmapFont

  Deprecated

  since 7.0.0

StaticmeasureText

• measureText(
      text: string,
      style: TextStyle,
      trimEnd?: boolean,
  ): { height: number; offsetY: number; scale: number; width: number }

  Measure the text using the specified style.

  Parameters

  • text: string

    The text to measure
  • style: TextStyle

    The style to use
  • trimEnd: boolean = true

    Whether to ignore whitespaces at the end of each line

  Returns { height: number; offsetY: number; scale: number; width: number }

Staticuninstall

• uninstall(name: string): void

  Uninstalls a bitmap font from the cache.

  Parameters

  • name: string

    The name of the bitmap font to uninstall.

  Returns void