ProfilerModuleMetadataAttribute

class in Unity.Profiling.Editor

Description

Provides metadata related to a ProfilerModule, such as its name and icon path.

You must attribute a ProfilerModule derived type with ProfilerModuleMetadataAttribute for Unity to display it in the Profiler window.

using System;
using Unity.Profiling;
using Unity.Profiling.Editor;

[Serializable] [ProfilerModuleMetadata("Garbage Collection")] public class GarbageCollectionProfilerModule : ProfilerModule { static readonly ProfilerCounterDescriptor[] k_ChartCounters = new ProfilerCounterDescriptor[] { new ProfilerCounterDescriptor("GC Reserved Memory", ProfilerCategory.Memory), new ProfilerCounterDescriptor("GC Used Memory", ProfilerCategory.Memory), new ProfilerCounterDescriptor("GC Allocated In Frame", ProfilerCategory.Memory), };

public GarbageCollectionProfilerModule() : base(k_ChartCounters) {} }

Additional resources: ProfilerModule.

Properties

DisplayNameThe attributed Profiler module’s display name.
IconPathThe path to the attributed Profiler module’s icon.

Constructors

ProfilerModuleMetadataAttributeInitializes and returns an instance of ProfilerModuleMetadataAttribute.

Did you find this page useful? Please give it a rating: