Navigation
API > API/Runtime > API/Runtime/Engine
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.
| Name | FInGamePerformanceTracker |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/InGamePerformanceTracker.h |
| Include Path | #include "InGamePerformanceTracker.h" |
Syntax
class FInGamePerformanceTracker
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| InGamePerformanceTracker.h | |||
FInGamePerformanceTracker
(
uint32 FrameHistorySize |
InGamePerformanceTracker.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| CachedEnabled | int32 | InGamePerformanceTracker.h | |
| Enabled | class IConsoleVariable * | InGamePerformanceTracker.h | |
| HistorySize | class IConsoleVariable * | InGamePerformanceTracker.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DirectSectionTime_BeginCycles | uint32 | Initial cycle reading when timing a section of code directly. | InGamePerformanceTracker.h | |
| DirectSectionTime_EntryCount | uint32 | How many times we've entered a directly tracked section of code. | InGamePerformanceTracker.h | |
| History | FInGameCycleHistory | An N frame history of cycle counts. | InGamePerformanceTracker.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddCycles
(
uint32 Cycles |
Adds cycles collected from an external helper object. | InGamePerformanceTracker.h | |
void EnterTimedSection () |
Enters a timed section of code. | InGamePerformanceTracker.h | |
void ExitTimedSection () |
Enters a timed section of code. | InGamePerformanceTracker.h | |
double GetAverageTimeSeconds() |
InGamePerformanceTracker.h | ||
void Tick() |
InGamePerformanceTracker.h |