AsyncReadManagerMetricsFilters

Description

Defines a filter for selecting specific categories of data when summarizing AsyncReadManager metrics.

Pass a filter to AsyncReadManagerMetrics.GetCurrentSummaryMetrics or AsyncReadManagerMetrics.GetSummaryOfMetrics to limit the summary to the categories of data specified in the filter. For each category supported by the AsyncReadManagerMetricsFilters, you can specify either a single value or an array of values.

using Unity.IO.LowLevel.Unsafe;
using UnityEngine;

public class GetMetricsSummarySample : MonoBehaviour
{
#if ENABLE_PROFILER && UNITY_2020_2_OR_NEWER
    AsyncReadManagerMetricsFilters m_SummaryFilter;

    public void Start()
    {
        AsyncReadManagerMetrics.StartCollectingMetrics();
        // Create a filter for mesh and texture file reads that have been completed or failed
        AssetLoadingSubsystem[] assetLoadingSubsystems = new AssetLoadingSubsystem[] { AssetLoadingSubsystem.Texture, AssetLoadingSubsystem.Mesh };
        m_SummaryFilter = new AsyncReadManagerMetricsFilters(assetLoadingSubsystems);
        m_SummaryFilter.SetStateFilter(new ProcessingState[] { ProcessingState.Completed, ProcessingState.Failed });
    }

    public void Update()
    {
        if (Time.frameCount == 10)
        {
            AsyncReadManagerSummaryMetrics summary = AsyncReadManagerMetrics.GetCurrentSummaryMetrics(m_SummaryFilter, AsyncReadManagerMetrics.Flags.ClearOnRead);
            Debug.Log($"Average bandwidth for Completed or Failed reads of Textures or Meshes: {summary.AverageBandwidthMBPerSecond} MB/s.");
        }
    }

#endif
}

Constructors

Public Methods