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 }
AsyncReadManagerMetricsFilters | Constructor for an instance of the Summary Metrics Filters, used to filter the metrics data that is included in the calculation of a summary. |
ClearFilters | Clears all the filters on an existing AsyncReadManagerMetricsFilters instance. |
RemovePriorityFilter | Remove the Priority filters from an existing SummaryMetricsFilters instance. |
RemoveReadTypeFilter | Remove the ReadType filters from an existing SummaryMetricsFilters instance. |
RemoveStateFilter | Remove the State filters from an existing SummaryMetricsFilters instance. |
RemoveSubsystemFilter | Remove the Subsystem filters from an existing SummaryMetricsFilters instance. |
RemoveTypeIDFilter | Remove the TypeID filters from an existing SummaryMetricsFilters instance. |
SetPriorityFilter | Set Priority filters on an existing SummaryMetricsFilters instance. |
SetReadTypeFilter | Set FileReadType filters on an existing SummaryMetricsFilters instance. |
SetStateFilter | Set ProcessingState filters on an existing SummaryMetricsFilters instance. |
SetSubsystemFilter | Set AssetLoadingSubsystem filters on an existing SummaryMetricsFilters instance. |
SetTypeIDFilter | Set TypeID filters on an existing SummaryMetricsFilters instance. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.