class in Unity.Profiling.Memory
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseContainer for memory snapshot metadata.
Code that subscribes to the MemoryProfiler.CreatingMetadata event receives a MemorySnapshotMetadata object to populate with meta data for a memory snapshot that is about to be taken.
using System; using UnityEngine; using Unity.Profiling.Memory;
public class MemoryProfilerExample : MonoBehaviour { public string levelName = "Default Level Name";
void Start() { MemoryProfiler.CreatingMetadata += CreateMetadata; }
void CreateMetadata(MemorySnapshotMetadata metadata) { metadata.Description = $"This Memory Snapshot capture started at {DateTime.Now} in level {levelName}."; }
void OnDestroy() { MemoryProfiler.CreatingMetadata -= CreateMetadata; } }
Note: If the project has the Memory Profiler package installed in the Editor, it is recommended to implement a concrete implementation of MemoryProfiler.MetadataCollect instead, which will inject your implementation into any Player builds you make.
Additional resources: MemoryProfiler.MetadataCollect", MemoryProfiler.TakeSnapshot, MemoryProfiler.CreatingMetadata.
| Description | User defined metadata that provides a description for the memory snapshot. |