Class BitmapFont

constructor

• new BitmapFont(
      data: BitmapFontData,
      textures: Texture<Resource>[] | Dict<Texture<Resource>>,
      ownsTextures?: boolean,
  ): BitmapFont

• Parameters

  • data: BitmapFontData
  • textures: Texture<Resource>[] | Dict<Texture<Resource>>
  • OptionalownsTextures: boolean

    Setting to true will destroy page textures when the font is uninstalled.

  Returns BitmapFont

Readonlychars

ReadonlydistanceFieldRange

ReadonlydistanceFieldType

Readonlyfont

ReadonlylineHeight

ReadonlypageTextures

Readonlysize

Static ReadonlyALPHA

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

Static ReadonlyALPHANUMERIC

Static ReadonlyASCII

Static Readonlyavailable

Static ReadonlydefaultOptions

Static ReadonlyNUMERIC

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

destroy

• destroy(): void

• Remove references to created glyph textures.

  Returns void

Staticfrom

• from(
      name: string,
      textStyle?: Pixi.TextStyle | Partial<ITextStyle>,
      options?: IBitmapFontOptions,
  ): BitmapFont

• 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:

  • PIXI.TextStyle#dropShadow|dropShadow
  • PIXI.TextStyle#dropShadowDistance|dropShadowDistance
  • PIXI.TextStyle#dropShadowColor|dropShadowColor
  • PIXI.TextStyle#dropShadowBlur|dropShadowBlur
  • PIXI.TextStyle#dropShadowAngle|dropShadowAngle
  • PIXI.TextStyle#fill|fill
  • PIXI.TextStyle#fillGradientStops|fillGradientStops
  • PIXI.TextStyle#fillGradientType|fillGradientType
  • PIXI.TextStyle#fontFamily|fontFamily
  • PIXI.TextStyle#fontSize|fontSize
  • PIXI.TextStyle#fontVariant|fontVariant
  • PIXI.TextStyle#fontWeight|fontWeight
  • PIXI.TextStyle#lineJoin|lineJoin
  • PIXI.TextStyle#miterLimit|miterLimit
  • PIXI.TextStyle#stroke|stroke
  • PIXI.TextStyle#strokeThickness|strokeThickness
  • PIXI.TextStyle#textBaseline|textBaseline

  Parameters

  • name: string

    The name of the custom font to use with BitmapText.
  • OptionaltextStyle: Pixi.TextStyle | Partial<ITextStyle>

    Style options to render with BitmapFont.
  • Optionaloptions: IBitmapFontOptions

    Setup options for font or name of the font.

  Returns BitmapFont

  Font generated by style options.

  Example

  import { BitmapFont, BitmapText } from 'pixi.js';
  
  BitmapFont.from('TitleFont', {
      fontFamily: 'Arial',
      fontSize: 12,
      strokeThickness: 2,
      fill: 'purple',
  });
  
  const title = new BitmapText('This is the title', { fontName: 'TitleFont' });
  Copy

Staticinstall

• install(
      data: string | XMLDocument | BitmapFontData,
      textures: Texture<Resource> | Texture<Resource>[] | Dict<Texture<Resource>>,
      ownsTextures?: boolean,
  ): BitmapFont

• Register a new bitmap font.

  Parameters

  • data: string | XMLDocument | BitmapFontData

    The characters map that could be provided as xml or raw string.
  • textures: Texture<Resource> | Texture<Resource>[] | Dict<Texture<Resource>>

    List of textures for each page.
  • OptionalownsTextures: boolean

    Set to true to destroy page textures when the font is uninstalled. By default fonts created with BitmapFont.from or from the BitmapFontLoader are true.

  Returns BitmapFont

  Result font object with font, size, lineHeight and char fields.

Staticuninstall

• uninstall(name: string): void

• Remove bitmap font by name.

  Parameters

  • name: string

    Name of the font to uninstall.

  Returns void