There are two ways of analyzing memory usage in your application in Unity:
This page covers information on the built-in Memory Profiler module. For more information on the Memory profiler package, see the Memory Profiler documentation.
The Memory Profiler module visualizes counters that represent the total allocated memory in your application. You can use the memory module to see information like the number of loaded objects, and the memory that they take in total per category. You can also see the number of GC allocations per Profiler frame.
When you profile your application in the Editor, the Memory Profiler module reports higher data use than a similar profile of the application built on a target device would. This is because the Unity Editor uses specific objects that take up memory, and the Editor window itself uses extra memory.
Part of the extra memory use is because Unity treats objects like textures as read/write enabled in the Editor and keeps an extra copy of each texture on the CPU. This effectively doubles the reported memory use of textures in the Editor; for a more accurate idea of memory use by textures, profile a built version of your application running on the target platform.
Also, because Unity can’t cleanly separate the memory that the Profiler itself takes up from the Play mode’s memory, memory that the Profiler uses is displayed in the Profiler window. To remind you of this, a warning displays at the top of the Memory Profiler module details pane whenever you have the Profiler target set to Play Mode or Editor. For more precise numbers and memory usage for your application, you should profile your application on the target device and operating system you intend it to run on. For more information, see the documentation on Profiling your application.
The Memory Profiler module is divided into categories that display detailed information on where your application spends memory. You can also click a category’s colored legend to toggle its display.
Category | Description |
---|---|
Total Allocated | The total memory your application has used. |
Texture Memory | How much memory the TexturesAn image used when rendering a GameObject, Sprite, or UI element. Textures are often applied to the surface of a mesh to give it visual detail. More info See in Glossary in your application have used. |
MeshThe main graphics primitive of Unity. Meshes make up a large part of your 3D worlds. Unity supports triangulated or Quadrangulated polygon meshes. Nurbs, Nurms, Subdiv surfaces must be converted to polygons. More info See in Glossary Memory |
How much memory the Meshes in your application have used. |
Material Count | The number of MaterialAn asset that defines how a surface should be rendered. More info See in Glossary instances in your application. |
Object Count | The number of native object instances in your application. |
GC Used Memory | The amount of memory the GC heap has used. |
GC Allocated in Frame | The amount of memory allocated per frame on the GC heap. |
There are two views available in the module details pane, located at the bottom of the Profiler window:
To change the view, select it from the dropdown in the top left of the module details pane.
The Simple view displays an overview of how Unity uses memory in real-time on a per-frame basis. It breaks down the total memory that your application uses into a few major categories. The Total value is based on the System Used Memory Profiler counter, which indicates how much memory the operating system (OS) reports as being in use by your application.
Unity sets some memory pools aside for allocations to avoid asking the operating system for memory too often. The Profiler module displays how much memory Unity reserves, and how much memory Unity used at the time of the Profiler capture.
The Simple view displays the data collected within the System Used Memory Profiler counterPlaced in code with the ProfilerCounter API to track metrics, such as the number of enemies spawned in your game. More info
See in Glossary. This indicates how much memory the operating system (OS) reports as being in use by the app and corresponds to the Total value of the Total Committed Memory bar and the Total Memory Breakdown bar.
On platforms that support getting the total memory size of the application from the operating system, the System Memory Usage is over 0 and is the same size in a task manager.
The following reference table describes the statistics available in the Simple view, plus its corresponding profiler counter, and availability in Release builds. This information is also available via the ProfilerRecorder API and in the Profiler Module Editor so you can add them to a custom Profiler module.
Property | Description | Corresponding Profiler counter | Available in Release Players? |
---|---|---|---|
Normalized | Enable this setting to scale the Total Committed Memory and Total Memory Breakdown charts to the memory usage of the selected frame. If you disable this setting, the charts scale to the total used memory within the frame range. This setting can help you see how the total or relative amounts of memory change from frame to frame | N/A | N/A |
Total Committed Memory | The length of the Total Committed Memory bar indicates the total amount of memory that Unity’s Memory Manager system tracked, how much of that it used, and how much memory isn’t tracked through this system. | System Used Memory | Yes |
Tracked Memory (in use / Reserved) | Indicates the total amount of memory that Unity uses and tracks (in use), and the amount of memory that Unity reserves for tracking purposes and pool allocations (Reserved). | Total Used Memory Total Reserved Memory |
Yes |
Untracked Memory | Indicates the total amount of memory that Unity used but isn’t aware of. Some examples of untracked memory are: - Memory allocated through native plug-ins or some drivers - Mono or IL2CPP type metadata - Memory that executable code and DLLs use The Memory Profiler package and native platform providers might have more information on some of these untracked memory amounts. |
N/A | N/A |
Total Memory Breakdown | Displays the same total amount as the Total Committed Memory bar but breaks it into some high level categories, based on which subsystems Unity allocated the memory for. Not all memory systems use pools or differentiate between used and reserved memory. Those that do display two numbers, the used and the reserved amount of memory. If the used amount doesn’t share the same unit (B, MB, GB) as the reserved amount, Unity displays the unit, otherwise it’s omitted. |
System Used Memory | Yes |
Managed Heap (in use / Reserved) | The used heap size and total heap size that managed code uses. This memory is garbage collected. | GC Used Memory GC Reserved Memory |
Yes |
Graphics & Graphics Driver | The estimated amount of memory the driver uses on Textures, render targets, Shaders, and Mesh data. | Gfx Used Memory Gfx Reserved Memory |
No |
Audio | The Audio system’s estimated memory usage. | Audio Used Memory Audio Reserved Memory |
Yes |
Video | The Video system’s estimated memory usage. | Video Used Memory Video Reserved Memory |
Yes |
Other | Displays native memory that Unity tracks, but isn’t reported under a specific counter. To get more information on the makeup of this or the other categories, take a snapshot in the Detailed view or with the Memory Profiler package. Important: The Other category doesn’t directly map to the Other group in the Detailed view. In this view, Other contains the remainder of the native memory that was not used for the GPU side of graphics memory, the Profiler, Audio, or Video memory. |
N/A | N/A |
Profiler | The memory that the Profiler functionality uses and reserves from the system. | Profiler Used Memory Profiler Reserved Memory |
Yes |
Objects stats | Displays the amount of object instances of the types of Assets that commonly take up a high percentage of the memory (Textures, Meshes, Materials, Animation Clips), together with their accumulated sizes in memory (Assets, GameObjects, Scene Objects). Note: Texture and Mesh memory doesn’t map directly to the Graphics & Graphics Driver stat in the Total Memory Breakdown view. This is because some of that memory might also fall into the Other category of the Total Memory Breakdown bar. |
Object Count | No |
Textures | The total count of loaded textures and memory they use. | Texture Count Texture Memory |
No |
Meshes | The total count of loaded meshes and memory they use. | Mesh Count Mesh Memory |
No |
Materials | The total count of loaded materials and memory they use. | Material Count Material Memory |
No |
Animation Clips | The total count of loaded AnimationClips and memory they use. | AnimationClip Count AnimationClip Memory |
No |
Assets | The total number of loaded assets. | Asset Count | No |
Game Objects | The total number of GameObjectThe fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info See in Glossary instances in the sceneA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info See in Glossary. |
GameObject Count | No |
Scene Objects | The total number of dynamic UnityEngine.Objects . This number includes the GameObject Count, plus the total number of components, and everything which isn’t an asset in the scene. |
Scene Object Count | No |
GC allocated in frame | Displays the amount of managed allocations in the selected frame, and their total size in bytes. | GC Allocation In Frame Count GC Allocated In Frame |
No |
You can use the ProfilerRecorder API to access the Memory Profiler module’s counters in Players. The following example contains a simple script that collects Total Reserved Memory, GC Reserved Memory and System Used Memory metrics, and displays those as a GUI.TextArea. The Memory Profiler module information belongs to the ProfilerCategory.Memory Profiler categoryIdentifies the workload data for a Unity subsystem (for example, Rendering, Scripting and Animation categories). Unity applies color-coding to categories to visually distinguish between the types of data in the Profiler window.
See in Glossary.
using System.Text;
using Unity.Profiling;
using UnityEngine;
public class MemoryStatsScript : MonoBehaviour
{
string statsText;
ProfilerRecorder totalReservedMemoryRecorder;
ProfilerRecorder gcReservedMemoryRecorder;
ProfilerRecorder systemUsedMemoryRecorder;
void OnEnable()
{
totalReservedMemoryRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Memory, "Total Reserved Memory");
gcReservedMemoryRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Memory, "GC Reserved Memory");
systemUsedMemoryRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Memory, "System Used Memory");
}
void OnDisable()
{
totalReservedMemoryRecorder.Dispose();
gcReservedMemoryRecorder.Dispose();
systemUsedMemoryRecorder.Dispose();
}
void Update()
{
var sb = new StringBuilder(500);
if (totalReservedMemoryRecorder.Valid)
sb.AppendLine($"Total Reserved Memory: {totalReservedMemoryRecorder.LastValue}");
if (gcReservedMemoryRecorder.Valid)
sb.AppendLine($"GC Reserved Memory: {gcReservedMemoryRecorder.LastValue}");
if (systemUsedMemoryRecorder.Valid)
sb.AppendLine($"System Used Memory: {systemUsedMemoryRecorder.LastValue}");
statsText = sb.ToString();
}
void OnGUI()
{
GUI.TextArea(new Rect(10, 30, 250, 50), statsText);
}
}
The following screenshot shows the result of adding the script to the Tanks! tutorial project.
This information is available in Release Players, as are the other high level counters in the table above. If you want to see the selected memory counters in a custom module in the Profiler window, use the Module Editor to configure the chart.
The Detailed view provides a snapshot of your application’s current state. Select the Take Sample button to capture detailed memory usage for the current target. It takes the Profiler time to get this data, so the Detailed view doesn’t give you real-time details. After the Profiler takes a sample, the Profiler window displays a list view where you can explore your application’s memory usage in more detail.
Enable the Gather Object References setting at the top of the module details pane to collect information about what’s referencing an object at the time of the snapshot. The Profiler displays this information in the right-hand pane of the window.
The list view divides objects that use memory into the following categories:
When you click on a GameObject in the Assets or Scene Memory list, Unity highlights it in the Project or Scene viewAn interactive view into the world you are creating. You use the Scene View to select and position scenery, characters, cameras, lights, and all other types of Game Object. More info
See in Glossary.
Note: In the Other category, memory reported under System.ExecutableAndDlls
is read-only memory. The operating system might discard these pages as needed and later reload them from the file system. This generates lower memory usage, and doesn’t directly contribute to the operating system’s decision to close your application if it uses too much memory. Some of these pages might also be shared with other applications that are using the same frameworks.