UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Stats.h File Reference

Go to the source code of this file.

Macros

#define STAT(x)
 
#define SCOPE_CYCLE_COUNTER(Stat)
 
#define SCOPE_CYCLE_COUNTER_STATID(StatId)
 
#define QUICK_SCOPE_CYCLE_COUNTER(Stat)
 
#define DECLARE_SCOPE_CYCLE_COUNTER(CounterName, StatId, GroupId)
 
#define CONDITIONAL_SCOPE_CYCLE_COUNTER(Stat, bCondition)
 
#define RETURN_QUICK_DECLARE_CYCLE_STAT(StatId, GroupId)   return TStatId();
 
#define GET_STATID(Stat)   (TStatId())
 
#define SCOPE_SECONDS_ACCUMULATOR(Stat)
 
#define SCOPE_MS_ACCUMULATOR(Stat)
 
#define DEFINE_STAT(Stat)
 
#define QUICK_USE_CYCLE_STAT(StatId, GroupId)   TStatId()
 
#define DECLARE_CYCLE_STAT(CounterName, StatId, GroupId)
 
#define DECLARE_CYCLE_STAT_WITH_FLAGS(CounterName, StatId, GroupId, StatFlags)
 
#define DECLARE_FLOAT_COUNTER_STAT(CounterName, StatId, GroupId)
 
#define DECLARE_DWORD_COUNTER_STAT(CounterName, StatId, GroupId)
 
#define DECLARE_FLOAT_ACCUMULATOR_STAT(CounterName, StatId, GroupId)
 
#define DECLARE_DWORD_ACCUMULATOR_STAT(CounterName, StatId, GroupId)
 
#define DECLARE_FNAME_STAT(CounterName, StatId, GroupId, API)
 
#define DECLARE_PTR_STAT(CounterName, StatId, GroupId)
 
#define DECLARE_MEMORY_STAT(CounterName, StatId, GroupId)
 
#define DECLARE_MEMORY_STAT_POOL(CounterName, StatId, GroupId, Pool)
 
#define DECLARE_CYCLE_STAT_EXTERN(CounterName, StatId, GroupId, API)
 
#define DECLARE_CYCLE_STAT_WITH_FLAGS_EXTERN(CounterName, StatId, GroupId, StatFlags, API)
 
#define DECLARE_FLOAT_COUNTER_STAT_EXTERN(CounterName, StatId, GroupId, API)
 
#define DECLARE_DWORD_COUNTER_STAT_EXTERN(CounterName, StatId, GroupId, API)
 
#define DECLARE_FLOAT_ACCUMULATOR_STAT_EXTERN(CounterName, StatId, GroupId, API)
 
#define DECLARE_DWORD_ACCUMULATOR_STAT_EXTERN(CounterName, StatId, GroupId, API)
 
#define DECLARE_FNAME_STAT_EXTERN(CounterName, StatId, GroupId, API)
 
#define DECLARE_PTR_STAT_EXTERN(CounterName, StatId, GroupId, API)
 
#define DECLARE_MEMORY_STAT_EXTERN(CounterName, StatId, GroupId, API)
 
#define DECLARE_MEMORY_STAT_POOL_EXTERN(CounterName, StatId, GroupId, Pool, API)
 
#define DECLARE_STATS_GROUP(GroupDesc, GroupId, GroupCat)
 
#define DECLARE_STATS_GROUP_VERBOSE(GroupDesc, GroupId, GroupCat)
 
#define DECLARE_STATS_GROUP_SORTBYNAME(GroupDesc, GroupId, GroupCat)
 
#define DECLARE_STATS_GROUP_MAYBE_COMPILED_OUT(GroupDesc, GroupId, GroupCat, CompileIn)
 
#define SET_CYCLE_COUNTER(Stat, Cycles)
 
#define INC_DWORD_STAT(StatId)
 
#define INC_FLOAT_STAT_BY(StatId, Amount)
 
#define INC_DWORD_STAT_BY(StatId, Amount)
 
#define INC_DWORD_STAT_FNAME_BY(StatId, Amount)
 
#define INC_MEMORY_STAT_BY(StatId, Amount)
 
#define DEC_DWORD_STAT(StatId)
 
