Class BitmapFont

constructor

• new BitmapFont(data, textures, ownsTextures?): BitmapFont

• Parameters

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

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

  Returns BitmapFont

Readonly chars

Readonly distanceFieldRange

Readonly distanceFieldType

Readonly font

Readonly lineHeight

Readonly pageTextures

Readonly size

Static Readonly ALPHA

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

Static Readonly ALPHANUMERIC

Static Readonly ASCII

Static Readonly NUMERIC

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

Static Readonly available

Static Readonly defaultOptions

destroy

• destroy(): void

• Remove references to created glyph textures.

  Returns void

Static from

• from(name, textStyle?, options?): 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.
  • Optional textStyle: Pixi.TextStyle | Partial<ITextStyle>

    Style options to render with BitmapFont.
  • Optional options: 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

Static install

• install(data, textures, ownsTextures?): 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.
  • Optional ownsTextures: 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.

Static uninstall

• uninstall(name): void

• Remove bitmap font by name.

  Parameters

  • name: string

    Name of the font to uninstall.

  Returns void