web: Add deviceFontRenderer config option

Using this config option the user can select how device fonts should be
rendered.

Author: kjarosh

web/packages/core/src/internal/builder.ts

@@ -140,6 +140,10 @@ export function configureBuilder(
     if (isExplicit(config.scrollingBehavior)) {
         builder.setScrollingBehavior(config.scrollingBehavior);
     }
+
+    if (isExplicit(config.deviceFontRenderer)) {
+        builder.setDeviceFontRenderer(config.deviceFontRenderer);
+    }
 }
 
 /**

web/packages/core/src/public/config/default.ts

@@ -10,6 +10,7 @@ import {
     UnmuteOverlay,
     WindowMode,
     ScrollingBehavior,
+    DeviceFontRenderer,
 } from "./load-options";
 
 export const DEFAULT_CONFIG: Required<BaseLoadOptions> = {
@@ -56,4 +57,5 @@ export const DEFAULT_CONFIG: Required<BaseLoadOptions> = {
     gamepadButtonMapping: {},
     urlRewriteRules: [],
     scrollingBehavior: ScrollingBehavior.Smart,
+    deviceFontRenderer: DeviceFontRenderer.Embedded,
 };

web/packages/core/src/public/config/load-options.ts

@@ -283,6 +283,30 @@ export enum ScrollingBehavior {
     Smart = "smart",
 }
 
+/**
+ * Specifies how device fonts should be rendered.
+ */
+export enum DeviceFontRenderer {
+    /**
+     * Use Ruffle's embedded text rendering engine.
+     *
+     * It cannot access device fonts and uses fonts provided in the
+     * configuration and the default Noto Sans font as a fallback.
+     *
+     * This is the default method.
+     */
+    Embedded = "embedded",
+
+    /**
+     * Use an offscreen canvas for text rendering.
+     *
+     * It can access and render device fonts, glyphs are rendered as bitmaps.
+     *
+     * This is an experimental method and some features might not work properly.
+     */
+    Canvas = "canvas",
+}
+
 /**
  * Represents a host, port and proxyUrl. Used when a SWF file tries to use a Socket.
  */
@@ -758,6 +782,13 @@ export interface BaseLoadOptions {
      * @default ScrollingBehavior.Smart
      */
     scrollingBehavior?: ScrollingBehavior;
+
+    /**
+     * Specify how device fonts should be rendered.
+     *
+     * @default DeviceFontRenderer.Embedded
+     */
+    deviceFontRenderer?: DeviceFontRenderer;
 }
 
 /**

web/src/builder.rs

@@ -1,8 +1,8 @@
 use crate::external_interface::JavascriptInterface;
 use crate::navigator::{OpenUrlMode, WebNavigatorBackend};
 use crate::{
-    JavascriptPlayer, RUFFLE_GLOBAL_PANIC, RuffleHandle, ScrollingBehavior, SocketProxy, audio,
-    log_adapter, storage, ui,
+    DeviceFontRenderer, JavascriptPlayer, RUFFLE_GLOBAL_PANIC, RuffleHandle, ScrollingBehavior,
+    SocketProxy, audio, log_adapter, storage, ui,
 };
 use js_sys::{Promise, RegExp};
 use ruffle_core::backend::audio::{AudioBackend, NullAudioBackend};
@@ -65,6 +65,7 @@ pub struct RuffleInstanceBuilder {
     pub(crate) gamepad_button_mapping: HashMap<GamepadButton, KeyCode>,
     pub(crate) url_rewrite_rules: Vec<(RegExp, String)>,
     pub(crate) scrolling_behavior: ScrollingBehavior,
+    pub(crate) device_font_renderer: DeviceFontRenderer,
 }
 
 impl Default for RuffleInstanceBuilder {
@@ -104,6 +105,7 @@ impl Default for RuffleInstanceBuilder {
             gamepad_button_mapping: HashMap::new(),
             url_rewrite_rules: vec![],
             scrolling_behavior: ScrollingBehavior::Smart,
+            device_font_renderer: DeviceFontRenderer::Embedded,
         }
     }
 }
@@ -347,6 +349,15 @@ impl RuffleInstanceBuilder {
         };
     }
 
+    #[wasm_bindgen(js_name = "setDeviceFontRenderer")]
+    pub fn set_device_font_renderer(&mut self, device_font_renderer: String) {
+        self.device_font_renderer = match device_font_renderer.as_str() {
+            "embedded" => DeviceFontRenderer::Embedded,
+            "canvas" => DeviceFontRenderer::Canvas,
+            _ => return,
+        };
+    }
+
     // TODO: This should be split into two methods that either load url or load data
     // Right now, that's done immediately afterwards in TS
     pub async fn build(&self, parent: HtmlElement, js_player: JavascriptPlayer) -> Promise {

web/src/lib.rs

@@ -238,6 +238,12 @@ pub enum ScrollingBehavior {
     Smart,
 }
 
+#[derive(Debug, Clone, Copy)]
+pub enum DeviceFontRenderer {
+    Embedded,
+    Canvas,
+}
+
 #[wasm_bindgen]
 impl RuffleHandle {
     /// Stream an arbitrary movie file from (presumably) the Internet.