MemorySnapshotMetadata
Container for memory snapshot metadata.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Class
- Namespace: Unity.Profiling.Memory
- Assembly: UnityEngine.CoreModule
public class MemorySnapshotMetadata
Remarks
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.
Properties
Property | Description |
|---|---|
| Description | User defined metadata that provides a description for the memory snapshot. |