FInGameCycleHistory

Windows
MacOS
Linux

Syntax

struct FInGameCycleHistory

Variables

Name Description

Public variable

int32

 

CurrFrameCycles

Current number of cycles for this frame.

Public variable

TArray< uint32 ...

 

FrameCycles

Cycles for each frame in history.

Public variable

int32

 

FrameIdx

Index of next frame in history to replace.

Public variable

uint64

 

TotalCycles

Cached running total for an overall average.

Public variable

int32

 

ValidFrames

Number of current valid frames. A history is only valid when all it's frames are.

Constructors

Name Description

Public function

FInGameCycleHistory

(
    int32 InNumSamples
)

Functions

Name Description

Public function

void

 

AddCycles

(
    int32 NewCycles
)

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

Public function Const

uint32

 

GetAverageCycles()

Public function Const

bool

 

IsValid()

A history only becomes valid when all it's frames are in use.

Public function

void

 

NextFrame()

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

Public function

void

 

Reset()

References

Module

Engine

Header

Runtime/Engine/Public/InGamePerformanceTracker.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback