PackedMemorySnapshot
PackedMemorySnapshot is a compact representation of a memory snapshot that a player has sent through the profiler connection.
Read time 2 minutesLast updated 6 days ago
Definition
- Type: Class
- Namespace: UnityEditor.Profiling.Memory.Experimental
- Assembly: UnityEditor.CoreModule
- Implements: IDisposable
Warning
Deprecated. This API is outdated and will be removed. Please check out the Memory Profiler Package (https://docs.unity3d.com/Packages/com.unity.memoryprofiler@latest/)
public class PackedMemorySnapshot : IDisposable
Properties
Property | Description |
|---|---|
| captureFlags | Flags corresponding to the fields present in a returned memory snapshot. |
| connections | Connections is an array of from,to pairs that describe which things are keeping which other things alive. |
| fieldDescriptions | Array of Field Descriptions, referenced by Type Description entries by array index. |
| filePath | Path to the memory snapshot file. |
| gcHandles | All GC handles in use in the memorysnapshot. |
| managedHeapSections | Array of actual managed heap memory sections. |
| managedStacks | Array of managed stacks in a memory snapshot. |
| nativeAllocations | Array of native allocation data, captured in C++. |
| nativeAllocationSites | Array of native allocation site data, captured in C++. |
| nativeCallstackSymbols | Array of callstack symbols, used by native allocation site data. |
| nativeMemoryLabels | Array of memory labels, used by native allocation site data. |
| nativeMemoryRegions | Array of native memory regions, which houses native allocations. |
| nativeObjects | All native C++ objects that were loaded at time of the snapshot. |
| nativeRootReferences | Array of native root references, which represent ownership of native allocation data. |
| nativeTypes | Descriptions of all the C++ unity types the profiled player knows about. |
| recordDate | The time and date at which the snapshot was recorded. |
| typeDescriptions | An array of indexes into PackedMemorySnapshot.typeDescriptions indetifying the type this field belongs to. |
| version | The current snapshot format version. |
| virtualMachineInformation | Information about the virtual machine running executing the managed code inside the player. |
Methods
Method | Description |
|---|---|
| Dispose | Disposes of an existing PackedMemorySnapshot object and closes the file reader. |
Static Methods
Method | Description |
|---|---|
| Convert | Converts the specified old format PackedMemorySnapshot object to a new PackedMemorySnapshot format object and writes it to the location and file name specified the the write path. |
| Load | Load memory snapshot from given file path. |
| Save | Copy the memory snapshot file to the given file path. |