FParticlePerfStatsListener_NiagaraPerformanceReporter

This listener gathers perf stats for all systems and will give less intrusive reports on systems that exceed their baseline cost.

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FParticlePerfStatsListener

FParticlePerfStatsListener_GatherAll

FParticlePerfStatsListener_NiagaraPerformanceReporter

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraPerfBaseline.h

Include

#include "NiagaraPerfBaseline.h"

Syntax

class FParticlePerfStatsListener_NiagaraPerformanceReporter : public FParticlePerfStatsListener_GatherAll

Remarks

This listener gathers perf stats for all systems and will give less intrusive reports on systems that exceed their baseline cost.

Variables

Name Description

Public variable

bool

 

bResultsTrigger

Public variable

uint32

 

CurrentFrameNumber

Public variable

float

 

CurrentWorldTime

We store the current target world time so we can give an indication of the time range for poor tests in the report.

Public variable

int32

 

NumFrames

Public variable

int32

 

NumFramesRT

Public variable

FRenderCommandF...

 

ResultsFence

We use an RT Command Fence to know when the RT data is valid and we can report the current stats to the screen.

Public variable

TMap< TWeakObje...

 

StoredStats

Track the worst recorded stats for each system.

Public variable

FString

 

TestNameString

Public variable

uint32

 

TotalTests

How many test have been done in total so far.

Public variable

TWeakObjectPtr<...

 

World

Constructors

Functions

Overridden from FParticlePerfStatsListener

Name Description

Public function Virtual Const

bool

 

NeedsSystemStats()

Public function Virtual Const

bool

 

NeedsWorldStats()

Public function Virtual

bool

 

Tick()

Called every frame with the current frame data.

Public function Virtual

void

 

TickRT()

Called every frame with the current frame data.

Classes

Name

Description

Public struct

FStatTestInfo

Info on a particular test run.

Public struct

FStoredStatsInfo

Constants

Name

Description

TestDebugMessageID

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss