Options
All
  • Public
  • Public/Protected
  • All
V1.7
  • V1.6
  • V1.7
Menu

Class FontResource

Interface for objects that manage font resources, which describe how text will be rendered with Lumin.

Hierarchy

Index

Constructors

constructor

Methods

getAdvanceDirection

getAscender

  • getAscender(): number

getBasePath

  • getBasePath(): string

getDescender

  • getDescender(): number
  • The descender is the vertical distance from the horizontal baseline to the lowest glyph coordinate, which is negative if any glyphs extend below the baseline (usually they do).

    priv

    none

    Returns number

getFileName

  • getFileName(): string

getFlowDirection

getFontName

  • getFontName(): string

getFontSize

  • getFontSize(): number

getFontStyle

  • getFontStyle(): string

getGlyphHeight

  • getGlyphHeight(): number
  • Get the global glyph height for the font.

    Formally, this is the difference between the ascender and descender, which is what getGlyphHeight() returns.

    priv

    none

    Returns number

getLineSpacing

  • getLineSpacing(): number
  • Get the space between lines of text written with this font.

    This is a value provided by the font designer to indicate how much space should separate lines of text written with the font relative to the size of a tile (which is 1 in glyph space).

    priv

    none

    Returns number

getLoadStatus

getLoadedGlyphs

  • getLoadedGlyphs(): Array<number>

getResourceId

  • getResourceId(): bigint

isProtectedContent

  • isProtectedContent(): boolean

isResourceValid

  • isResourceValid(): boolean

setProtectedContent

  • setProtectedContent(value: boolean): void

Generated using TypeDoc