UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FInGameCycleHistory Struct Reference

#include <InGamePerformanceTracker.h>

Public Member Functions

 FInGameCycleHistory ()
 
 FInGameCycleHistory (int32 InNumSamples)
 
void Reset ()
 
void AddCycles (uint64 NewCycles)
 
uint64 GetAverageCycles () const
 
ENGINE_API void NextFrame ()
 

Public Attributes

TAtomic< uint64CurrFrameCycles
 
TArray< uint64FrameCycles
 
uint64 TotalCycles = 0
 
TAtomic< uint64CachedAverageCycles
 
int32 FrameIdx = 0
 

Constructor & Destructor Documentation

◆ FInGameCycleHistory() [1/2]

FInGameCycleHistory::FInGameCycleHistory ( )
inline

◆ FInGameCycleHistory() [2/2]

FInGameCycleHistory::FInGameCycleHistory ( int32  InNumSamples)
inline

Member Function Documentation

◆ AddCycles()

void FInGameCycleHistory::AddCycles ( uint64  NewCycles)
inline

Adds a number of cycles for the current frame. Thread safe.

◆ GetAverageCycles()

uint64 FInGameCycleHistory::GetAverageCycles ( ) const
inline

◆ NextFrame()

void FInGameCycleHistory::NextFrame ( )

Places the current data on the history and advances to the next frame index. Not thread safe.

◆ Reset()

void FInGameCycleHistory::Reset ( )
inline

Member Data Documentation

◆ CachedAverageCycles

TAtomic<uint64> FInGameCycleHistory::CachedAverageCycles

Current average cycles for access by others, possibly on other threads.

◆ CurrFrameCycles

TAtomic<uint64> FInGameCycleHistory::CurrFrameCycles

Current number of cycles for this frame.

◆ FrameCycles

TArray<uint64> FInGameCycleHistory::FrameCycles

◆ FrameIdx

int32 FInGameCycleHistory::FrameIdx = 0

◆ TotalCycles

uint64 FInGameCycleHistory::TotalCycles = 0

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