プログラムからスナップショットの取得を行える「UnityMemoryProfilerSupportKun」の解説

2023/01/23

はじめに

（本記事で紹介するツールは、ユニティ・テクノロジーズ・ジャパンの社員が個人的に開発・利用していたもので、この度Unityユーザーの皆さんにも自由にご利用いただけるよう無償公開したものです。ツールの使用許諾などはリポジトリのREADME、LICENSEテキストをお読みください。原則として公式サポートはございません）

UnityMemoryProfilerSupportKunはUnity公式ツールのMemoryProfilerで使えるスナップショットファイル(計測時点のメモリの情報を保存したファイル)の取得をプログラムから行えるツールです。プログラム内で実行できる為、希望するタイミングでピンポイントにスナップショットを取得できます。

スナップショットファイルはMemoryProfilerで読み込んで詳細情報を確認する事ができます。

インストール

UnityエディタのメニューからWindow-> PackageManagerと選択し、Package Managerウィンドウを開きます。

ウィンドウの左上にある＋のアイコンをクリックし、「Add package from git URL...」を選択します。

入力欄にhttps://github.com/katsumasa/UnityMemoryProfilerSupportKun.gitと入力し、「Add」ボタンを押すとインストールが行われます。

使用時の作業の流れ

プログラム内の希望する場所でスナップショットファイル(.snapファイル)を取得する処理を記述する。
アプリ上で実行し、スナップショットファイルを取得する。
Unityエディタ上のツールを使い、アプリ内に保存されているスナップショットファイルをUnityエディタへ転送する。
MemoryProfileを使ってスナップショットファイルをロードし、データを確認する。

実際に使ってみる

まず、アプリ上でスナップショットファイルを作成する部分まで解説します。

デフォルトシーンだと画面が寂しいのでシーン上に3Dオブジェクトをいくつか追加します。

シーン上にGame ObjectをTestという名前で作成し、そこにUnityMemoryProfilerSupportKunをインストールしたフォルダ内にある UnityMemoryProfilerSupportKunClient.cs を追加します。

Test.csファイルを作成し、以下の内容を記述します。ここではStartイベントのタイミングでアプリ内にスナップショットファイルの取得を行っています。このTest.csもTestへ追加します。

using UnityEngine;
using Utj.UnityMemoryProfilerSupportKun;

public class Test : MonoBehaviour
{
    void Start()
    {
        // Capture001というファイル名で保存
        UnityMemoryProfilerSupportKunClient.instance.TakeSnapshot("Capture001");
    }
}

ここまでの作業を行うとTestは以下の様になっています。

これでStartイベントのタイミングでスナップショットファイルが取得される処理が実装できました。

次にスナップショットファイルの取得とそのファイルをエディタへ転送する作業を行います。

まず、アプリをビルドします。Build SettingsではDevelopment BuildとAutoConnect Profilerにチェックを付けておいて下さい。なお、WindowsやMacアプリとしてビルドする場合にはフルスクリーンではなく、ウィンドウモードで起動するアプリとしてビルドしておくと、この後の操作がし易いのでオススメです。