Version: 2023.2
LanguageEnglish
  • C#

HierarchyFrameDataView.ItemContainsRawFrameDataViewIndex

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 bool ItemContainsRawFrameDataViewIndex(int id, int sampleIndex);

Parameters

id Hierarchy item identifier.
sampleIndex The particular profiler sample index that should be checked if it is represented by this hierarchy item.

Returns

bool True if the sample index is represented by this hierarchy item, false if it is not.

Description

Checks if the provided raw sample index matches any of the raw sample indices associated with this Hierarchy item identifier.

When HierarchyFrameDataView.ViewMode.MergeSamplesWithTheSameName is active, Unity merges multiple samples with the same name at the same hierarchy level together in a single item.

As a result of this behavior, and the hierarchical structure of the samples in HierarchyFrameDataView, the Hierarchy item identifiers that HierarchyFrameDataView uses, do not correspond to the sample indices that RawFrameDataView uses. To get these indices to use with RawFrameDataView, use GetItemRawFrameDataViewIndices.

However, if you only want to confirm that an item in the HierarchyFrameDataView corresponds to a particular sample index you can use ItemContainsRawFrameDataViewIndex to confirm that without the need to retrieve the entire list of sample indices.

Throws:
System.ArgumentException if id is invalid.

Additional resources: HierarchyFrameDataView.GetItemMergedSamplesCount, HierarchyFrameDataView.GetItemRawFrameDataViewIndices, RawFrameDataView.