Version: Unity 6.5 Alpha (6000.5)
LanguageEnglish
  • C#

ProfilerModuleMetadataAttribute Constructor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public ProfilerModuleMetadataAttribute(string displayName);

Parameters

Parameter Description
displayName The display name shown for the module in the Profiler window.

Description

Initializes and returns an instance of ProfilerModuleMetadataAttribute.

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 Tooltip and IconPath properties.

Additional resources: ProfilerModule, ProfilerModuleMetadataAttribute.Tooltip, ProfilerModuleMetadataAttribute.IconPath.