UE::Stats::FStats Struct Reference

#include <StatsSystem.h>

Public Member Functions
	DECLARE_DELEGATE_ThreeParams (FOnAdvanceRenderingThreadStats, bool, int64, int32)

Static Public Member Functions
static CORE_API void	Init ()
static CORE_API void	AdvanceFrame (bool bDiscardCallstack, const FOnAdvanceRenderingThreadStats &AdvanceRenderingThreadStatsDelegate=FOnAdvanceRenderingThreadStats())
static CORE_API void	TickCommandletStats ()
static CORE_API bool	EnabledForCommandlet ()
static CORE_API bool	HasLoadTimeStatsForCommandletToken ()
static CORE_API bool	HasLoadTimeFileForCommandletToken ()

Static Public Attributes
static CORE_API TAtomic< int32 >	GameThreadStatsFrame

Detailed Description

Helper struct that contains method available even when the stats are disabled.

Member Function Documentation

AdvanceFrame()

void UE::Stats::FStats::AdvanceFrame ( bool  bDiscardCallstack, const FOnAdvanceRenderingThreadStats &  AdvanceRenderingThreadStatsDelegate = FOnAdvanceRenderingThreadStats()  )

static

Advances stats for the current frame.

DECLARE_DELEGATE_ThreeParams()

UE::Stats::FStats::DECLARE_DELEGATE_ThreeParams	(	FOnAdvanceRenderingThreadStats	,
		bool	,
		int64	,
		int32
	)

Delegate to fire every time we need to advance the stats for the rendering thread.

EnabledForCommandlet()

bool UE::Stats::FStats::EnabledForCommandlet ( )

static

Returns

true, if the command line has the LoadTimeStatsForCommandlet or LoadTimeFileForCommandlet token which enables stats in the commandlets. !!!CAUTION!!! You need to manually advance stats frame in order to maintain the data integrity and not to leak the memory.

HasLoadTimeFileForCommandletToken()

bool UE::Stats::FStats::HasLoadTimeFileForCommandletToken ( )

static

Returns

true, if the command line has the LoadTimeFileForCommandlet token which enables LoadTimeFile equivalent for commandlets.

HasLoadTimeStatsForCommandletToken()

bool UE::Stats::FStats::HasLoadTimeStatsForCommandletToken ( )

static

Returns

true, if the command line has the LoadTimeStatsForCommandlet token which enables LoadTimeStats equivalent for commandlets. All collected stats will be dumped to the log file at the end of running the specified commandlet.

Init()

void UE::Stats::FStats::Init ( )

static

TickCommandletStats()

void UE::Stats::FStats::TickCommandletStats ( )

static

Advances stats for commandlets, only valid if the command line has the proper token.

See also

HasStatsForCommandletsToken

Member Data Documentation

GameThreadStatsFrame

TAtomic< int32 > UE::Stats::FStats::GameThreadStatsFrame

static

Current game thread stats frame.

---

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

• Engine/Source/Runtime/Core/Public/Stats/StatsSystem.h
• Engine/Source/Runtime/Core/Private/Stats/StatsSystem.cpp