Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

CreatingMetadata

A metadata event that collection methods can subscribe to.
Read time 1 minuteLast updated 7 days ago

Definition

public static event Action<MemorySnapshotMetadata> CreatingMetadata

Remarks

This event is fired when you capture a memory snapshot. Use it to provide meta data to the snapshot file, for example information related to the context, such as the level, in which it was 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, MemorySnapshotMetadata.