创建自定义模块详情面板
当您选择一个模块时，模块详情面板会出现在 性能分析器一个帮助您优化游戏的窗口。它显示您的游戏在各个区域花费的时间。例如，它可以报告渲染、动画或游戏逻辑所花费的时间百分比。 更多信息
在 术语表 中查看 窗口的底部。您可以自定义此部分以显示与您的模块相关的附加详细信息，或显示性能数据的自定义可视化。
为您的性能分析器模块创建一个自定义模块详情面板
- 创建一个模块详情面板控制器脚本 以绘制自定义模块详情面板。
- 创建一个性能分析器模块脚本来 将您自定义的模块详情面板控制器连接到您的自定义性能分析器模块。
创建用于控制模块详情面板的脚本
您可以使用 ProfilerModuleViewController 基类来自定义性能分析器窗口中的模块详情面板。为此，创建一个脚本，用于控制在选择特定模块时模块详情面板中显示的内容。
您为自定义模块详情面板创建的脚本必须
- 为视图控制器定义公共构造函数，该构造函数调用基构造函数
base(profilerWindow)。 - 重写
CreateView以构建自定义模块详情面板。
例如
public class CustomDetailsViewController : ProfilerModuleViewController
{
public CustomDetailsViewController(ProfilerWindow profilerWindow) : base(profilerWindow) { }
protected override VisualElement CreateView()
{
// Create your UI.
}
}
有关完整模块详情面板控制器脚本示例的示例，请参见 模块详情面板控制器脚本示例。
模块详情面板控制器脚本示例
以下脚本示例创建了一个模块详情面板控制器，在该控制器中，模块详情面板中绘制一个标签，显示文本
此模块详情面板控制器脚本示例执行以下操作
- 定义并创建一个标签来显示您想要捕获的值，并将该标签添加到模块详情面板中。
- 定义一个构造函数来控制模块详情面板，并使用 CreateView 构建自定义模块详情面板。
- 用当前帧中的数据填充标签，并在每个帧后更新标签。
- 获取一个计数器值作为字符串，可以在模块详情面板中显示。
- 指定模块详情面板中要显示的文本，并告诉性能分析器在每帧自动更新它。
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) { }
// Override CreateView to build the custom module details panel.6666666667reateView()
{
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);
// Populate the label 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;
}
// 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);
}
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();
}
}
在模块详情面板中创建自定义UI元素
您可以使用Unity的UIToolkit为模块详情面板构建自定义 UI(用户界面) 允许用户与应用程序交互。Unity目前支持三个UI系统。 更多信息
在 术语表 中查看。有关更多信息，请参阅 UI Toolkit。
以下示例图像显示了属于自定义 自适应性能 模块的自定义模块详情面板
将自定义模块详情面板连接到性能分析器模块
要显示自定义模块详细信息面板，您需要在选择您的Profiler模块时实例化模块详细信息面板控制器。为此，请重写CreateDetailsViewController以创建和绘制新的模块详细信息面板控制器。Unity将在显示您的模块详细信息面板时调用此方法。
以下代码示例实例化了名为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);
}
}
在模块详细信息面板中可视化额外的计数器
您可以在模块详细信息面板中显示不属于您模块图表视图的计数器。当您想显示所选帧的附加数据时，这很有用。
当活动模块时，Profiler会自动捕获属于模块图表视图的所有计数器的类别。要捕获额外的计数器，编写脚本告诉Profiler在您的模块活动时捕获特定类别。
例如，以下脚本使用autoEnabledCategoryNames构造函数参数指定脚本一段代码，允许您创建自己的组件、触发游戏事件、随时间修改组件属性并以任何您喜欢的方式响应用户输入。更多信息
参见术语表和内存类别。这使这些类别在模块活动时生效
using Unity.Profiling;
using Unity.Profiling.Editor;
[System.Serializable]
[ProfilerModuleMetadata("Tank Effects")]
public class TankEffectsProfilerModule : 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
};
// Pass the auto-enabled category names to the base constructor.
public TankEffectsProfilerModule() : base(k_Counters, autoEnabledCategoryNames: k_AutoEnabledCategoryNames) { }