Show / Hide Table of Contents

Class Profiler

Inheritance
Object
Profiler
Inherited Members
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: UnityEngine.Profiling
Assembly: UnityEngine.dll
Syntax
[MovedFrom("UnityEngine")]
public sealed class Profiler

Properties

| Improve this Doc View Source

areaCount

Declaration
public static int areaCount { get; }
Property Value
Type Description
Int32

enableBinaryLog

Declaration
public static bool enableBinaryLog { get; set; }
Property Value
Type Description
Boolean

enabled

Declaration
public static bool enabled { get; set; }
Property Value
Type Description
Boolean

logFile

Declaration
public static string logFile { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

maxNumberOfSamplesPerFrame

Declaration
[Obsolete("maxNumberOfSamplesPerFrame has been depricated. Use maxUsedMemory instead")]
public static int maxNumberOfSamplesPerFrame { get; set; }
Property Value
Type Description
Int32

maxUsedMemory

Declaration
public static int maxUsedMemory { get; set; }
Property Value
Type Description
Int32

supported

Declaration
public static bool supported { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

usedHeapSize

Declaration
[Obsolete("usedHeapSize has been deprecated since it is limited to 4GB. Please use usedHeapSizeLong instead.")]
public static uint usedHeapSize { get; }
Property Value
Type Description
UInt32

usedHeapSizeLong

Declaration
public static long usedHeapSizeLong { get; }
Property Value
Type Description
Int64

Methods

| Improve this Doc View Source

AddFramesFromFile(String)

Declaration
[Conditional("UNITY_EDITOR")]
public static void AddFramesFromFile(string file)
Parameters
Type Name Description
String file
| Improve this Doc View Source

BeginSample(String)

Declaration
[Conditional("ENABLE_PROFILER")]
public static void BeginSample(string name)
Parameters
Type Name Description
String name
| Improve this Doc View Source

BeginSample(String, Object)

Declaration
[Conditional("ENABLE_PROFILER")]
public static void BeginSample(string name, Object targetObject)
Parameters
Type Name Description
String name
Object targetObject
| Improve this Doc View Source

BeginThreadProfiling(String, String)

Declaration
[Conditional("ENABLE_PROFILER")]
public static void BeginThreadProfiling(string threadGroupName, string threadName)
Parameters
Type Name Description
String threadGroupName
String threadName

EndSample()

Declaration
[Conditional("ENABLE_PROFILER")]
public static void EndSample()

EndThreadProfiling()

Declaration
public static void EndThreadProfiling()

GetAllocatedMemoryForGraphicsDriver()

Declaration
public static long GetAllocatedMemoryForGraphicsDriver()
Returns
Type Description
Int64

GetAreaEnabled(ProfilerArea)

Declaration
public static bool GetAreaEnabled(ProfilerArea area)
Parameters
Type Name Description
ProfilerArea area
Returns
Type Description
Boolean
| Improve this Doc View Source

GetMonoHeapSize()

Declaration
[Obsolete("GetMonoHeapSize has been deprecated since it is limited to 4GB. Please use GetMonoHeapSizeLong() instead.")]
public static uint GetMonoHeapSize()
Returns
Type Description
UInt32

GetMonoHeapSizeLong()

Declaration
public static long GetMonoHeapSizeLong()
Returns
Type Description
Int64
| Improve this Doc View Source

GetMonoUsedSize()

Declaration
[Obsolete("GetMonoUsedSize has been deprecated since it is limited to 4GB. Please use GetMonoUsedSizeLong() instead.")]
public static uint GetMonoUsedSize()
Returns
Type Description
UInt32

GetMonoUsedSizeLong()

Declaration
public static long GetMonoUsedSizeLong()
Returns
Type Description
Int64
| Improve this Doc View Source

GetRuntimeMemorySize(Object)

Declaration
[Obsolete("GetRuntimeMemorySize has been deprecated since it is limited to 2GB. Please use GetRuntimeMemorySizeLong() instead.")]
public static int GetRuntimeMemorySize(Object o)
Parameters
Type Name Description
Object o
Returns
Type Description
Int32

GetRuntimeMemorySizeLong(Object)

Declaration
public static long GetRuntimeMemorySizeLong(Object o)
Parameters
Type Name Description
Object o
Returns
Type Description
Int64

GetTempAllocatorSize()

Declaration
public static uint GetTempAllocatorSize()
Returns
Type Description
UInt32
| Improve this Doc View Source

GetTotalAllocatedMemory()

Declaration
[Obsolete("GetTotalAllocatedMemory has been deprecated since it is limited to 4GB. Please use GetTotalAllocatedMemoryLong() instead.")]
public static uint GetTotalAllocatedMemory()
Returns
Type Description
UInt32

GetTotalAllocatedMemoryLong()

Declaration
public static long GetTotalAllocatedMemoryLong()
Returns
Type Description
Int64
| Improve this Doc View Source

GetTotalReservedMemory()

Declaration
[Obsolete("GetTotalReservedMemory has been deprecated since it is limited to 4GB. Please use GetTotalReservedMemoryLong() instead.")]
public static uint GetTotalReservedMemory()
Returns
Type Description
UInt32

GetTotalReservedMemoryLong()

Declaration
public static long GetTotalReservedMemoryLong()
Returns
Type Description
Int64
| Improve this Doc View Source

GetTotalUnusedReservedMemory()

Declaration
[Obsolete("GetTotalUnusedReservedMemory has been deprecated since it is limited to 4GB. Please use GetTotalUnusedReservedMemoryLong() instead.")]
public static uint GetTotalUnusedReservedMemory()
Returns
Type Description
UInt32

GetTotalUnusedReservedMemoryLong()

Declaration
public static long GetTotalUnusedReservedMemoryLong()
Returns
Type Description
Int64

SetAreaEnabled(ProfilerArea, Boolean)

Declaration
[Conditional("ENABLE_PROFILER")]
public static void SetAreaEnabled(ProfilerArea area, bool enabled)
Parameters
Type Name Description
ProfilerArea area
Boolean enabled

SetTempAllocatorRequestedSize(UInt32)

Declaration
public static bool SetTempAllocatorRequestedSize(uint size)
Parameters
Type Name Description
UInt32 size
Returns
Type Description
Boolean

Extension Methods

MustExtensions.MustBeEqual<T>(T, T)
MustExtensions.MustBeEqual<T>(T, T, String)
MustExtensions.MustNotBeEqual<T>(T, T)
MustExtensions.MustNotBeEqual<T>(T, T, String)
MustExtensions.MustBeNull<T>(T)
MustExtensions.MustBeNull<T>(T, String)
MustExtensions.MustNotBeNull<T>(T)
MustExtensions.MustNotBeNull<T>(T, String)
  • Improve this Doc
  • View Source
Back to top Generated by DocFX