Version: 2022.1
言語: 日本語
WebGL native plug-ins for Emscripten
Cache behavior in WebGL

WebGL のメモリ

Unity WebGLではメモリの制約により、実行できるコンテンツの複雑さが制限されることがあります。

WebGL コンテンツはブラウザー上で動作します。ブラウザーは、アプリケーションがコンテンツを実行するために必要なメモリを、そのメモリスペースに確保します。 利用可能なメモリの量は、以下の条件によって異なります。

  • The device you use
  • The operating system you use
  • The browser you use, and whether it runs on a 32 or 64 processor
  • ブラウザーの JavaScript エンジンがコードを解析するのに必要なメモリ量
  • ブラウザーがタブごとに別々のプロセスを使用するかどうか、コンテンツが他のすべての開いているタブとメモリスペースを共有する必要があるかどうか。

Unity WebGL コンテンツがブラウザーに著しく大きなメモリの割り当てを必要とするエリアが、複数あります。

Unity のヒープ

Unity はメモリヒープを使用して、すべての Unity エンジンランタイムオブジェクトを格納します。これには、マネージオブジェクト、ネイティブオブジェクト、ロードされたアセット、シーン、シェーダーなどが含まれます。これは、他のプラットフォームで Unity プレイヤーが使用するメモリのようなものです。

Unity のヒープは、割り当てられたメモリの連続したブロックです。Unity は、アプリケーションのニーズに合わせて、ヒープの自動サイズ変更をサポートしています。ヒープサイズは、アプリケーションが実行すると拡張され、最大 2GB まで拡張できます。Unity はこのメモリヒープを Memory オブジェクト として作成します。Memory オブジェクトの buffer プロパティはサイズ変更可能な ArrayBuffer で、WebAssembly コードがアクセスするメモリの生のバイトを保持します。

Automatic resizing of the heap can cause your application to crash if the browser fails to allocate a contiguous memory block in the address space. For this reason, it is important to keep the Unity heap size as small as possible. Therefore, be mindful when you are planning the memory usage of your application. If you want to test the size of your Unity heap, you can use the Profiler to profile the contents of the memory block.

You can control the initial size and growth of the heap by the memory growth options in the WebGL Player Settings. The default options are configured to work well for all desktop use cases. However, for mobile browsers you need to use the advanced tuning options. For mobile browsers, it’s recommended to configure the Initial Memory Size to the typical heap usage of the application.

アセットデータ

Unity WebGL ビルドを作成すると、Unity は .data ファイルを生成します。このファイルには、アプリケーションの起動に必要なシーンとアセットがすべて含まれています。Unity WebGL は実際のファイルシステムにアクセスできないため、仮想メモリのファイルシステムを作成し、ブラウザーはこの .data ファイルをここで解凍します。Emscipten フレームワーク (JavaScript) は、このメモリファイルシステムをブラウザーのメモリ空間に確保します。コンテンツが実行されている間、ブラウザーのメモリは解凍されたデータを維持します。ダウンロード時間とメモリ使用量の両方を低く抑えるために、この圧縮されていないデータをできるだけ小さくするようにしてください。

メモリ使用量を削減するために、アセットデータを AssetBundle (アセットバンドル) にまとめることができます。アセットバンドルを使うと、アセットのダウンロードを完全に制御することが可能になります。つまり、アプリケーションがアセットをダウンロードするタイミングや、ランタイムがアセットをアンロードするタイミングを制御できます。未使用のアセットをアンロードすると、メモリが解放されます。

AssetBundles は、Unity のヒープに直接ダウンロードします。そのため、ブラウザーが余分な割り当てをすることはありません。

データキャッシング を有効にして、ユーザーのマシンにコンテンツのアセットデータをキャッシュします。これにより、後の実行時にそのデータを再ダウンロードする必要がなくなります。Unity WebGL ローダーは、IndexedDB API を使用してデータキャッシングを実装しています。このオプションにより、ブラウザーがネイティブにキャッシュできないサイズのファイルをキャッシュすることができます。

データキャッシングは、ブラウザーがアプリケーションデータをユーザーのマシンに保存することを可能にします。ブラウザーでは、しばしば、キャッシュに保存できる量やキャッシュできる最大ファイルサイズが制限されます。これでは、アプリケーションがスムーズに動作するためには十分ではありません。そこで Unity WebGL ローダーでは、IndexedDB API を用いてデータキャッシングを実装しています。ブラウザーのキャッシュにコンテンツを保存するのではなく、Unity は IndexedDB にデータを保存します。

データキャッシングオプションを有効にするには、File > Build Settings > Player Settings > Publishing Settings の順に移動します。

Large-Allocation Http ヘッダー

サーバーはコンテンツの Large-Allocation http ヘッダーを生成することがあります。これはサポートされているブラウザー (現在 Mozilla のみ) にメモリが必要としているものを伝えます。この情報によって、対応するブラウザーが分割されていないメモリスペースで新しい処理を発生させたり、大きなメモリ割り当てが成功するように雑多な作業が可能になります。 こうすることにより、特に 32 ビットブラウザーで Unity ヒープを割り当てようとするときに、ブラウザーがメモリ不足になる問題を解決できます。

ガベージコレクションへの配慮

ガベージコレクションとは、使われていないメモリを探し出して解放するプロセスです。ガベージコレクターは、未使用のメモリを収集すると、Unity のヒープ内で再割り当てします。

Unity のガベージコレクションの仕組みの概要については、自動メモリ管理 を参照してください。WebGL のガベージコレクションは、スタックが空になったときに実行されます。スタックは Unity のヒープの一部ですが、ヒープそのものではありません。これは通常、各フレームの後に発生します。これは、他のプラットフォームでのガベージコレクションプロセス (コレク ターは実行中のすべてのスレッドを一時停止して、スタックを検査することができます) とは異なります。これは JavaScript では不可能です。ガベージコレクションプロセスは、Unity Profiler を使ってデバッグすることができます。

他のほとんどのプラットフォームでは、ガベージコレクションは、実行中のすべてのスレッドを一時停止します。ガベージコレクターは、それらのスレッドのスタックを検査し、ロードされたオブジェクト参照を登録します。これは、現在のところ、JavaScript では不可能です。このため、WebGL では、スタックが空になった場合にのみ、ガベージコレクタが実行されます。これは現在、各フレームの後に一度だけ発生します。

このため、下のコードは WebGL での実行に失敗します。これは、ループの繰り返しの間に、ガベージコレクターを実行する機会がないためです。これは、ガベージコレクタが中間文字列オブジェクトが使用するメモリを解放できないことを意味し、Unity のヒープのメモリを使い果たしてしまう可能性があります。

string hugeString = "";
 
for (int i = 0; i < 100000; i++)
 
{
 
  hugeString += "foo";
 
}

2020.1 で導入された WebGL ローダーの更新

WebGL native plug-ins for Emscripten
Cache behavior in WebGL