#define DEC_FLOAT_STAT_BY(StatId, Amount)
 
#define DEC_DWORD_STAT_BY(StatId, Amount)
 
#define DEC_DWORD_STAT_FNAME_BY(StatId, Amount)
 
#define DEC_MEMORY_STAT_BY(StatId, Amount)
 
#define SET_MEMORY_STAT(StatId, Value)
 
#define SET_DWORD_STAT(StatId, Value)
 
#define SET_FLOAT_STAT(StatId, Value)
 
#define STAT_ADD_CUSTOMMESSAGE_NAME(StatId, Value)
 
#define STAT_ADD_CUSTOMMESSAGE_PTR(StatId, Value)
 
#define SET_CYCLE_COUNTER_FName(Stat, Cycles)
 
#define INC_DWORD_STAT_FName(Stat)
 
#define INC_FLOAT_STAT_BY_FName(Stat, Amount)
 
#define INC_DWORD_STAT_BY_FName(Stat, Amount)
 
#define INC_MEMORY_STAT_BY_FName(Stat, Amount)
 
#define DEC_DWORD_STAT_FName(Stat)
 
#define DEC_FLOAT_STAT_BY_FName(Stat, Amount)
 
#define DEC_DWORD_STAT_BY_FName(Stat, Amount)
 
#define DEC_MEMORY_STAT_BY_FName(Stat, Amount)
 
#define SET_MEMORY_STAT_FName(Stat, Value)
 
#define SET_DWORD_STAT_FName(Stat, Value)
 
#define SET_FLOAT_STAT_FName(Stat, Value)
 
#define GET_STATFNAME(Stat)   (FName())
 
#define GET_STATDESCRIPTION(Stat)   (nullptr)
 

Enumerations

enum  EStatType {
  STATTYPE_CycleCounter , STATTYPE_AccumulatorFLOAT , STATTYPE_AccumulatorDWORD , STATTYPE_CounterFLOAT ,
  STATTYPE_CounterDWORD , STATTYPE_MemoryCounter , STATTYPE_Error
}
 

Macro Definition Documentation

◆ CONDITIONAL_SCOPE_CYCLE_COUNTER

#define CONDITIONAL_SCOPE_CYCLE_COUNTER (   Stat,
  bCondition 
)

◆ DEC_DWORD_STAT

#define DEC_DWORD_STAT (   StatId)

◆ DEC_DWORD_STAT_BY

#define DEC_DWORD_STAT_BY (   StatId,
  Amount 
)

◆ DEC_DWORD_STAT_BY_FName

#define DEC_DWORD_STAT_BY_FName (   Stat,
  Amount 
)

◆ DEC_DWORD_STAT_FName

#define DEC_DWORD_STAT_FName (   Stat)

◆ DEC_DWORD_STAT_FNAME_BY

#define DEC_DWORD_STAT_FNAME_BY (   StatId,
  Amount 
)

◆ DEC_FLOAT_STAT_BY

#define DEC_FLOAT_STAT_BY (   StatId,
  Amount 
)

◆ DEC_FLOAT_STAT_BY_FName

#define DEC_FLOAT_STAT_BY_FName (   Stat,
  Amount 
)

◆ DEC_MEMORY_STAT_BY

#define DEC_MEMORY_STAT_BY (   StatId,
  Amount 
)

◆ DEC_MEMORY_STAT_BY_FName

#define DEC_MEMORY_STAT_BY_FName (   Stat,
  Amount 
)

◆ DECLARE_CYCLE_STAT

#define DECLARE_CYCLE_STAT (   CounterName,
  StatId,
  GroupId 
)

◆ DECLARE_CYCLE_STAT_EXTERN

#define DECLARE_CYCLE_STAT_EXTERN (   CounterName,
  StatId,
  GroupId,
  API 
)

◆ DECLARE_CYCLE_STAT_WITH_FLAGS

#define DECLARE_CYCLE_STAT_WITH_FLAGS (   CounterName,
  StatId,
  GroupId,
  StatFlags 
)

◆ DECLARE_CYCLE_STAT_WITH_FLAGS_EXTERN

