Font

constructor

• new Font(
      source?: Readonly<
          Pick<
              Font,
              | typeof graphicsNative
              | "isSmooth"
              | typeof fontRevision
              | "getInfo"
              | "getGlyph"
              | "getGlyphById"
              | "hasGlyph"
              | "getKerning"
              | "getAscent"
              | "getDescent"
              | "getLineSpacing"
              | "getUnderlinePosition"
              | "getUnderlineThickness"
              | "getTexture",
          >,
      >,
  ): Font

  Creates an empty font or copies an existing font.

  Parameters

  sourceOptional

  Readonly<
      Pick<
          Font,
          | typeof graphicsNative
          | "isSmooth"
          | typeof fontRevision
          | "getInfo"
          | "getGlyph"
          | "getGlyphById"
          | "hasGlyph"
          | "getKerning"
          | "getAscent"
          | "getDescent"
          | "getLineSpacing"
          | "getUnderlinePosition"
          | "getUnderlineThickness"
          | "getTexture",
      >,
  >

  Returns

  Font

  Source & inheritance

getAscent

• getAscent(size: number): number

  Returns the ascent in pixels for the specified pixel character size.

  Parameters

  size

  number

  Returns

  number

  Source & inheritance

getDescent

• getDescent(size: number): number

  Returns the descent in pixels for the specified pixel character size.

  Parameters

  size

  number

  Returns

  number

  Source & inheritance

getGlyph

• getGlyph(
      codePoint: number,
      characterSize: number,
      bold: boolean,
      outlineThickness?: number,
  ): ReadonlyValue<Glyph>

  Gets the cached glyph for a Unicode code point; size and outline thickness are in pixels, and bold controls emboldening.

  Parameters

  codePoint

  number

  characterSize

  number

  bold

  boolean

  outlineThickness

  number = 0

  Returns

  ReadonlyValue<Glyph>

  Source & inheritance

getGlyphById

• getGlyphById(
      id: number,
      characterSize: number,
      bold: boolean,
      outlineThickness?: number,
  ): ReadonlyValue<Glyph>

  Gets a glyph by its internal font glyph index; size and outline thickness are in pixels.

  Parameters

  id

  number

  characterSize

  number

  bold

  boolean

  outlineThickness

  number = 0

  Returns

  ReadonlyValue<Glyph>

  Source & inheritance

getInfo

• getInfo(): FontInfo

  Returns a read-only view of the current font information.

  Returns

  FontInfo

  Source & inheritance

getKerning

• getKerning(
      first: number,
      second: number,
      characterSize: number,
      bold?: boolean,
  ): number

  Returns kerning between two Unicode code points in pixels.

  Parameters

  first

  number

  second

  number

  characterSize

  number

  bold

  boolean = false

  Returns

  number

  Source & inheritance

getLineSpacing

• getLineSpacing(size: number): number

  Returns recommended baseline spacing for the specified pixel character size.

  Parameters

  size

  number

  Returns

  number

  Source & inheritance

getTexture

• getTexture(characterSize: number): Readonly

  Returns a read-only glyph atlas texture reference for the specified pixel character size; loading more glyphs may update its contents.

  Parameters

  characterSize

  number

  Returns

  Readonly

  Source & inheritance

getUnderlinePosition

• getUnderlinePosition(size: number): number

  Returns the underline position relative to the baseline in pixels.

  Parameters

  size

  number

  Returns

  number

  Source & inheritance

getUnderlineThickness

• getUnderlineThickness(size: number): number

  Returns the underline thickness in pixels.

  Parameters

  size

  number

  Returns

  number

  Source & inheritance

hasGlyph

• hasGlyph(codePoint: number): boolean

  Returns whether the font has a glyph for the specified Unicode code point.

  Parameters

  codePoint

  number

  Returns

  boolean

  Source & inheritance

isSmooth

• isSmooth(): boolean

  Returns whether font textures use smooth filtering.

  Returns

  boolean

  Source & inheritance

openFromFile

• openFromFile(filename: string): Promise<boolean>

  Opens a font file asynchronously; on success replaces the font and clears metric caches. Returns whether it succeeded.

  Parameters

  filename

  string

  Returns

  Promise<boolean>

  Source & inheritance

openFromMemory

• openFromMemory(data: Uint8Array): Promise<boolean>

  Opens encoded font bytes asynchronously and returns whether it succeeded.

  Parameters

  data

  Uint8Array

  Returns

  Promise<boolean>

  Source & inheritance

openFromStream

• openFromStream(stream: InputStream): Promise<boolean>

  Reads all font bytes from the start of the stream and opens asynchronously; returns success, and stream errors reject the Promise.

  Parameters

  stream

  InputStream

  Returns

  Promise<boolean>

  Source & inheritance

setSmooth

• setSmooth(smooth: boolean): void

  Sets whether font textures use smooth filtering.

  Parameters

  smooth

  boolean

  Returns

  void

  Source & inheritance

[fontRevision]

Readonly[graphicsNative]