Classes
class	SCR_TimeMeasurementHelper_Info

Functions
void	BeginMeasure (string name)
void	EndMeasure (string name)
float	GetMeasure (string name)
void	PrintAllMeasures ()
	Print all measurements to the console, ended or not.
void	Reset ()
	Delete all stored measurements, ended or not.
void	SCR_TimeMeasurementHelper ()

Function Documentation

◆ BeginMeasure()

void BeginMeasure ( string name )

This class can add multiple measurements - useful to measure specific parts of a loop

    SCR_TimeMeasurementHelper benchmark = new SCR_TimeMeasurementHelper();
    Debug.BeginTimeMeasure();
    foreach (SCR_Object obj : m_aObjects)
    {
        benchmark.BeginMeasure("opAandC");
        obj.OperationA();
        benchmark.EndMeasure("opAandC");    // names are case-sensitive
   
        benchmark.BeginMeasure("opB");
        obj.OperationB();
        benchmark.EndMeasure("opB");
   
        benchmark.BeginMeasure("opAandC");
        obj.OperationC();
        benchmark.EndMeasure("opAandC");    // time will be -added- to this measurement
    }
    Debug.EndTimeMeasure("Operation A, B and C total benchmark");
    Print("Operation A && C: " + benchmark.GetMeasure("opAandC") + " ms", LogLevel.NORMAL);
    Print("Operation B only: " + benchmark.GetMeasure("opB") + " ms", LogLevel.NORMAL);
    // or
    benchmark.PrintAllMeasures();
    \code
class SCR_TimeMeasurementHelper */
{
    protected ref map<string, ref SCR_TimeMeasurementHelper_Info> m_mData;
 
---------------------------------------------------------------------------------------------&mdash;

Definition at line 32 of file SCR_TimeMeasurementHelper.c.

◆ EndMeasure()

void EndMeasure ( string name )

End a started measurement If the measurement has not been started, a warning is printed

Parameters

[in] name case-sensitive, must be identical to BeginMeasure's provided name

Definition at line 48 of file SCR_TimeMeasurementHelper.c.

◆ GetMeasure()

float GetMeasure ( string name )

Get a measurement by name If the measurement has never been ended, its value is 0 If the measurement has not been started, a warning is printed and -1 is returned

Parameters

[in] name the case-sensitive measurement name