UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Static Public Member Functions | List of all members
FDynamicStats Struct Reference

#include <DynamicStats.h>

Static Public Member Functions

template<typename TStatGroup >
static TStatId CreateStatId (const FString &StatNameOrDescription)
 
template<typename TStatGroup >
static TStatId CreateStatIdInt64 (const FString &StatNameOrDescription, bool bIsAccumulator=false)
 
template<typename TStatGroup >
static TStatId CreateStatIdDouble (const FString &StatNameOrDescription, bool bIsAccumulator=false)
 
template<typename TStatGroup >
static TStatId CreateStatId (const FName StatNameOrDescription, bool IsTimer=true)
 
template<typename TStatGroup >
static TStatId CreateMemoryStatId (const FString &StatNameOrDescription, FPlatformMemory::EMemoryCounterRegion MemRegion=FPlatformMemory::MCR_Physical)
 
template<typename TStatGroup >
static TStatId CreateMemoryStatId (const FName StatNameOrDescription, FPlatformMemory::EMemoryCounterRegion MemRegion=FPlatformMemory::MCR_Physical)
 

Detailed Description

Helper class used to generate dynamic stat ids.

Member Function Documentation

◆ CreateMemoryStatId() [1/2]

template<typename TStatGroup >
static TStatId FDynamicStats::CreateMemoryStatId ( const FName  StatNameOrDescription,
FPlatformMemory::EMemoryCounterRegion  MemRegion = FPlatformMemory::MCR_Physical 
)
inlinestatic

◆ CreateMemoryStatId() [2/2]

template<typename TStatGroup >
static TStatId FDynamicStats::CreateMemoryStatId ( const FString &  StatNameOrDescription,
FPlatformMemory::EMemoryCounterRegion  MemRegion = FPlatformMemory::MCR_Physical 
)
inlinestatic

◆ CreateStatId() [1/2]

template<typename TStatGroup >
static TStatId FDynamicStats::CreateStatId ( const FName  StatNameOrDescription,
bool  IsTimer = true 
)
inlinestatic

◆ CreateStatId() [2/2]

template<typename TStatGroup >
static TStatId FDynamicStats::CreateStatId ( const FString &  StatNameOrDescription)
inlinestatic

Create a new stat id and registers it with the stats system. This is the only way to create dynamic stat ids at runtime. Can be used only with FScopeCycleCounters.

Store the created stat id. Expensive method, avoid calling that method every frame.

Example: FDynamicStats::CreateStatId<STAT_GROUP_TO_FStatGroup( STATGROUP_UObjects )>( FString::Printf(TEXT("MyDynamicStat_%i"),Index) )

◆ CreateStatIdDouble()

template<typename TStatGroup >
static TStatId FDynamicStats::CreateStatIdDouble ( const FString &  StatNameOrDescription,
bool  bIsAccumulator = false 
)
inlinestatic

◆ CreateStatIdInt64()

template<typename TStatGroup >
static TStatId FDynamicStats::CreateStatIdInt64 ( const FString &  StatNameOrDescription,
bool  bIsAccumulator = false 
)
inlinestatic
The documentation for this struct was generated from the following file: