ドキュメント

Unity Engine

Unity Engine

コードへのプロファイラーカウンターの追加

プロファイラーカウンターで特定の統計を収集します。
読み終わるまでの所要時間 7 分最終更新 5日前

プロファイラーカウンターを追加するには、以下の実行するスクリプトを作成します。
これらのセクションのコード例では、プロファイラーカウンターを追加して、ゲームオブジェクトのトレイルエフェクトのすべてのインスタンスに対して Unity が作成したパーティクルの総数を追跡します。これらの例では、ゲームオブジェクトの名前は "Tank" です。

前提条件

一部の例では、開始前にインストールする必要があるプロファイリングコアパッケージを使用します。Unity プロファイリングコアパッケージはコアパッケージであるため、Package Manager UI では検出できません。パッケージをインストールするには、
com.unity.profiling.core
という名前で追加します。

カウンターの作成と定義

新しいカウンターを作成するには、以下を行います。
  1. 新しいカウンタの値の型を定義するスクリプトを作成します。
  2. このタイプに名前と単位を割り当てます。
重要
カウンターを作成するときは、新しいカウンターが属するプロファイラーカテゴリを指定する必要があります。これを行うには、
ProfilerCategory
クラスの既存の Unity カテゴリを使用します。以下の例のスクリプトは、既存の
ProfilerCategory.Scripts
カテゴリを使用します。
プロファイラーカウンター API は、プッシュ操作とプル操作をサポートします。プロファイラーにカウンターの値をプッシュするか、プロファイラーはフレームの終了時に値をプルできます。
データの変更頻度が低い場合、例えばフレームごとに 1 回などの場合は、
ProfilerCounter
API を使用してカウンターデータをプロファイラーにプッシュします。データがフレームごとに複数回変更される場合は、
ProfilerCounterValue
API を使用します。これにより、プロファイラーは自動的にフレームの終了時に最後の値を取得します。
以下のスクリプト例では、 name
Tank Trail Particles
と
ProfilerMarkerDataUnit.Count
単位を指定した
ProfilerCounterValue
TankTrailParticleCount
を定義します。
public static class GameStats{ public static readonly ProfilerCategory TanksCategory = ProfilerCategory.Scripts; public const string TankTrailParticleCountName = "Tank Trail Particles"; public static readonly ProfilerCounterValue<int> TankTrailParticleCount = new ProfilerCounterValue<int>(TanksCategory, TankTrailParticleCountName, ProfilerMarkerDataUnit.Count, ProfilerCounterOptions.FlushOnEndOfFrame | ProfilerCounterOptions.ResetToZeroOnFlush);}
Options
FlushOnEndOfFrame
と
ResetToZeroOnFlush
は、自動的にプロファイラーデータストリームにカウンタを送信し、フレームの終了時に Count 値を 0 にリセットします。

カウンターの値を更新する

カウンタの値を更新するには、定義したカウンタの値を設定する MonoBehaviour スクリプトを作成します。
以下の MonoBehaviour スクリプトは、更新機能で割り当てられたゲームオブジェクトに属するトレイル パーティクルの数をフレームごとにカウントします。これを行うには、
TankTrailParticleCount
というカウンタを使用します。
以下のスクリプト例では、Inspector にトレイルパーティクルシステム (
m_TrailParticleSystem
) というパブリックプロパティも作成します。
using UnityEngine; クラス TankMovement :MonoBehaviour { public ParticleSystem m_TrailParticleSystem; void Update() { GameStats.TankTrailParticleCount.Value += m_TrailParticleSystem.particleCount; } }

カスタムプロファイラーモジュールへのプロファイラーカウンターの追加

コードでカスタムプロファイラーモジュールにプロファイラーカウンターを表示するには、新しい
ProfilerModule
スクリプトを作成し、表示するカウンター、名前、アイコンなどのモジュールのプロパティーを定義する必要があります。この方法については、コードでプロファイラーモジュールを作成する を参照してください。

追加リソース