Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetFrameMetaData

Retrieves metadata associated with the frame.
Read time 3 minutesLast updated 10 days ago

Definition

GetFrameMetaData<T>(Guid, int)

Retrieves metadata associated with the frame.
public NativeArray<T> GetFrameMetaData<T>(Guid id, int tag) where T : struct

Parameters

id

Guid
Project or package identifier.

tag

int
Data stream index.

Returns

Type

Description

NativeArray<T>Returns the frame metadata as a NativeArray.

Remarks

Use GetFrameMetaData to retrieve the data that the Profiler.EmitFrameMetaData method wrote to the Profiler stream.
Use id to identify the metadata from your Project or package.
Use tag to distinguish between different data streams.
Use index to retrieve separate data chunks for each Profiler.EmitFrameMetaData called in a frame.
using System;using Unity.Collections;using UnityEditor.Profiling;using UnityEditorInternal;using UnityEngine;using UnityEngine.Profiling;public class Example{    public struct TextureInfo    {        public int format;        public int w;        public int h;    }    public static readonly Guid MyProjectId = new Guid("7E1DEA84-51F1-477A-82B5-B5C57AC1EBF7");    public static readonly int TextureInfoTag = 0;    public static readonly int TextureDataTag = 1;    public void EmitTextureToProfilerStream(Texture2D t)    {        TextureInfo textureInfo = new TextureInfo() { format = (int)t.format, w = t.width, h = t.height };        NativeArray<byte> textureData = t.GetRawTextureData<byte>();        Profiler.EmitFrameMetaData(MyProjectId, TextureInfoTag, new[] { textureInfo });        Profiler.EmitFrameMetaData(MyProjectId, TextureDataTag, textureData);    }    public Texture2D GetTextureFromProfilerStream(int frame)    {        using (var frameData = ProfilerDriver.GetHierarchyFrameDataView(frame, 0, HierarchyFrameDataView.ViewModes.Default, HierarchyFrameDataView.columnDontSort, false))        {            NativeArray<TextureInfo> textureInfos = frameData.GetFrameMetaData<TextureInfo>(MyProjectId, TextureInfoTag);            if (textureInfos.Length == 0)                return null;            NativeArray<byte> textureData = frameData.GetFrameMetaData<byte>(MyProjectId, TextureDataTag);            if (textureData.Length == 0)                return null;            TextureInfo textureInfo = textureInfos[0];            Texture2D texture = new Texture2D(textureInfo.w, textureInfo.h, (TextureFormat)textureInfo.format, false);            texture.LoadRawTextureData(textureData);            return texture;        }    }}
Note:
The FrameDataView instance defines the lifetime of the returned ''NativeArray'. As such, if FrameDataView is disposed, all returned metadata becomes invalid and cannot be used. Copy data to a new NativeArray if you need it for longer duration.
Additional Resources: Profiler.EmitFrameMetaData.

GetFrameMetaData<T>(Guid, int, int)

Retrieves metadata associated with the frame.
public NativeArray<T> GetFrameMetaData<T>(Guid id, int tag, int index) where T : struct

Parameters

id

Guid
Project or package identifier.

tag

int
Data stream index.

index

int
Chunk index.

Returns

Type

Description

NativeArray<T>Returns the frame metadata as a NativeArray.

Remarks

Use GetFrameMetaData to retrieve the data that the Profiler.EmitFrameMetaData method wrote to the Profiler stream.
Use id to identify the metadata from your Project or package.
Use tag to distinguish between different data streams.
Use index to retrieve separate data chunks for each Profiler.EmitFrameMetaData called in a frame.
using System;using Unity.Collections;using UnityEditor.Profiling;using UnityEditorInternal;using UnityEngine;using UnityEngine.Profiling;public class Example{    public struct TextureInfo    {        public int format;        public int w;        public int h;    }    public static readonly Guid MyProjectId = new Guid("7E1DEA84-51F1-477A-82B5-B5C57AC1EBF7");    public static readonly int TextureInfoTag = 0;    public static readonly int TextureDataTag = 1;    public void EmitTextureToProfilerStream(Texture2D t)    {        TextureInfo textureInfo = new TextureInfo() { format = (int)t.format, w = t.width, h = t.height };        NativeArray<byte> textureData = t.GetRawTextureData<byte>();        Profiler.EmitFrameMetaData(MyProjectId, TextureInfoTag, new[] { textureInfo });        Profiler.EmitFrameMetaData(MyProjectId, TextureDataTag, textureData);    }    public Texture2D GetTextureFromProfilerStream(int frame)    {        using (var frameData = ProfilerDriver.GetHierarchyFrameDataView(frame, 0, HierarchyFrameDataView.ViewModes.Default, HierarchyFrameDataView.columnDontSort, false))        {            NativeArray<TextureInfo> textureInfos = frameData.GetFrameMetaData<TextureInfo>(MyProjectId, TextureInfoTag);            if (textureInfos.Length == 0)                return null;            NativeArray<byte> textureData = frameData.GetFrameMetaData<byte>(MyProjectId, TextureDataTag);            if (textureData.Length == 0)                return null;            TextureInfo textureInfo = textureInfos[0];            Texture2D texture = new Texture2D(textureInfo.w, textureInfo.h, (TextureFormat)textureInfo.format, false);            texture.LoadRawTextureData(textureData);            return texture;        }    }}
Note:
The FrameDataView instance defines the lifetime of the returned ''NativeArray'. As such, if FrameDataView is disposed, all returned metadata becomes invalid and cannot be used. Copy data to a new NativeArray if you need it for longer duration.
Additional Resources: Profiler.EmitFrameMetaData.