class in UnityEngine.Profiling
/
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.
CloseControls the Profiler from script.
You can add custom Profiler sections in your scripts with Profiler.BeginSample and Profiler.EndSample.
On standalone platforms, you can save all profiling information to a file, which allows you to inspect it later. To do this, you must specify a Profiler.logFile and set both Profiler.enabled and Profiler.enableBinaryLog to true
.
Because use of the Profiler negatively affects the performance of your app, most of the Profiler API functionality is only available when you enable the `Development Build`. Therefore, you must enable `Developer Build` if you want to use profiler API methods in your built app. Disabling `Development Build` makes your app run faster, but prevents you from using most of the Profiler API methods.
The exception to this are the Profiler API methods relating to memory usage. Because Unity manages most of its system memory at run-time, it can provide that information with no performance penalty; therefore these methods are available even if you don't enable `Development Build`. This applies to all memory-related Profiler API methods except Profiler.GetAllocatedMemoryForGraphicsDriver and Profiler.GetRuntimeMemorySizeLong, since they require extra profiling data only available in development builds.
areaCount | The number of Profiler Areas that you can profile. |
enableAllocationCallstacks | Enables the recording of callstacks for managed allocations. |
enableBinaryLog | Enables the logging of profiling data to a file. |
enabled | Enables the Profiler. |
logFile | Specifies the file to use when writing profiling data. |
maxUsedMemory | Sets the maximum amount of memory that Profiler uses for buffering data. This property is expressed in bytes. |
usedHeapSizeLong | Returns the number of bytes that Unity has allocated. This does not include bytes allocated by external libraries or drivers. |
AddFramesFromFile | Displays the recorded profile data in the profiler. |
BeginSample | Begin profiling a piece of code with a custom label. |
BeginThreadProfiling | Enables profiling on the thread from which you call this method. |
EmitFrameMetaData | Write metadata associated with the current frame to the Profiler stream. |
EmitSessionMetaData | Write metadata associated with the whole Profiler session capture. |
EndSample | Ends the current profiling sample. |
EndThreadProfiling | Frees the internal resources used by the Profiler for the thread. |
GetAllCategories | Returns all ProfilerCategory registered in Profiler. |
GetAllocatedMemoryForGraphicsDriver | Returns the amount of allocated memory for the graphics driver, in bytes.Only available in development players and editor. |
GetAreaEnabled | Returns whether or not a given ProfilerArea is currently enabled. |
GetCategoriesCount | Returns number of ProfilerCategory registered in Profiler. |
GetMonoHeapSizeLong | Returns the size of the reserved space for managed-memory. |
GetMonoUsedSizeLong | Gets the allocated managed memory for live objects and non-collected objects. |
GetRuntimeMemorySizeLong | Gathers the native-memory used by a Unity object. |
GetTempAllocatorSize | Returns the size of the temp allocator. |
GetTotalAllocatedMemoryLong | The total memory allocated by the internal allocators in Unity. Unity reserves large pools of memory from the system; this includes double the required memory for textures because Unity keeps a copy of each texture on both the CPU and GPU. This function returns the amount of used memory in those pools. |
GetTotalFragmentationInfo | Returns heap memory fragmentation information. |
GetTotalReservedMemoryLong | The total memory Unity has reserved. |
GetTotalUnusedReservedMemoryLong | Unity allocates memory in pools for usage when unity needs to allocate memory. This function returns the amount of unused memory in these pools. |
IsCategoryEnabled | Returns whether or not a given ProfilerCategory is currently enabled. |
SetAreaEnabled | Enable or disable a given ProfilerArea. |
SetCategoryEnabled | Enable or disable a given ProfilerCategory. |
SetTempAllocatorRequestedSize | Sets the size of the temp allocator. |
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.