Version: 2023.1
言語: 日本語
WebGL: ブラウザースクリプトとの対話
Unity WebGL のメモリ

Emscripten 用 WebGL ネイティブプラグイン

Unity は、Emscripten コンパイラー ツールチェーンを使用して、C および C++ で記述された Unity ランタイムコードを WebAssembly(別称 Wasm) にクロスコンパイルします。Emscripten は、生成するコードが小さく、ロード時間とメモリの効率が良く、ネイティブに近い速度での実行を目標に設計されています。Unity における Wasm の詳細については、ブログポスト WebAssembly を参照してください。

Unity は IL2CPP を使用して C# スクリプトの .NET ゲームコードを Wasm に変換します。IL2CPP は .NET バイトコードを取得し、それを対応の C++ ソースファイルに変換します。それが Emscripten を使用してコンパイルされることで、スクリプトが Wasm に変換されます。

ターゲットバージョン

Unity は Emscripten コンパイラーを WebGL プラットフォームパッケージにバンドルしているので、これを手動でダウンロードする必要はありません。エディターのバージョンによって、その使用する Emscripten バージョンは異なります。

Unity バージョン Emscripten バージョン サポートされるネイティブプラグインファイル形式
Unity 2022.2 以降 Emscripten 3.1.8-unity .a、.bc
Unity 2021.2 以降 Emscripten 2.0.19.6-unity .a、.bc
Unity 2019.2 to 2021.1 1.38.11-unity .bc
Unity 2018.4 - Unity 2019.2 1.37.40-unity .bc
Unity 2018.2 - Unity 2018.4 1.37.33-unity .bc

ノート:

  • 表中のファイル形式のアルファベットは、以下を意味する頭文字です。

    • GNU archive ファイル形式 (.a)
    • WebAssembly Object ファイル (.o)
    • LLVM Bitcode ファイル形式 (.bc)
  • Unity は、Emscripten 2.0 より前の Emscripten バージョンでは Bitcode プラグイン (.bc タイプのファイル) をビルドすることを推奨しています。Emscripten 2.0 以降では、Wasm Object File プラグイン (.a タイプの GNU アーカイブファイルにバンドルされた .o タイプの Wasm オブジェクトファイル) をビルドすることが推奨されます。

Emscripten ツールチェーンの正確なバージョンへのパスは、以下の場所にある emscripten-version.txt から特定できます。

C:\Program Files\Unity\Hub\Editor\<Editor version>\Editor\Data\PlaybackEngines\WebGLSupport\BuildTools\Emscripten\emscripten\emscripten-version.txt

Emscripten を使用したネイティブプラグインのコンパイル

Unity アプリケーション用のネイティブ C/C++ プラグインを作成する場合、C/C++ コードをプロジェクトにバンドルする (ネイティブプラグイン 参照) ことも、Emscripten コンパイラーツールチェーンでネイティブコードをプラグインアーカイブに事前にビルドすることも可能です。

プラグインコードを事前にビルドする場合は、Emscripten コンパイラーツールチェーンを使用する必要があります。LLVM バイナリ形式 の互換性を確保するには、プラグインのコンパイルに使用する Emscripten バージョンが、Unity の使用する Emscripten バージョンと一致している必要があります。

通常、プラグインは静的ライブラリアーカイブ形式にコンパイルされます。Unity 2021.2 (Emscripten 2.0) より前のバージョンでは、推奨されるプラグイン形式は LLVM Bitcode ファイル形式 (.bc) です。

Unity 2021.2 以降で推奨されるプラグイン形式は、WebAssembly オブジェクトファイル (.o) を含んだ GNU アーカイブファイル形式 (.a) です。以前の LLVM Bitcode (.bc) プラグインファイルはまだサポートされていますが、これを使用するとコンパイル時間に悪影響が及ぶ可能性があります。

ノート: ネイティブプラグインを、特定の Unity バージョンから (異なるバージョンの Emscripten を使用する) 別のバージョンへ移行する場合、Unity プラグインをソースから再コンパイルすることをお勧めします。なぜなら、LLVM コンパイラープロジェクトは、コンパイラーバージョン間におけるビルドアーティファクトファイルのバイナリ互換性を保証しないためです。

その他の参考資料

WebGL: ブラウザースクリプトとの対話
Unity WebGL のメモリ