58 lines
1.3 KiB
C
58 lines
1.3 KiB
C
|
// Copyright 2019-current Getnamo. All Rights Reserved
|
||
|
|
|
||
|
|
|
||
|
|
#pragma once
|
||
|
|
#include "CoreMinimal.h"
|
||
|
|
|
||
|
|
//Toggle to enable/disable timing code logs
|
||
|
|
#define ENABLE_CUPRECISE_TIMER 1
|
||
|
|
|
||
|
|
/**
|
||
|
|
* C++ Utility Timer class. Multiple categories can be used simultaneously.
|
||
|
|
*
|
||
|
|
* Usage:
|
||
|
|
* FCUMeasureTimer::Tick(TEXT("MyMeasurementCategory"));
|
||
|
|
* //Your code
|
||
|
|
* FCUMeasureTimer::Tock(TEXT("MyMeasurementCategory")); //This will log the time taken in miliseconds
|
||
|
|
*
|
||
|
|
* optionally get the result and handle logging manually
|
||
|
|
* double Elapsed = FCUMeasureTimer::Tock(TEXT("MyMeasurementCategory", false);
|
||
|
|
*/
|
||
|
|
class COREUTILITY_API FCUMeasureTimer
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
* Start a timer for given category
|
||
|
|
*/
|
||
|
|
static void Tick(const FString& LogMsg = TEXT("TimeTaken"));
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns time taken in milliseconds (to micro precision). This function will also log the time taken
|
||
|
|
*/
|
||
|
|
static double Tock(const FString& LogMsg = TEXT("TimeTaken"), bool bShouldLogResult = true);
|
||
|
|
|
||
|
|
private:
|
||
|
|
double Then;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Wrapper for FCUMeasureTimer calls.
|
||
|
|
*
|
||
|
|
* Usage:
|
||
|
|
* {
|
||
|
|
* //code you do not wish to measure
|
||
|
|
*
|
||
|
|
* FCUScopeTimer Timer(TEXT("My Message"));
|
||
|
|
*
|
||
|
|
* //your code
|
||
|
|
* }
|
||
|
|
* It will log duration when you exit the scope
|
||
|
|
*/
|
||
|
|
class COREUTILITY_API FCUScopeTimer
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
FCUScopeTimer(const FString& InLogMsg);
|
||
|
|
~FCUScopeTimer();
|
||
|
|
private:
|
||
|
|
FString LogMessage;
|
||
|
|
};
|