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

#include <ParticlePerfStats.h>

Public Member Functions

ENGINE_API FParticlePerfStats ()
 
ENGINE_API void Reset (bool bSyncWithRT)
 
ENGINE_API void ResetGT ()
 
ENGINE_API void ResetRT ()
 
ENGINE_API void Tick ()
 
ENGINE_API void TickRT ()
 
FParticlePerfStats_GTGetGameThreadStats ()
 
FParticlePerfStats_RTGetRenderThreadStats ()
 
FParticlePerfStats_GPUGetGPUStats ()
 

Static Public Member Functions

static bool GetCSVStatsEnabled ()
 
static bool GetStatsEnabled ()
 
static bool GetGatherWorldStats ()
 
static bool GetGatherSystemStats ()
 
static bool GetGatherComponentStats ()
 
static bool ShouldGatherStats ()
 
static void SetCSVStatsEnabled (bool bEnabled)
 
static void SetStatsEnabled (bool bEnabled)
 
static void AddWorldStatReader ()
 
static void RemoveWorldStatReader ()
 
static void AddSystemStatReader ()
 
static void RemoveSystemStatReader ()
 
static void AddComponentStatReader ()
 
static void RemoveComponentStatReader ()
 
static FParticlePerfStatsGetStats (const UWorld *World)
 
static FParticlePerfStatsGetStats (const UFXSystemAsset *System)
 
static FParticlePerfStatsGetStats (const UFXSystemComponent *Component)
 

Public Attributes

FParticlePerfStats_GT GameThreadStats
 
FParticlePerfStats_RT RenderThreadStats
 
FParticlePerfStats_GPU GPUStats
 

Static Public Attributes

static ENGINE_API TAtomic< boolbStatsEnabled
 
static ENGINE_API TAtomic< int32WorldStatsReaders
 
static ENGINE_API TAtomic< int32SystemStatsReaders
 
static ENGINE_API TAtomic< int32ComponentStatsReaders
 
static ENGINE_API TAtomic< boolbCSVStatsEnabled
 

Constructor & Destructor Documentation

◆ FParticlePerfStats()

ENGINE_API FParticlePerfStats::FParticlePerfStats ( )

Member Function Documentation

◆ AddComponentStatReader()

static void FParticlePerfStats::AddComponentStatReader ( )
inlinestatic

◆ AddSystemStatReader()

static void FParticlePerfStats::AddSystemStatReader ( )
inlinestatic

◆ AddWorldStatReader()

static void FParticlePerfStats::AddWorldStatReader ( )
inlinestatic

◆ GetCSVStatsEnabled()

static bool FParticlePerfStats::GetCSVStatsEnabled ( )
inlinestatic

◆ GetGameThreadStats()

FParticlePerfStats_GT & FParticlePerfStats::GetGameThreadStats ( )
inline

Returns the current frame Game Thread stats.

◆ GetGatherComponentStats()

static bool FParticlePerfStats::GetGatherComponentStats ( )
inlinestatic

◆ GetGatherSystemStats()

static bool FParticlePerfStats::GetGatherSystemStats ( )
inlinestatic

◆ GetGatherWorldStats()

static bool FParticlePerfStats::GetGatherWorldStats ( )
inlinestatic

◆ GetGPUStats()

FParticlePerfStats_GPU & FParticlePerfStats::GetGPUStats ( )
inline

Returns the current frame GPU stats.

◆ GetRenderThreadStats()

FParticlePerfStats_RT & FParticlePerfStats::GetRenderThreadStats ( )
inline

Returns the current frame Render Thread stats.

◆ GetStats() [1/3]

static FParticlePerfStats * FParticlePerfStats::GetStats ( const UFXSystemAsset System)
inlinestatic

◆ GetStats() [2/3]

static FParticlePerfStats * FParticlePerfStats::GetStats ( const UFXSystemComponent Component)
inlinestatic

◆ GetStats() [3/3]

static FParticlePerfStats * FParticlePerfStats::GetStats ( const UWorld World)
inlinestatic

◆ GetStatsEnabled()

static bool FParticlePerfStats::GetStatsEnabled ( )
inlinestatic

◆ RemoveComponentStatReader()

static void FParticlePerfStats::RemoveComponentStatReader ( )
inlinestatic

◆ RemoveSystemStatReader()

static void FParticlePerfStats::RemoveSystemStatReader ( )
inlinestatic

◆ RemoveWorldStatReader()

static void FParticlePerfStats::RemoveWorldStatReader ( )
inlinestatic

◆ Reset()

ENGINE_API void FParticlePerfStats::Reset ( bool  bSyncWithRT)

◆ ResetGT()

ENGINE_API void FParticlePerfStats::ResetGT ( )

◆ ResetRT()

ENGINE_API void FParticlePerfStats::ResetRT ( )

◆ SetCSVStatsEnabled()

static void FParticlePerfStats::SetCSVStatsEnabled ( bool  bEnabled)
inlinestatic

◆ SetStatsEnabled()

static void FParticlePerfStats::SetStatsEnabled ( bool  bEnabled)
inlinestatic

◆ ShouldGatherStats()

static bool FParticlePerfStats::ShouldGatherStats ( )
inlinestatic

◆ Tick()

ENGINE_API void FParticlePerfStats::Tick ( )

◆ TickRT()

ENGINE_API void FParticlePerfStats::TickRT ( )

Member Data Documentation

◆ bCSVStatsEnabled

ENGINE_API TAtomic<bool> FParticlePerfStats::bCSVStatsEnabled
static

◆ bStatsEnabled

ENGINE_API TAtomic<bool> FParticlePerfStats::bStatsEnabled
static

◆ ComponentStatsReaders

ENGINE_API TAtomic<int32> FParticlePerfStats::ComponentStatsReaders
static

◆ GameThreadStats

FParticlePerfStats_GT FParticlePerfStats::GameThreadStats

Stats on GT and GT spawned concurrent work.

◆ GPUStats

FParticlePerfStats_GPU FParticlePerfStats::GPUStats

Stats from GPU work.

◆ RenderThreadStats

FParticlePerfStats_RT FParticlePerfStats::RenderThreadStats

Stats on RT work.

◆ SystemStatsReaders

ENGINE_API TAtomic<int32> FParticlePerfStats::SystemStatsReaders
static

◆ WorldStatsReaders

ENGINE_API TAtomic<int32> FParticlePerfStats::WorldStatsReaders
static

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