Class SdfTrFontFace<FontTypeT>

EventEmitter base class

Type Parameters

FontTypeT extends SdfFontType = SdfFontType

Hierarchy

TrFontFace
- SdfTrFontFace

Index

Constructors

constructor

new SdfTrFontFace<FontTypeT>(type, options): SdfTrFontFace<FontTypeT>
Type Parameters
- FontTypeT extends SdfFontType = SdfFontType
Parameters
- type: FontTypeT
- options: SdfTrFontFaceOptions
Returns SdfTrFontFace<FontTypeT>
Overrides TrFontFace.constructor
- Defined in src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts:69

Properties

`Readonly` data

data: undefined | SdfFontData

`Readonly` descriptors

descriptors: TrFontFaceDescriptors

`Readonly` fontFamily

fontFamily: string

`Readonly` glyphMap

glyphMap: Map<number, {
    char: string;
    chnl: number;
    height: number;
    id: number;
    page: number;
    width: number;
    x: number;
    xadvance: number;
    xoffset: number;
    y: number;
    yoffset: number;
}> = ...

Type declaration

char: string
chnl: number
height: number
id: number
page: number
width: number
x: number
xadvance: number
xoffset: number
y: number
yoffset: number

`Readonly` loaded

loaded: boolean = false

`Readonly` maxCharHeight

maxCharHeight: number = 0

Height of the tallest character in the font including the whitespace above it in SDF/vertex units.

`Readonly` metrics

metrics: null | NormalizedFontMetrics = null

`Readonly` shaper

shaper: undefined | FontShaper

`Readonly` texture

texture: ImageTexture

`Readonly` type

type: FontTypeT

Methods

`Private` checkLoaded

checkLoaded(): void
Returns void
- Defined in src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts:162

emit

emit(event, data?): void
Parameters
- event: string
- Optional data: any
Returns void
Inherited from TrFontFace.emit
- Defined in src/common/EventEmitter.ts:64

getAtlasEntry

getAtlasEntry(glyphId): GlyphAtlasEntry
Parameters
- glyphId: number
Returns GlyphAtlasEntry
- Defined in src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts:149

off

off(event, listener?): void
Parameters
- event: string
- Optional listener: ((target, data) => void)
  - - (target, data): void
    - Parameters
      
      target: any
      
      data: any
      
      Returns void
Returns void
Inherited from TrFontFace.off
- Defined in src/common/EventEmitter.ts:41

on

on(event, listener): void
Parameters
- event: string
- listener: ((target, data) => void)
  - - (target, data): void
    - Parameters
      
      target: any
      
      data: any
      
      Returns void
Returns void
Inherited from TrFontFace.on
- Defined in src/common/EventEmitter.ts:32

once

once(event, listener): void
Parameters
- event: string
- listener: ((target, data) => void)
  - - (target, data): void
    - Parameters
      
      target: any
      
      data: any
      
      Returns void
Returns void
Inherited from TrFontFace.once
- Defined in src/common/EventEmitter.ts:56

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from TrFontFace.removeAllListeners
- Defined in src/common/EventEmitter.ts:74

`Static` convertToCssFontFaceDescriptors

convertToCssFontFaceDescriptors(descriptors): FontFaceDescriptors
Convert a TrFontFaceDescriptors to a FontFaceDescriptors which differ slightly
Parameters
- descriptors: TrFontFaceDescriptors
Returns FontFaceDescriptors
Inherited from TrFontFace.convertToCssFontFaceDescriptors
- Defined in src/core/text-rendering/font-face-types/TrFontFace.ts:173

Class SdfTrFontFace<FontTypeT>

Type Parameters

FontTypeT extends SdfFontType = SdfFontType

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

FontTypeT extends SdfFontType = SdfFontType

Parameters

type: FontTypeT

options: SdfTrFontFaceOptions

Returns SdfTrFontFace<FontTypeT>

Properties

Readonly data

Readonly descriptors

Readonly fontFamily

Readonly glyphMap

Type declaration

char: string

chnl: number

height: number

id: number

page: number

width: number

x: number

xadvance: number

xoffset: number

y: number

yoffset: number

Readonly loaded

Readonly maxCharHeight

Readonly metrics

Readonly shaper

Readonly texture

Readonly type

Methods

Private checkLoaded

Returns void

emit

Parameters

event: string

Optional data: any

Returns void

getAtlasEntry

Parameters

glyphId: number

Returns GlyphAtlasEntry

off

Parameters

event: string

Optional listener: ((target, data) => void)

Parameters

target: any

data: any

Returns void

Returns void

on

Parameters

event: string

listener: ((target, data) => void)

Parameters

target: any

data: any

Returns void

Returns void

once

Parameters

event: string

listener: ((target, data) => void)

Parameters

target: any

data: any

Returns void

Returns void

removeAllListeners

Returns void

`Readonly` data

`Readonly` descriptors

`Readonly` fontFamily

`Readonly` glyphMap

`Readonly` loaded

`Readonly` maxCharHeight

`Readonly` metrics

`Readonly` shaper

`Readonly` texture

`Readonly` type

`Private` checkLoaded

`Optional` data: any

`Optional` listener: ((target, data) => void)

`Static` convertToCssFontFaceDescriptors