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.
Closepath | Destination path for the memory snapshot file. |
finishCallback | Event that is fired once the memory snapshot has finished the process of capturing data. |
captureFlags | Flag mask defining the content of the memory snapshot. |
Trigger memory snapshot capture.
Request a memory snapshot capture with the provided arguments. Note that depending on the target build used to capture the snapshot not all fields corresponding to the capture flags will be collected. Two different behaviors of data collection are present inside the system:
* When called directly from the Player or in the Editor (without being connected to a profiling target) - the process is synchronous, creating the memory snapshot file on the host device. Meta data collection will take place if at least one collection callback was registered to MemoryProfiler.CreateMetaData. At the end of the process MemoryProfiler.SnapshotFinished is triggered.
* When called in the context of an Editor connected to a profiling target - the process is asynchronous, creating the memory snapshot file on the host device and sending a capture request to the remote target. The target device then collects meta data using callbacks registered to MemoryProfiler.CreateMetaData. Note that the callbacks must be defined in the profiling target's local assemblies and registered at runtime prior to the capture event being sent. All captured data will be streamed to the Editor from the remote target. On having completed the capture process MemoryProfiler.SnapshotFinished will be triggered inside the Editor.
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:
Thanks for helping to make the Unity documentation better!