API Docs
    Preparing search index...

    Function default

    • Generates a web assembly mGBA module for the browser.

      This emulator core is meant to be used like a controlled frontend component: it bootstraps the emulator runtime, canvas wiring, keyboard events, and other autonomous functions using emscripten, exposing an imperative API used to control the core.

      The consuming UI then drives all actions after initialization using the API above, such as loading ROM/save files, pausing/resuming, settings, saves, etc.

      Initialization flow:

      • create a <canvas />
      • call mGBA({ canvas }) to get the Module
      • call await Module.FSInit() once to mount + load persisted file system data
      • keep the Module accessible and call methods on it from your UI

      This core uses threads, your app must be served with cross-origin isolation enabled (COOP: same-origin + COEP: require-corp), otherwise it will not run correctly.

      Parameters

      • options: { canvas: HTMLCanvasElement }

        Module options.

        • canvas: HTMLCanvasElement

          Canvas used for video output.

      Returns Promise<mGBAEmulator>

      The initialized emulator Module.