FInGamePerformanceTracker Class Reference

#include <InGamePerformanceTracker.h>

Public Member Functions
ENGINE_API	FInGamePerformanceTracker ()
ENGINE_API	FInGamePerformanceTracker (uint32 FrameHistorySize)
ENGINE_API void	Tick ()
void	AddCycles (uint32 Cycles)
double	GetAverageTimeSeconds () const
ENGINE_API void	EnterTimedSection ()
ENGINE_API void	ExitTimedSection ()

Static Public Attributes
static ENGINE_API class IConsoleVariable *	Enabled = IConsoleManager::Get().RegisterConsoleVariable(TEXT("InGamePerformanceTracking.Enabled"), 0, TEXT("If in-game performance tracking is enabled. Most games will likely not use or need this so it should be left disabled."), ECVF_Default)
static ENGINE_API int32	CachedEnabled
static ENGINE_API class IConsoleVariable *	HistorySize = IConsoleManager::Get().RegisterConsoleVariable(TEXT("InGamePerformanceTracking.HistorySize"), 30, TEXT("How many frames in game performance tracking should store in it's history."), ECVF_Default)

Detailed Description

Helper class to track code timings. Similar to stats but much more minimal as they're intended to be used at InGame. Though it's still not free so use wisely.

Constructor & Destructor Documentation

FInGamePerformanceTracker() [1/2]

FInGamePerformanceTracker::FInGamePerformanceTracker

(

)

FInGamePerformanceTracker() [2/2]

FInGamePerformanceTracker::FInGamePerformanceTracker

(

uint32

FrameHistorySize

)

Member Function Documentation

AddCycles()

void FInGamePerformanceTracker::AddCycles ( uint32  Cycles )

inline

Adds cycles collected from an external helper object.

EnterTimedSection()

void FInGamePerformanceTracker::EnterTimedSection

(

)

Enters a timed section of code. Can be re-entrant and will take the first entry point time. Only callable from game thread.

ExitTimedSection()

void FInGamePerformanceTracker::ExitTimedSection

(

)

Enters a timed section of code. Can be re-entrant and will take the final exit point time. Only callable from game thread.

GetAverageTimeSeconds()

double FInGamePerformanceTracker::GetAverageTimeSeconds ( ) const

inline

Tick()

void FInGamePerformanceTracker::Tick

(

)

Member Data Documentation

CachedEnabled

int32 FInGamePerformanceTracker::CachedEnabled

static

Enabled

IConsoleVariable * FInGamePerformanceTracker::Enabled = IConsoleManager::Get().RegisterConsoleVariable(TEXT("InGamePerformanceTracking.Enabled"), 0, TEXT("If in-game performance tracking is enabled. Most games will likely not use or need this so it should be left disabled."), ECVF_Default)

static

HistorySize

IConsoleVariable * FInGamePerformanceTracker::HistorySize = IConsoleManager::Get().RegisterConsoleVariable(TEXT("InGamePerformanceTracking.HistorySize"), 30, TEXT("How many frames in game performance tracking should store in it's history."), ECVF_Default)

static

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/InGamePerformanceTracker.h
• Engine/Source/Runtime/Engine/Private/InGamePerformanceTracker.cpp