Abstract Class: AbstractBitmapFont<FontType>

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:80

An abstract representation of a bitmap font.

Advanced

Extends

• EventEmitter<BitmapFontEvents<FontType>>

Extended by

• BitmapFont
• DynamicBitmapFont

Type Parameters

FontType

FontType

Implements

• Omit<BitmapFontData, "chars" | "pages" | "fontSize">

Constructors

Constructor

> new AbstractBitmapFont<FontType>(): AbstractBitmapFont<FontType>

Returns

AbstractBitmapFont<FontType>

Inherited from

EventEmitter.constructor

Properties

applyFillAsTint

> applyFillAsTint: boolean

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:107

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

---

baseLineOffset

> readonly baseLineOffset: number

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:99

The offset of the font face from the baseline.

Implementation of

BitmapFontData.baseLineOffset

---

baseMeasurementFontSize

> readonly baseMeasurementFontSize: number

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:109

The size of the font face in pixels.

---

baseRenderedFontSize

> protected baseRenderedFontSize: number

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:110

---

chars

> readonly chars: Record<string, CharData>

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:82

The map of characters by character string.

---

distanceField

> readonly distanceField: { range: number; type: "none" | "sdf" | "msdf"; } | undefined

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:101

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

Union Members

Type Literal

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

range

> range: number

Range of the distance field in pixels

type

> type: "none" | "sdf" | "msdf"

Type of distance field

---

undefined

Implementation of

BitmapFontData.distanceField

---

fontFamily

> readonly fontFamily: string

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:92

The name of the font face

Implementation of

BitmapFontData.fontFamily

---

fontMetrics

> readonly fontMetrics: FontMetrics

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:94

The metrics of the font face.

---

lineHeight

> readonly lineHeight: number

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:87

The line-height of the font face in pixels.

Implementation of

BitmapFontData.lineHeight

---

pages

> readonly pages: object[]

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:103

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

texture

> texture: Texture

---

prefixed

> static prefixed: string | boolean

Defined in: node_modules/eventemitter3/index.d.ts:9

Inherited from

EventEmitter.prefixed

Accessors

distanceFieldRange

Get Signature

> get distanceFieldRange(): number

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:130

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

Deprecated

since 8.0.0 Use distanceField.type instead.

Returns

number

---

distanceFieldType

Get Signature

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

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:135

The range of the distance field in pixels.

Deprecated

since 8.0.0 Use distanceField.range instead.

Returns

"none" | "sdf" | "msdf"

---

font

Get Signature

> get font(): string

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:115

The name of the font face.

Deprecated

since 8.0.0 Use fontFamily instead.

Returns

string

---

pageTextures

Get Signature

> get pageTextures(): object[]

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:120

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

Deprecated

since 8.0.0 Use pages instead.

Returns

object[]

---

size

Get Signature

> get size(): number

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:125

The size of the font face in pixels.

Deprecated

since 8.0.0 Use fontMetrics.fontSize instead.

Returns

number

Methods

addListener()

> addListener<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:45

Type Parameters

T

T extends "destroy"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.addListener

---

destroy()

> destroy(destroyTextures?): void

Defined in: node_modules/pixi.js/lib/scene/text-bitmap/AbstractBitmapFont.d.ts:136

Parameters

destroyTextures?

boolean

Returns

void

---

emit()

> emit<T>(event, ...args): boolean

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

Type Parameters

T

T extends "destroy"

Parameters

event

T

args

...ArgumentMap<BitmapFontEvents<FontType>>[Extract<T, "destroy">]

Returns

boolean

Inherited from

EventEmitter.emit

---

eventNames()

> eventNames(): "destroy"[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered listeners.

Returns

"destroy"[]

Inherited from

EventEmitter.eventNames

---

listenerCount()

> listenerCount(event): number

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

Parameters

event

"destroy"

Returns

number

Inherited from

EventEmitter.listenerCount

---

listeners()

> listeners<T>(event): (...args) => void[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

Type Parameters

T

T extends "destroy"

Parameters

event

T

Returns

(...args) => void[]

Inherited from

EventEmitter.listeners

---

off()

> off<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:69

Type Parameters

T

T extends "destroy"

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.off

---

on()

> on<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

Type Parameters

T

T extends "destroy"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.on

---

once()

> once<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

Type Parameters

T

T extends "destroy"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.once

---

removeAllListeners()

> removeAllListeners(event?): this

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

Parameters

event?

"destroy"

Returns

this

Inherited from

EventEmitter.removeAllListeners

---

removeListener()

> removeListener<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

Type Parameters

T

T extends "destroy"

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.removeListener