#define DECLARE_CYCLE_STAT_WITH_FLAGS_EXTERN (   CounterName,
  StatId,
  GroupId,
  StatFlags,
  API 
)

◆ DECLARE_DWORD_ACCUMULATOR_STAT

#define DECLARE_DWORD_ACCUMULATOR_STAT (   CounterName,
  StatId,
  GroupId 
)

◆ DECLARE_DWORD_ACCUMULATOR_STAT_EXTERN

#define DECLARE_DWORD_ACCUMULATOR_STAT_EXTERN (   CounterName,
  StatId,
  GroupId,
  API 
)

◆ DECLARE_DWORD_COUNTER_STAT

#define DECLARE_DWORD_COUNTER_STAT (   CounterName,
  StatId,
  GroupId 
)

◆ DECLARE_DWORD_COUNTER_STAT_EXTERN

#define DECLARE_DWORD_COUNTER_STAT_EXTERN (   CounterName,
  StatId,
  GroupId,
  API 
)

◆ DECLARE_FLOAT_ACCUMULATOR_STAT

#define DECLARE_FLOAT_ACCUMULATOR_STAT (   CounterName,
  StatId,
  GroupId 
)

◆ DECLARE_FLOAT_ACCUMULATOR_STAT_EXTERN

#define DECLARE_FLOAT_ACCUMULATOR_STAT_EXTERN (   CounterName,
  StatId,
  GroupId,
  API 
)

◆ DECLARE_FLOAT_COUNTER_STAT

#define DECLARE_FLOAT_COUNTER_STAT (   CounterName,
  StatId,
  GroupId 
)

◆ DECLARE_FLOAT_COUNTER_STAT_EXTERN

#define DECLARE_FLOAT_COUNTER_STAT_EXTERN (   CounterName,
  StatId,
  GroupId,
  API 
)

◆ DECLARE_FNAME_STAT

#define DECLARE_FNAME_STAT (   CounterName,
  StatId,
  GroupId,
  API 
)

◆ DECLARE_FNAME_STAT_EXTERN

#define DECLARE_FNAME_STAT_EXTERN (   CounterName,
  StatId,
  GroupId,
  API 
)

◆ DECLARE_MEMORY_STAT

#define DECLARE_MEMORY_STAT (   CounterName,
  StatId,
  GroupId 
)

◆ DECLARE_MEMORY_STAT_EXTERN

#define DECLARE_MEMORY_STAT_EXTERN (   CounterName,
  StatId,
  GroupId,
  API 
)

◆ DECLARE_MEMORY_STAT_POOL

#define DECLARE_MEMORY_STAT_POOL (   CounterName,
  StatId,
  GroupId,
  Pool 
)

◆ DECLARE_MEMORY_STAT_POOL_EXTERN

#define DECLARE_MEMORY_STAT_POOL_EXTERN (   CounterName,
  StatId,
  GroupId,
  Pool,
  API 
)

◆ DECLARE_PTR_STAT

#define DECLARE_PTR_STAT (   CounterName,
  StatId,
  GroupId 
)

◆ DECLARE_PTR_STAT_EXTERN

#define DECLARE_PTR_STAT_EXTERN (   CounterName,
  StatId,
  GroupId,
  API 
)

◆ DECLARE_SCOPE_CYCLE_COUNTER

#define DECLARE_SCOPE_CYCLE_COUNTER (   CounterName,
  StatId,
  GroupId 
)

◆ DECLARE_STATS_GROUP

#define DECLARE_STATS_GROUP (   GroupDesc,
  GroupId,
  GroupCat 
)

◆ DECLARE_STATS_GROUP_MAYBE_COMPILED_OUT

#define DECLARE_STATS_GROUP_MAYBE_COMPILED_OUT (   GroupDesc,
  GroupId,
  GroupCat,
  CompileIn 
)

◆ DECLARE_STATS_GROUP_SORTBYNAME

#define DECLARE_STATS_GROUP_SORTBYNAME (   GroupDesc,
  GroupId,
  GroupCat 
)

◆ DECLARE_STATS_GROUP_VERBOSE

#define DECLARE_STATS_GROUP_VERBOSE (   GroupDesc,
  GroupId,
  GroupCat 
)

◆ DEFINE_STAT

