Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetItemMergedSamplesMetadata(int, int, int)

Returns string representation of hierarchy item metadata value.
Read time 1 minuteLast updated 12 days ago

Definition

public string GetItemMergedSamplesMetadata(int id, int sampleIndex, int metadataIndex)

Parameters

id

Hierarchy item identifier.

sampleIndex

Merged sample index.

metadataIndex

Metadata index.

Returns

Type

Description

stringReturns value of the metadata as string.

Remarks

Use to get a string metadata value of the specific hierarchy view item.
using System.Text;using UnityEditor.Profiling;public class Example{ public static string GetFormattedMetadata(HierarchyFrameDataView frameDataView, int itemId, int mergedSampleIndex) { int sampleMetadataCount = frameDataView.GetItemMergedSamplesMetadataCount(itemId, mergedSampleIndex); if (sampleMetadataCount == 0) return null; var metadataInfo = frameDataView.GetMarkerMetadataInfo(frameDataView.GetItemMarkerID(itemId)); var sb = new StringBuilder(); for (var i = 0; i < sampleMetadataCount; ++i) { if (metadataInfo != null && i < metadataInfo.Length) sb.Append(metadataInfo[i].name); else sb.Append(i); sb.Append(": "); sb.Append(frameDataView.GetItemMergedSamplesMetadata(itemId, mergedSampleIndex, i)); sb.Append('\n'); } return sb.ToString(); }}
Throws:
System.ArgumentException if id is invalid. System.IndexOutOfRangeException if sampleIndex is not in the range from 0 to HierarchyFrameDataView.GetItemMergedSamplesCount. System.IndexOutOfRangeException if medataIndex is not in the range from 0 to HierarchyFrameDataView.GetItemMergedSamplesMetadataCount.