Profiler モジュールの詳細パネルの作成

• カスタムモジュール詳細パネルを描画するための モジュール詳細パネルのコントローラースクリプト を作成します。
• コントローラーを Profiler モジュールに接続するための Profiler モジュールスクリプトを作成 します。

モジュール詳細パネルを制御するスクリプトの作成

ProfilerModuleViewController

• 基本コンストラクター

  base(profilerWindow)

  を呼び出すビューコントローラーのパブリックコンストラクターを定義します。

• CreateView

  をオーバーライドして、カスタムモジュール詳細パネルを構築します。

 public class CustomDetailsViewController : ProfilerModuleViewController {       public CustomDetailsViewController(ProfilerWindow profilerWindow) : base(profilerWindow) { }    protected override VisualElement CreateView()    {        // Create your UI.    }}

モジュール詳細パネルコントローラースクリプト例

• 取り込みたい値を表示するラベルを定義作成し、このラベルをモジュールの詳細パネルに加えます。
• モジュール詳細パネルを制御するためのコンストラクターを定義し、

  CreateView

  を使用してカスタムモジュール詳細パネルを構築します。
• ラベルに現在のフレームからのデータを入力し、各フレームの後にラベルを更新します。
• カウンターの値を文字列として取得し、モジュール詳細パネルに表示することができます。
• モジュールの詳細パネルに表示するテキストを指定し、Profiler がフレームごとに自動的に更新するように指示します。

 using UnityEditor; using UnityEditorInternal; using Unity.Profiling.Editor; using UnityEngine.UIElements;  public class TankEffectsDetailsViewController : ProfilerModuleViewController {    // Define a label, which will display the total particle count for tank trails in the selected frame.    Label m_TankTrailParticleCountLabel;    // Define a constructor for the view controller, which calls the base constructor with the Profiler Window passed from the module.    public TankEffectsDetailsViewController(ProfilerWindow profilerWindow) : base(profilerWindow) { }    {        var view = CreateView();        // Populate the view with the current data for the selected frame.         ReloadData();        // Be notified when the selected frame index in the Profiler Window changes, so we can update the label.        ProfilerWindow.SelectedFrameIndexChanged += OnSelectedFrameIndexChanged;        return view;    }	    protected virtual VisualElement CreateView()    {        var view = new VisualElement();		        // Create the label and add it to the view.        m_TankTrailParticleCountLabel = new Label() { style = { paddingTop = 8, paddingLeft = 8 } };        view.Add(m_TankTrailParticleCountLabel);    }	    // Override Dispose to do any cleanup of the view when it is destroyed. This is a standard C# Dispose pattern.    protected override void Dispose(bool disposing)    {        if (!disposing)            return;        // Unsubscribe from the Profiler window event that we previously subscribed to.        ProfilerWindow.SelectedFrameIndexChanged -= OnSelectedFrameIndexChanged;        base.Dispose(disposing);    }    protected virtual void ReloadData()    {        // Retrieve the TankTrailParticleCount counter value from the Profiler as a formatted string.        var selectedFrameIndexInt32 = System.Convert.ToInt32(ProfilerWindow.selectedFrameIndex);        var value = ProfilerDriver.GetFormattedCounterValue(selectedFrameIndexInt32, GameStatistics.TanksCategory.Name, GameStatistics.TankTrailParticleCountName);        // Update the label's text with the value.        m_TankTrailParticleCountLabel.text = $"The value of '{GameStatistics.TankTrailParticleCountName}' in the selected frame is {value}.";    }    void OnSelectedFrameIndexChanged(long selectedFrameIndex)    {        // Update the label with the current data for the newly selected frame.        ReloadData();    }}

Profiler モジュールへカスタムモジュール詳細パネルを接続

CreateDetailsViewController

TankEffectsProfilerModule

using Unity.Profiling.Editor;[System.Serializable][ProfilerModuleMetadata("Tank Effects")]public class TankEffectsProfilerModule : ProfilerModule{   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) { }   public override ProfilerModuleViewController CreateDetailsViewController()   {       return new TankEffectsDetailsViewController(ProfilerWindow);   }}

モジュール詳細パネルで追加カウンターを可視化

autoEnabledCategoryNames

Scripts

Memory

using Unity.Profiling;using Unity.Profiling.Editor;[System.Serializable][ProfilerModuleMetadata("Tank Effects & Memory")]public class TankEffectsAndMemoryProfilerModule : ProfilerModule{  static readonly ProfilerCounterDescriptor[] k_Counters = new ProfilerCounterDescriptor[]  {      new ProfilerCounterDescriptor(GameStatistics.TankTrailParticleCountName, ProfilerCategory.Scripts),      new ProfilerCounterDescriptor(GameStatistics.ShellExplosionParticleCountName, ProfilerCategory.Scripts),      new ProfilerCounterDescriptor(GameStatistics.TankExplosionParticleCountName, ProfilerCategory.Scripts),  };  // Enable the ProfilerCategory.Scripts and ProfilerCategory.Memory categories when the module is active.  static readonly string[] k_AutoEnabledCategoryNames = new string[]  {      ProfilerCategory.Scripts.Name,      ProfilerCategory.Memory.Name  };  public override ProfilerModuleViewController CreateDetailsViewController()  {      return new TankEffectsAndMemoryDetailsViewController(ProfilerWindow);  }    // Pass the auto-enabled category names to the base constructor.  public TankEffectsProfilerModule() : base(k_Counters, autoEnabledCategoryNames: k_AutoEnabledCategoryNames) { }}

TankTrailParticleCount

using UnityEditor;using UnityEditorInternal;using Unity.Profiling.Editor;using UnityEngine.UIElements;public class TankEffectsAndMemoryDetailsViewController : TankEffectsDetailsViewController{   // Define a label, which will display the total mesh memory in the selected frame   Label m_MeshMemoryLabel;      protected override VisualElement CreateView()   {       var view = base.CreateView();   	       // Create the label and add it to the view.       m_MeshMemoryLabel = new Label() { style = { paddingTop = 8, paddingLeft = 8 } };       view.Add(m_MeshMemoryLabel);   }      protected override void ReloadData()   {       base.ReloadData();   	       // Retrieve the Mesh Memory counter value from the Profiler as a formatted string.       var selectedFrameIndexInt32 = System.Convert.ToInt32(ProfilerWindow.selectedFrameIndex);       var value = ProfilerDriver.GetFormattedCounterValue(selectedFrameIndexInt32, ProfilerArea.Memory, "Mesh Memory");       // Update the label's text with the value.       m_MeshMemoryLabel.text = $"The value of 'Mesh Memory' in the selected frame is {value}.";   }}

追加リソース

• Profiler モジュールの概要
• Profiler Modules エディターのリファレンス
• Profiler モジュールの詳細パネルの作成
• コードへのプロファイリング情報の追加