class in Unity.IO.LowLevel.Unsafe
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseManages the recording and retrieval of metrics from the AsyncReadManager.
The metrics manager records the states and timings of individual read operations, as well as additional, contextual information for certain asset types. The manager collects metrics for C# AsyncReadManager.Read operations and read operations from internal Unity systems.
Begin recording metrics by calling StartCollectingMetrics and end recording with StopCollectingMetrics. You can enable metrics collection when your program first launches using the command-line argument "-enable-file-read-metrics". Turn off metrics when your data collection is finished to avoid the small performance impact associated with metric collection.
Retrieve metric data by calling GetMetrics, which returns an array of metrics records. You can also get a summary of the current data with GetCurrentSummaryMetrics. In both cases, you can choose whether or not to clear the existing metrics when you make these functions calls. If you do not clear the metrics data, then the same records are included in the returned array or summary the next time you get the metrics or a summary. If you do clear the metrics, only new data is included the next time you call either method.
Call GetSummaryOfMetrics to summarize the records in an array of AsyncReadManagerRequestMetric objects (which you have retrieved earlier using GetMetrics). When calling either GetSummaryOfMetrics or GetCurrentSummaryMetrics, you can filter the data used to compute the summary by passing in a set of AsyncReadManagerMetricsFilters objects.
The AsyncReadManagerMetrics class is only available in development builds and the Editor. You should guard usage of this class using the scripting define symbol ENABLE_PROFILER
(as demonstrated in following example).
using UnityEngine; using Unity.IO.LowLevel.Unsafe;
class AsyncReadManagerMetricsSample : MonoBehaviour { const int maxNumberFrames = 10; public void Start() { #if ENABLE_PROFILER && UNITY_2020_2_OR_NEWER AsyncReadManagerMetrics.StartCollectingMetrics(); #endif }
public void Update() { if (Time.frameCount > maxNumberFrames) { #if ENABLE_PROFILER && UNITY_2020_2_OR_NEWER AsyncReadManagerRequestMetric[] metrics = AsyncReadManagerMetrics.GetMetrics(AsyncReadManagerMetrics.Flags.ClearOnRead); AsyncReadManagerMetrics.StopCollectingMetrics(); Debug.LogFormat("Number of metrics collected: {0}", metrics.Length); // If no reads have been triggered, this will be zero #endif } } }
ClearCompletedMetrics | Clears the metrics for all completed requests, including failed and canceled requests. |
GetCurrentSummaryMetrics | Gets a summary of the metrics collected for AsyncReadManager read operations since you started data collection or last cleared the metrics data. |
GetMetrics | Returns the current AsyncReadManager metrics. |
GetSummaryOfMetrics | Summarizes an array containing AsyncReadManagerRequestMetric records. |
GetTotalSizeOfNonASRMReadsBytes | Returns the amount of data (in bytes) read through systems other than the AsyncReadManager. |
IsEnabled | Reports whether the metrics system for the AsyncReadManager is currently recording data. |
StartCollectingMetrics | Begin recording metrics data for AsyncReadManager read operations. |
StopCollectingMetrics | Stop recording metrics data for AsyncReadManager read operations. |
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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.