SmashHammer.Profiling.ProfilerAsset Class Reference

The profiler. More...

Inheritance diagram for SmashHammer.Profiling.ProfilerAsset:

Public Member Functions
IProfilerMetricRecorder	CreateMetricRecorder (string category, string name, int capacity=1)
	Create a profile metric recorder.
void	DestroyMetricRecorder (string category, string name)
	Destroy a previously created profile metric recorder.
void	DestroyMetricRecorder (IProfilerMetricRecorder metricRecorder)
	Destroy a previously created profile metric recorder.
IProfilerMetricRecorder	CreateMetricRecorder (string category, string name, int capacity=1)
	Create a profile metric recorder.
void	DestroyMetricRecorder (string category, string name)
	Destroy a previously created profile metric recorder.
void	DestroyMetricRecorder (IProfilerMetricRecorder metricRecorder)
	Destroy a previously created profile metric recorder.

Detailed Description

The profiler.

Available in Lua via the "Profiler" global, for example:

local recorder = Profiler.CreateMetricRecorder( 'Render', 'Draw Calls Count' )
    Do something with the recorder here.
Profiler.DestroyMetricRecorder( recorder )

Member Function Documentation

CreateMetricRecorder()

IProfilerMetricRecorder SmashHammer.Profiling.ProfilerAsset.CreateMetricRecorder	(	string	category,
		string	name,
		int	capacity = 1
	)

Create a profile metric recorder.

Parameters

category	Profiler category name.
name	Profiler marker or counter name.
capacity	Maximum amount of samples to be collected.

Returns

The created metric recorder.

Implements SmashHammer.Profiling.IProfiler.

DestroyMetricRecorder() [1/2]

void SmashHammer.Profiling.ProfilerAsset.DestroyMetricRecorder	(	string	category,
		string	name
	)

Destroy a previously created profile metric recorder.

Parameters

category	Profiler category name.
name	Profiler marker or counter name.

Implements SmashHammer.Profiling.IProfiler.

DestroyMetricRecorder() [2/2]

void SmashHammer.Profiling.ProfilerAsset.DestroyMetricRecorder

(

IProfilerMetricRecorder

metricRecorder

)

Destroy a previously created profile metric recorder.

Parameters

metricRecorder

The metric recorder to destroy.

Implements SmashHammer.Profiling.IProfiler.