Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/FCookStats
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.
| Name | FScopedStatsCounter |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/ProfilingDebugging/CookStats.h |
| Include Path | #include "ProfilingDebugging/CookStats.h" |
Syntax
class FScopedStatsCounter
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FScopedStatsCounter
(
CallStats& InStats |
Starts the time, tracks the underlying stat it will update. | ProfilingDebugging/CookStats.h | |
FScopedStatsCounter
(
FScopedStatsCounter&& InOther |
ProfilingDebugging/CookStats.h | ||
FScopedStatsCounter
(
const FScopedStatsCounter& |
ProfilingDebugging/CookStats.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FScopedStatsCounter() |
Stop the timer and flushes the stats to the underlying stats object. | ProfilingDebugging/CookStats.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCanceled | bool | ProfilingDebugging/CookStats.h | ||
| bIsInGameThread | bool | ProfilingDebugging/CookStats.h | ||
| bTrackCyclesOnly | bool | ProfilingDebugging/CookStats.h | ||
| BytesProcessed | int64 | ProfilingDebugging/CookStats.h | ||
| HitOrMiss | CallStats::EHitOrMiss | ProfilingDebugging/CookStats.h | ||
| StartTime | uint64 | ProfilingDebugging/CookStats.h | ||
| Stats | CallStats & | ProfilingDebugging/CookStats.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddHit
(
int64 InBytesProcessed |
Call to indicate a Get or Put "cache hit". Exists calls by definition don't have hits or misses. | ProfilingDebugging/CookStats.h | |
void AddHitOrMiss
(
CallStats::EHitOrMiss InHitOrMiss, |
Call to indicate either a hit or miss. See AddHit and AddMiss. | ProfilingDebugging/CookStats.h | |
void AddMiss
(
int64 InBytesProcessed |
Call to indicate a Get or Put "cache miss". | ProfilingDebugging/CookStats.h | |
void Cancel() |
Used to cancel a timing, if we had to start one without knowing in advance if we must record it. | ProfilingDebugging/CookStats.h | |
void TrackCyclesOnly () |
Used to track cycles, but not as a new hit/miss. | ProfilingDebugging/CookStats.h |