FParticlePerfStatsListener_GatherAll

Base class for listeners that gather stats on all systems in the scene.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Particles/ParticlePerfStatsManager.h

Include

#include "Particles/ParticlePerfStatsManager.h"

Syntax

class FParticlePerfStatsListener_GatherAll : public FParticlePerfStatsListener

Remarks

Base class for listeners that gather stats on all systems in the scene.

Variables

Name Description

Protected variable

TMap< TWeakObje...

 

AccumulatedComponentStats

Protected variable

FCriticalSectio...

 

AccumulatedStatsGuard

Protected variable

TMap< TWeakObje...

 

AccumulatedSystemStats

Protected variable

TMap< TWeakObje...

 

AccumulatedWorldStats

Protected variable

const uint8: 1

 

bGatherComponentStats

Protected variable

const uint8: 1

 

bGatherSystemStats

Protected variable

const uint8: 1

 

bGatherWorldStats

Constructors

Name Description

Public function

FParticlePerfStatsListener_GatherAll

(
    bool bNeedsWorldStats,
    bool bNeedsSystemStats,
    bool bNeedsComponentStats
)

Destructors

Functions

Name Description

Public function

void

 

DumpStatsToDevice

(
    FOutputDevice& Ar
)

Public function

void

 

DumpStatsToFile()

Public function

FAccumulated...

 

GetStats

(
    const UWorld* World
)

Public function

FAccumulated...

 

GetStats

(
    const UFXSystemAsset* System
)

Public function

FAccumulated...

 

GetStats

(
    const UFXSystemComponent* Comp...
)

Protected function

void

 

TickStats_Internal

(
    TMap< TWeakObjectPtr< T >, TUniqueP...,
    TFunc Func
)

Overridden from FParticlePerfStatsListener

Name Description

Public function Virtual

void

 

Begin()

Called when the listener begins receiving data.

Public function Virtual

void

 

End()

Called when the listener stops receiving data.

Public function Virtual Const

bool

 

NeedsComponentStats()

Public function Virtual Const

bool

 

NeedsSystemStats()

Public function Virtual Const

bool

 

NeedsWorldStats()

Public function Virtual

void

 

OnAddComponent

(
    const TWeakObjectPtr< const UFXSyst...
)

Called when a new component is seen for the first time.

Public function Virtual

void

 

OnAddSystem

(
    const TWeakObjectPtr< const UFXSyst...
)

Called when a new system is seen for the first time.

Public function Virtual

void

 

OnAddWorld

(
    const TWeakObjectPtr< const UWorld ...
)

Called when a new world is seen for the first time.

Public function Virtual

void

 

OnRemoveComponent

(
    const TWeakObjectPtr< const UFXSyst...
)

Called when a component has been freed and is no longer tracked by the stats.

Public function Virtual

void

 

OnRemoveSystem

(
    const TWeakObjectPtr< const UFXSyst...
)

Called when a system has been freed and is no longer tracked by the stats.

Public function Virtual

void

 

OnRemoveWorld

(
    const TWeakObjectPtr< const UWorld ...
)

Called when a world has been freed and is no longer tracked by the stats.

Public function Virtual

bool

 

Tick()

Called every frame with the current frame data.

Public function Virtual

void

 

TickRT()

Called every frame from the render thread gather any RT stats.