FScopedStatsCounter | Unreal Engine 5.2 Documentation

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/ProfilingDebugging > API/Runtime/Core/ProfilingDebugging/FCookStats

References


Module	Core
Header	/Engine/Source/Runtime/Core/Public/ProfilingDebugging/CookStats.h
Include	#include "ProfilingDebugging/CookStats.h"

Syntax

class FScopedStatsCounter

Remarks

Used to accumulate cycles to a CallStats instance. Will also accumulate hit/miss stats in the dtor as well. If AddHit is not called, it will assume a miss. If AddMiss is called, it will convert the call to a miss.

Constructors

	Type	Name	Description
		FScopedStatsCounter ( CallStats& InStats )	Starts the time, tracks the underlying stat it will update.
		FScopedStatsCounter ( FScopedStatsCounter&& InOther )
		FScopedStatsCounter ( const FScopedStatsCounter& )

Destructors

	Type	Name	Description
		~FScopedStatsCounter ()	Stop the timer and flushes the stats to the underlying stats object.

Functions

Type	Name	Description
void	AddHit ( int64 InBytesProcessed )	Call to indicate a Get or Put "cache hit". Exists calls by definition don't have hits or misses.
void	AddHitOrMiss ( CallStats::EHitOrMiss InHitOrMiss, int64 InBytesProcessed )	Call to indicate either a hit or miss. See AddHit and AddMiss.
void	AddMiss ( int64 InBytesProcessed )	Call to indicate a Get or Put "cache miss".
void	Cancel ()	Used to cancel a timing, if we had to start one without knowing in advance if we must record it.
void	TrackCyclesOnly ()	Used to track cycles, but not as a new hit/miss.