#define DEFINE_STAT (   Stat)

◆ GET_STATDESCRIPTION

#define GET_STATDESCRIPTION (   Stat)    (nullptr)

◆ GET_STATFNAME

#define GET_STATFNAME (   Stat)    (FName())

◆ GET_STATID

#define GET_STATID (   Stat)    (TStatId())

◆ INC_DWORD_STAT

#define INC_DWORD_STAT (   StatId)

◆ INC_DWORD_STAT_BY

#define INC_DWORD_STAT_BY (   StatId,
  Amount 
)

◆ INC_DWORD_STAT_BY_FName

#define INC_DWORD_STAT_BY_FName (   Stat,
  Amount 
)

◆ INC_DWORD_STAT_FName

#define INC_DWORD_STAT_FName (   Stat)

◆ INC_DWORD_STAT_FNAME_BY

#define INC_DWORD_STAT_FNAME_BY (   StatId,
  Amount 
)

◆ INC_FLOAT_STAT_BY

#define INC_FLOAT_STAT_BY (   StatId,
  Amount 
)

◆ INC_FLOAT_STAT_BY_FName

#define INC_FLOAT_STAT_BY_FName (   Stat,
  Amount 
)

◆ INC_MEMORY_STAT_BY

#define INC_MEMORY_STAT_BY (   StatId,
  Amount 
)

◆ INC_MEMORY_STAT_BY_FName

#define INC_MEMORY_STAT_BY_FName (   Stat,
  Amount 
)

◆ QUICK_SCOPE_CYCLE_COUNTER

#define QUICK_SCOPE_CYCLE_COUNTER (   Stat)

◆ QUICK_USE_CYCLE_STAT

#define QUICK_USE_CYCLE_STAT (   StatId,
  GroupId 
)    TStatId()

◆ RETURN_QUICK_DECLARE_CYCLE_STAT

#define RETURN_QUICK_DECLARE_CYCLE_STAT (   StatId,
  GroupId 
)    return TStatId();

◆ SCOPE_CYCLE_COUNTER

#define SCOPE_CYCLE_COUNTER (   Stat)

◆ SCOPE_CYCLE_COUNTER_STATID

#define SCOPE_CYCLE_COUNTER_STATID (   StatId)

◆ SCOPE_MS_ACCUMULATOR

#define SCOPE_MS_ACCUMULATOR (   Stat)

◆ SCOPE_SECONDS_ACCUMULATOR

#define SCOPE_SECONDS_ACCUMULATOR (   Stat)

◆ SET_CYCLE_COUNTER

#define SET_CYCLE_COUNTER (   Stat,
  Cycles 
)

◆ SET_CYCLE_COUNTER_FName

#define SET_CYCLE_COUNTER_FName (   Stat,
  Cycles 
)

◆ SET_DWORD_STAT

#define SET_DWORD_STAT (   StatId,
  Value 
)

◆ SET_DWORD_STAT_FName

#define SET_DWORD_STAT_FName (   Stat,
  Value 
)

◆ SET_FLOAT_STAT

#define SET_FLOAT_STAT (   StatId,
  Value 
)

◆ SET_FLOAT_STAT_FName

#define SET_FLOAT_STAT_FName (   Stat,
  Value 
)

◆ SET_MEMORY_STAT

#define SET_MEMORY_STAT (   StatId,
  Value 
)

◆ SET_MEMORY_STAT_FName

#define SET_MEMORY_STAT_FName (   Stat,
  Value 
)

◆ STAT

#define STAT (   x)

◆ STAT_ADD_CUSTOMMESSAGE_NAME

#define STAT_ADD_CUSTOMMESSAGE_NAME (   StatId,
  Value 
)

◆ STAT_ADD_CUSTOMMESSAGE_PTR

#define STAT_ADD_CUSTOMMESSAGE_PTR (   StatId,
  Value 
)

Enumeration Type Documentation

◆ EStatType

Enumerator
STATTYPE_CycleCounter 
STATTYPE_AccumulatorFLOAT 
STATTYPE_AccumulatorDWORD 
STATTYPE_CounterFLOAT 
STATTYPE_CounterDWORD 
STATTYPE_MemoryCounter 
STATTYPE_Error