HostProfiler Class Reference

Provides profiling functionality for the host. It used to measure different parts of the engine compared to Profiler, which in turn is used to measure the performance at finer granularity. More...

Static Public Member Functions
static HostProfilerMarker	CreateMarker (string name)
static void	End ()
	Ends profiling for the current sample. Consider using HostProfilerNamedMarkerScope returned by Start instead of calling this method directly. More...
static void	EndDebug ()
static void	Init (Action< String > start, Action end)
	Initializes the host profiler with the specified start and end actions. More...
static void	Init (IHostProfiler hostProfiler)
	Initializes the host profiler with the specified host profiler. More...
static void	InitThread (Action< string, string > start, Action end)
	Initializes the host profiler with the specified start and end actions for thread profiling. More...
static void	Reset ()
	Resets the host profiler by clearing all the profiling actions. More...
static HostProfilerNamedMarkerScope	Start (String sample)
	Starts profiling for a specific sample. More...
static void	StartDebug (String sample)

Detailed Description

Provides profiling functionality for the host. It used to measure different parts of the engine compared to Profiler, which in turn is used to measure the performance at finer granularity.

Member Function Documentation

Init() [1/2]

static void HostProfiler.Init ( IHostProfiler  hostProfiler )

inlinestatic

Initializes the host profiler with the specified host profiler.

Parameters

hostProfiler

Exceptions

ArgumentNullException

Reset()

static void HostProfiler.Reset ( )

inlinestatic

Resets the host profiler by clearing all the profiling actions.

Start()

static HostProfilerNamedMarkerScope HostProfiler.Start ( String  sample )

inlinestatic

Starts profiling for a specific sample.

Parameters

sample

The name of the sample.

End()

static void HostProfiler.End ( )

inlinestatic

Ends profiling for the current sample. Consider using HostProfilerNamedMarkerScope returned by Start instead of calling this method directly.

CreateMarker()

static HostProfilerMarker HostProfiler.CreateMarker ( string  name )

inlinestatic

Parameters

name

Returns

Init() [2/2]

static void HostProfiler.Init ( Action< String >  start, Action  end  )

inlinestatic

Initializes the host profiler with the specified start and end actions.

Parameters

start	The action to be executed when a profiler section starts.
end	The action to be executed when a profiler section ends.

InitThread()

static void HostProfiler.InitThread ( Action< string, string >  start, Action  end  )

inlinestatic

Initializes the host profiler with the specified start and end actions for thread profiling.

Parameters

start	The action to be executed when a profiler section in a named thread starts.
end	The action to be executed when a profiler section in a named thread ends.