Version: 2021.1
LanguageEnglish
  • C#

AsyncReadManagerMetricsFilters

class in Unity.IO.LowLevel.Unsafe

/

Implemented in:UnityEngine.CoreModule

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

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

AsyncReadManagerMetricsFiltersConstructor for an instance of the Summary Metrics Filters, used to filter the metrics data that is included in the calculation of a summary.

Public Methods

ClearFiltersClears all the filters on an existing AsyncReadManagerMetricsFilters instance.
RemovePriorityFilterRemove the Priority filters from an existing SummaryMetricsFilters instance.
RemoveReadTypeFilterRemove the ReadType filters from an existing SummaryMetricsFilters instance.
RemoveStateFilterRemove the State filters from an existing SummaryMetricsFilters instance.
RemoveSubsystemFilterRemove the Subsystem filters from an existing SummaryMetricsFilters instance.
RemoveTypeIDFilterRemove the TypeID filters from an existing SummaryMetricsFilters instance.
SetPriorityFilterSet Priority filters on an existing SummaryMetricsFilters instance.
SetReadTypeFilterSet FileReadType filters on an existing SummaryMetricsFilters instance.
SetStateFilterSet ProcessingState filters on an existing SummaryMetricsFilters instance.
SetSubsystemFilterSet AssetLoadingSubsystem filters on an existing SummaryMetricsFilters instance.
SetTypeIDFilterSet TypeID filters on an existing SummaryMetricsFilters instance.