Memory プロファイラーモジュール

Unity でアプリケーションのメモリ使用量を分析する方法は 2 つあります。

• Memory (メモリ) プロファイラーモジュール: このビルトインのプロファイラーモジュールは、アプリケーションのメモリを何に使用しているかの基本的な情報を提供します。
• Memory Profiler パッケージ: プロジェクトに追加できる別のパッケージです。これにより、Unity エディターに Memory プロファイラーウィンドウが追加され、アプリケーションのメモリ使用をさらに詳細に分析することができます。スナップショットを保存して比較することで、より簡単にメモリリークを発見したり、メモリレイアウトを確認してメモリの断片化の問題を発見したりできます。

このページではビルトインの Memory プロファイラーモジュールについて説明します。Memory Profiler パッケージの詳細は、Memory Profiler のドキュメント を参照してください。

Memory プロファイラーモジュールは、アプリケーションに割り当てられたすべてのメモリを表すカウンターを視覚化します。メモリモジュールを使用して、ロードされたオブジェクトの数や、カテゴリごとの合計メモリに占める使用量などの情報を確認できます。プロファイラーフレームごとの GC 割り当て数も確認できます。

エディターでアプリケーションをプロファイルすると、Memory モジュールの情報はエディターのメモリ使用を示します。これらの数値は一般的にリリースプラットフォームで実行する場合よりも大きくなります。なぜなら、Unity エディターを実行するとメモリを消費する特定のオブジェクトを使用し、エディターウィンドウ自体が余分なメモリを使用するためです。さらに、プロファイラーはプロファイラーが使用するメモリを表示します。なぜなら、Unity は再生モードのプレイヤーが使用するメモリからそれを明確に分離できないからです。 アプリケーションのより正確な数値とメモリ使用量については、Attach to Player ニューを使ってプロファイラーを実行中のプレイヤーに接続してください。 これにより、ターゲットデバイスでの実際の使用状況を確認できます。

チャートのカテゴリ

Memory モジュールは、6 つのチャートに分かれており、アプリケーションがメモリをどこで使用するかに関する詳細情報を表示します。チャートのカテゴリの順序を変更できます。これを行うには、チャートの凡例にドラッグアンドドロップします。カテゴリの色の付いた凡例をクリックして、表示を切り替えることもできます。

モジュールの詳細ペイン

モジュールの詳細ペインには、Profiler ウィンドウの下部にある Simple と Detail の 2 つの表示があります。表示を変更するには、モジュール詳細ペインの左上のドロップダウンから表示を選択します。

簡易ビュー

簡易ビューでは、Unity がメモリをどのように使用しているかを、フレーム単位でリアルタイムに表示します。

Unity は OS が頻繁にメモリを要求しずぎることを防ぐため、アロケーションのためのメモリプールを確保します。プロファイラーは、予約済みのメモリの量と、Unity が使用しているメモリの量を表示します。

この情報は、ProfilerRecorder API やProfiler Module Editor からも入手でき、カスタムの Profiler モジュールに追加することができます。

プレイヤーの可用性

You can use the ProfilerRecorder API to access the Memory Profiler module’s counters in Players. The following example contains a simple script that collects “Total Reserved Memory”, “GC Reserved Memory” and “System Used Memory” metrics, and displays those as a GUI.TextArea. The Memory Profiler module information belongs to the ProfilerCategory.Memory Profiler category.

using System.Text;
using Unity.Profiling;
using UnityEngine;

public class MemoryStatsScript : MonoBehaviour
{
    string statsText;
    ProfilerRecorder totalReservedMemoryRecorder;
    ProfilerRecorder gcReservedMemoryRecorder;
    ProfilerRecorder systemUsedMemoryRecorder;

    void OnEnable()
    {
        totalReservedMemoryRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Memory, "Total Reserved Memory");
        gcReservedMemoryRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Memory, "GC Reserved Memory");
        systemUsedMemoryRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Memory, "System Used Memory");
    }

    void OnDisable()
    {
        totalReservedMemoryRecorder.Dispose();
        gcReservedMemoryRecorder.Dispose();
        systemUsedMemoryRecorder.Dispose();
    }

    void Update()
    {
        var sb = new StringBuilder(500);
        if (totalReservedMemoryRecorder.Valid)
            sb.AppendLine($"Total Reserved Memory: {totalReservedMemoryRecorder.LastValue}");
        if (gcReservedMemoryRecorder.Valid)
            sb.AppendLine($"GC Reserved Memory: {gcReservedMemoryRecorder.LastValue}");
        if (systemUsedMemoryRecorder.Valid)
            sb.AppendLine($"System Used Memory: {systemUsedMemoryRecorder.LastValue}");
        statsText = sb.ToString();
    }

    void OnGUI()
    {
        GUI.TextArea(new Rect(10, 30, 250, 50), statsText);
    }
}

以下のスクリーンショットは、Tanks! tutorial project にスクリプトを追加した結果を表しています。

この情報は、上の表の他のハイレベルなカウンターと同様に、Release Player で利用できます。選択した Memory カウンターを Profiler ウィンドウのカスタムモジュールで表示したい場合は、Module Editor を使ってチャートを設定してください。

詳細ビュー

Detailed (詳細) ビューを使用すると、アプリケーションの現在の状態のスナップショットを取得できます。Take Sample ボタンをクリックして、現在のターゲットの詳細なメモリ使用をキャプチャ ます。プロファイラーがこのデータを取得するにはかなりの時間がかかるため、Detailed ビューではリアルタイムの詳細情報は表示されません。プロファイラーがサンプルを取得した後に、Profiler ウィンドウにリストビューが表示され、そこでアプリケーションのメモリ使用を詳細に確認できます。

モジュールの詳細ペインの上部にある Gather object references 設定を有効にして、スナップショットの時点でオブジェクトを参照しているものに関する情報を収集できます。この情報は、ウィンドウの右側のペインに表示されます。

リストビューでは、メモリを使用するオブジェクトを以下のカテゴリに分類しています。

• Other: アセット、ゲームオブジェクト、コンポーネントのいずれでもないオブジェクト。Unity が異なるシステムで使用するメモリなどの情報が含まれます。
• Not Saved: DontSave とマークされたオブジェクト
• Builtin Resources: Unity エディターリソース、または Unity のデフォルトリソース。例えば、Graphics 設定の Always Included Shaders リストに加えたシェーダーなど。
• Assets: ユーザーやネイティブコードから参照されるアセット
• Scene Memory: ゲームオブジェクトとアタッチされたコンポーネント

Asset または Scene Memory リストでゲームオブジェクトをクリックすると、Project またはシーンビューでハイライトされます。

ノート: Other カテゴリでは、System.ExecutableAndDlls で報告されるメモリは読み取り専用メモリです。オペレーティングシステムは必要に応じてこれらのページを破棄し、後でファイルシステムから再ロードする場合があります。これにより、メモリ使用量が少なくなり、通常は、オペレーティングシステムがメモリを使いすぎた場合にアプリケーションを閉じるかどうかの決定に、直接影響しません。これらのページの一部は、同じフレームワークを使用している他のアプリケーションと共有される場合もあります。