pixi.js
    Preparing search index...

    Class AbstractBitmapFont<FontType>Abstract Advanced

    An abstract representation of a bitmap font.

    Type Parameters

    • FontType

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    applyFillAsTint baseLineOffset baseMeasurementFontSize chars distanceField fontFamily fontMetrics lineHeight pages

    Accessors

    distanceFieldRange distanceFieldType font pageTextures size

    Methods

    destroy

    Constructors

    Properties

    applyFillAsTint: boolean = true

    should the fill for this font be applied as a tint to the text.

    baseLineOffset: number = 0

    The offset of the font face from the baseline.

    baseMeasurementFontSize: number = 100

    The size of the font face in pixels.

    chars: Record<string, CharData> = ...

    The map of characters by character code.

    distanceField: { range: number; type: "none" | "sdf" | "msdf" } = ...

    The range and type of the distance field for this font.

    Type declaration

    • range: number

      Range of the distance field in pixels

    • type: "none" | "sdf" | "msdf"

      Type of distance field

    fontFamily: string = ''

    The name of the font face

    fontMetrics: FontMetrics = ...

    The metrics of the font face.

    lineHeight: number = 0

    The line-height of the font face in pixels.

    pages: { texture: Texture }[] = []

    The map of base page textures (i.e., sheets of glyphs).

    Accessors

    • get distanceFieldRange(): number

      The kind of distance field for this font or "none".

      Returns number

      since 8.0.0 Use distanceField.type instead.

    • get distanceFieldType(): "none" | "sdf" | "msdf"

      The range of the distance field in pixels.

      Returns "none" | "sdf" | "msdf"

      since 8.0.0 Use distanceField.range instead.

    • get font(): string

      The name of the font face.

      Returns string

      since 8.0.0 Use fontFamily instead.

    • get pageTextures(): { texture: Texture }[]

      The map of base page textures (i.e., sheets of glyphs).

      Returns { texture: Texture }[]

      since 8.0.0 Use pages instead.

    • get size(): number

      The size of the font face in pixels.

      Returns number

      since 8.0.0 Use fontMetrics.fontSize instead.

    Methods

    • Parameters

      • destroyTextures: boolean = false

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods