ドキュメント

Unity Engine

Unity Engine

プロファイラーモジュールの作成

カスタムプロファイラーモジュールを プロファイラー ウィンドウに追加して、アプリケーションに関する特定のデータを収集してディスプレイします。
読み終わるまでの所要時間 10 分最終更新 6日前

プロファイラーモジュールは、システムからのパフォーマンデータを プロファイラー ウィンドウに表示します。
以下のいずれかの方法で、独自のプロファイラーモジュールを作成できます。
カスタムモジュールは、コードで指定したカウンターを プロファイラー ウィンドウのチャートビュー (A) に表示し、カウンターはモジュールの詳細パネル (B) にリストとして表示されます。

A custom Profiler module with custom data displayed.

プロファイラーモジュールエディタを使用したプロファイラーモジュールの作成

Unity のビルトインプロファイラーモジュールエディタを使用して、独自のプロファイラーモジュールを作成できます。プロファイラーモジュールでデータを収集するには、モジュールが追跡できるように少なくとも 1 つのカウンターを追加する必要があります。Unity ビルトインカウンタの両方を追加することも、
ProfilerCounter
API
を使用して独自のカウンタを作成しモジュールに追加することもできます。使用可能なカウンタのリストが Available Counters ペインに表示されます。
独自のモジュールを作成するには、以下を行います。
  1. プロファイラーウィンドウ (ウィンドウ> 分析> プロファイラー) を開きます。
  2. プロファイラーモジュールのドロップダウンを選択し、歯車アイコンを選択します。プロファイラーモジュールエディタが開きます。
  3. ウィンドウの左下隅にある Add ボタンを選択します。Unity は、New プロファイラーモジュールという新しいプロファイラーモジュールをリストに追加しますモジュールの名前を変更するには、テキストフィールドをクリックし、キーボードで名前を設定します。
  4. モジュールにディスプレイするカウンタを Available Counters パネルから選択し、ダブルクリックしてモジュールに追加します。複数のカウンターを選択するには、シフト キーを押しながらクリックして範囲を選択するか、Ctrl (macOS では コマンド) キーを押しながら 1 つずつカウンターを選択します。
  5. カウンタを並べ替えるには、カウンタをドラッグします。1 つのモジュールに追加できるカウンターは最大 10 個です。
  6. プロファイラー Module Editor ウィンドウの右下にある Save Changes (変更を保存) ボタンを選択します。Unity がウィンドウを閉じ、プロファイラーウィンドウに新しいモジュールが表示されます。
重要
ウィンドウドしていない場合、作成したカウンターは、プロファイラーモジュールエディターをロードしたときに使用可能なカウンターペインに表示されません。カスタムカウンターを表示するには、プロファイラーで発行したカウンターを含むデータを キャプチャまたはロード し、プロファイラーモジュールエディタを再度開きます。

コードでのプロファイラーモジュールの作成

コードでプロファイラーモジュールを作成するには、新しい
ProfilerModule
スクリプトを作成し、表示するカウンター、名前、アイコンなどのモジュールのプロパティーを定義する必要があります。
プロファイラーモジュールを定義するには、スクリプトで以下の行う必要があります。
  1. プロジェクトまたはパッケージで
    ProfilerModule
    から派生したクラスを定義します。以下の例では、クラスは
    TankEffectsProfilerModule
    と呼ばれます。
    public class TankEffectsProfilerModule : ProfilerModule
  2. このクラスに
    [ProfilerModuleMetadata]
    属性を割り当て、属性の引数にモジュールの表示名を指定します。以下の例では、ディスプレイ名は "Tank Effects" です。
    [ProfilerModuleMetadata("Tank Effects")]
  3. パラメーターを持たないコンストラクターを実装し、チャートカウンターの説明のリストを基本コンストラクターに渡します。以下の例では、パラメーターなしのコンストラクターは
    TankEffectsProfilerModule()
    、チャートカウンター記述子のリストは
    k_Counters
    、基本コンストラクターは
    base
    です。
    static readonly ProfilerCounterDescriptor[] k_Counters = new ProfilerCounterDescriptor[]{ new ProfilerCounterDescriptor(GameStatistics.TankTrailParticleCountName, GameStatistics.TanksCategory)、 new ProfilerCounterDescriptor(GameStatistics.ShellExplosionParticleCountName, GameStatistics.TanksCategory)、 new ProfilerCounterDescriptor(GameStatistics.TankExplosionParticleCountName, GameStatistics.TanksCategory)、}; public TankEffectsProfilerModule() : base(k_Counters) { }

プロファイラー ウィンドウにカスタムプロファイルモジュールをディスプレイする

独自のプロファイラーモジュールを定義すると、プロファイラー ウィンドウが自動的に検出します。プロファイラー ウィンドウで プロファイラー モジュールのデータを表示するには、以下を行います。
  1. アプリケーションにプロファイラーを接続します。詳細については、アプリケーションのプロファイリング を参照してください。
  2. アプリケーションを実行します。
アプリケーションが再生モードのときにプロファイラーを実行することもできます。ただし、再生モードでアプリケーションをプロファイルすると、プロファイラーは、デバイスでアプリケーションをビルドするときにアプリケーションがどのように実行されるかを表すものではないデータを表示します。

追加リソース