SmashHammer.Profiling.IProfiler Interface Reference

Provides a way to create and destroy profiler metric recorders. More...

Inheritance diagram for SmashHammer.Profiling.IProfiler:

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.

Detailed Description

Provides a way to create and destroy profiler metric recorders.

Member Function Documentation

CreateMetricRecorder()

IProfilerMetricRecorder SmashHammer.Profiling.IProfiler.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.

Implemented in SmashHammer.Profiling.ProfilerAsset.

DestroyMetricRecorder() [1/2]

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

Destroy a previously created profile metric recorder.

Parameters

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

Implemented in SmashHammer.Profiling.ProfilerAsset.

DestroyMetricRecorder() [2/2]

void SmashHammer.Profiling.IProfiler.DestroyMetricRecorder

(

IProfilerMetricRecorder

metricRecorder

)

Destroy a previously created profile metric recorder.

Parameters

metricRecorder

The metric recorder to destroy.

Implemented in SmashHammer.Profiling.ProfilerAsset.