A custom ProfilerA window that helps you to optimize your game. It shows how much time is spent in the various areas of your game. For example, it can report the percentage of time spent rendering, animating, or in your game logic. More info
See in Glossary module displays performance data from your system in the Profiler window.
You can create a custom profiler module in one of the following ways:
Some packages include custom profiler modules that you can use when you install that specific package. For more information, refer to the Profiler modules list.
A custom module displays the counters you specified in code in the Profiler window chart view (A), and the counters appear as a list in the module details panel (B).
You can use Unity’s built-in Profiler Module Editor to create a custom Profiler module. For more information, refer to the Profiler Module Editor documentation section Creating a custom module.
To create a custom Profiler module via code, you must create a new ProfilerModule script and define the module’s properties including the counters it displays, its name, and its icon.
To define a custom Profiler module, your script must do the following:
Define a class derived from ProfilerModule in your project or package. In the following example, the class is called TankEffectsProfilerModule
:
public class TankEffectsProfilerModule : ProfilerModule
Assign the ProfilerModuleMetadata attribute to this class and specify the module’s display name in the attribute’s argument. In the following example, the display name is “Tank Effects”:
[ProfilerModuleMetadata("Tank Effects")]
Implement a constructor that has no parameter, and pass a list of chart counter descriptions to the base constructor. In the following example, the constructor with no parameter is TankEffectsProfilerModule()
, the list of chart counter descriptors is k_Counters
, and the base constructor is base
:
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) { }
When you define a custom Profiler module, the Profiler window automatically detects it. To view data in your custom Profiler module in the Profiler window:
You can also run the Profiler when your application is in Play mode. However, if you profile an application in Play mode, the Profiler displays data that is not representative of how your application runs when you build it on a hardware device.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.