Quantum.Profiling.Profiler Struct Reference

Represents a profiler that can be used for performance profiling. More...

Classes
struct	ProfilerScope
	Represents a disposable profiler scope that automatically starts and ends a profiling section. More...

Public Member Functions
void	End ()
	Ends the current profiling section. More...
void	Event (string name)
	Records an event with the specified name. Events are used to mark specific points in time and do not have a duration. More...
ProfilerScope	Scope (string name)
	Creates a new profiler scope with the specified name. More...
void	Start (string name)
	Starts a profiling section with the specified name. More...

Properties
bool	IsValid [get]
	Gets a value indicating whether the profiler is valid. If the returned value is false, all profiler calls will be no-ops. More...

Detailed Description

Represents a profiler that can be used for performance profiling.

Member Function Documentation

Event()

void Quantum.Profiling.Profiler.Event ( string  name )

inline

Records an event with the specified name. Events are used to mark specific points in time and do not have a duration.

Parameters

name	The name of the event.

Start()

void Quantum.Profiling.Profiler.Start ( string  name )

inline

Starts a profiling section with the specified name.

Parameters

name	The name of the profiling section.

End()

void Quantum.Profiling.Profiler.End ( )

inline

Ends the current profiling section.

Scope()

ProfilerScope Quantum.Profiling.Profiler.Scope

(

string

name

)

Creates a new profiler scope with the specified name.

Parameters

name	The name of the profiler scope.

Returns

A new instance of the ProfilerScope struct.

Property Documentation

IsValid

bool Quantum.Profiling.Profiler.IsValid

get

Gets a value indicating whether the profiler is valid. If the returned value is false, all profiler calls will be no-ops.