Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > FParticlePerfStatsListener_NiagaraPerformanceReporter

Light Theme

Dark Theme

FParticlePerfStatsListener_NiagaraPerformanceReporter

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

Choose your operating system:

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
bool	bResultsTrigger
uint32	CurrentFrameNumber
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.
int32	NumFrames
int32	NumFramesRT
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.
TMap< TWeakObje...	StoredStats	Track the worst recorded stats for each system.
FString	TestNameString
uint32	TotalTests	How many test have been done in total so far.
TWeakObjectPtr<...	World

Constructors

	Name	Description
	FParticlePerfStatsListener_NiagaraPerformanceReporter ( UWorld* InWorld )

Functions

Overridden from FParticlePerfStatsListener

	Name	Description
bool	NeedsSystemStats()
bool	NeedsWorldStats()
bool	Tick()	Called every frame with the current frame data.
void	TickRT()	Called every frame from the render thread gather any RT stats.

Classes

	Name	Description
	FStatTestInfo	Info on a particular test run.
	FStoredStatsInfo

Constants

Name	Description
TestDebugMessageID