ProfilerModuleMetadataAttribute(string)
Initializes and returns an instance of ProfilerModuleMetadataAttribute.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Constructor
- Namespace: Unity.Profiling.Editor
- Assembly: UnityEditor.CoreModule
public ProfilerModuleMetadataAttribute(string displayName)
Parameters
The display name shown for the module in the Profiler window.
Remarks
using System;using Unity.Profiling;using Unity.Profiling.Editor;[ProfilerModuleMetadata("Custom Performance Metrics")]public class CustomPerformanceProfilerModule : ProfilerModule{ static readonly ProfilerCounterDescriptor[] k_ChartCounters = new ProfilerCounterDescriptor[] { new ProfilerCounterDescriptor("Frame Budget", ProfilerCategory.Scripts), new ProfilerCounterDescriptor("Active Systems", ProfilerCategory.Scripts), }; public CustomPerformanceProfilerModule() : base(k_ChartCounters) {}}
The display name is required and will appear in the Profiler window's module dropdown. After constructing the attribute, you can optionally set the ProfilerModuleMetadataAttribute.Tooltip and ProfilerModuleMetadataAttribute.IconPath properties.
Additional Resources: ProfilerModule, ProfilerModuleMetadataAttribute.Tooltip, ProfilerModuleMetadataAttribute.IconPath.