API reference
Preparing search index…

Forward the checked overload to the native font engine.

File path or font bytes.

Explicit family or file fallback flag.

Named face style or file weight.

Named face weight or file collection index.

Named face fallback flag.

Named face collection index.

Native loading result.

  • Load Rml::LoadFontFace from a file using its internal family and style.

    Parameters

    filePath
    string

    Path resolved through the active file interface.

    fallbackOptional
    boolean

    Use for missing glyphs in other faces; defaults to false.

    weightOptional
    number

    Auto (0), or integer 1–1000; defaults to Auto.

    faceIndexOptional
    number

    Nonnegative int32 collection index; defaults to 0.

    Returns

    boolean

    Native success flag; false for missing/invalid fonts or faces.

    Synchronous. Initialise first and load fonts before documents. Use the internal family name in RCSS. Runtime font operations reject event callbacks.

    Source & inheritance
  • Load a file or byte view with explicit family, style and optional weight.

    Parameters

    source
    string | Uint8Array

    File path, Buffer or non-shared, non-detached Uint8Array.

    family
    string

    Family name to register for RCSS; empty uses font metadata.

    style

    Normal or Italic.

    weightOptional
    number

    Auto (0), or integer 1–1000; defaults to Auto.

    fallbackOptional
    boolean

    Register as a fallback face; defaults to false.

    faceIndexOptional
    number

    Nonnegative int32 collection index; defaults to 0.

    Returns

    boolean

    Native success flag, including false on invalid data/index.

    Synchronous Rml::LoadFontFace. The native runtime copies the exact view and keeps it until shutdown, even after a failed load (collections may partially register faces). Callers may modify, transfer or collect their input after return. releaseFontResources preserves these bytes. Initialise first; font operations reject event callbacks. Empty family also restores metadata style.

    Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0