Version: 2022.3
LanguageEnglish
  • C#

HierarchyFrameDataView.GetItemMergedSamplesMetadataAsFloat

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

Declaration

public float GetItemMergedSamplesMetadataAsFloat(int id, int sampleIndex, int metadataIndex);

Parameters

id Hierarchy item identifier.
sampleIndex Merged sample index.
metadataIndex Metadata index.

Returns

float Returns value of the metadata as float.

Description

Returns float representation of hierarchy item metadata value.

Throws:
System.ArgumentException if id is invalid. System.IndexOutOfRangeException if sampleIndex is not in the range from 0 to GetItemMergedSamplesCount. System.IndexOutOfRangeException if medataIndex is not in the range from 0 to GetItemMergedSamplesMetadataCount.

Additional resources: GetItemMergedSamplesCount, GetItemMergedSamplesMetadataCount, GetItemMetadataAsFloat.