UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
UE::Stats::FThreadIdleStats Class Reference

#include <ThreadIdleStats.h>

+ Inheritance diagram for UE::Stats::FThreadIdleStats:

Classes

struct  FScopeIdle
 
struct  FScopeNonCriticalPath
 

Public Member Functions

bool IsCriticalPath () const
 
void Reset ()
 
- Public Member Functions inherited from FTlsAutoCleanup
virtual ~FTlsAutoCleanup ()
 
CORE_API void Register ()
 

Static Public Member Functions

static void BeginCriticalPath ()
 
static void EndCriticalPath ()
 
- Static Public Member Functions inherited from TThreadSingleton< FThreadIdleStats >
static FORCEINLINE FThreadIdleStats & Get ()
 
static FORCEINLINE FThreadIdleStats & Get (TFunctionRef< FTlsAutoCleanup *()> CreateInstance)
 
static FORCEINLINE FThreadIdleStats * TryGet ()
 
static FORCEINLINE FThreadIdleStats * Inject (FThreadIdleStats *Instance)
 

Public Attributes

uint32 Waits
 
uint32 WaitsCriticalPath
 
int IsCriticalPathCounter
 
bool bInIdleScope
 

Friends

class TThreadSingleton< FThreadIdleStats >
 

Additional Inherited Members

- Protected Member Functions inherited from TThreadSingleton< FThreadIdleStats >
 TThreadSingleton ()
 
virtual ~TThreadSingleton ()
 
- Static Protected Member Functions inherited from TThreadSingleton< FThreadIdleStats >
static FTlsAutoCleanup * CreateInstance ()
 
- Protected Attributes inherited from TThreadSingleton< FThreadIdleStats >
const uint32 ThreadId
 

Detailed Description

This is thread-private information about the thread idle stats, which we always collect, even in final builds

Member Function Documentation

◆ BeginCriticalPath()

static void UE::Stats::FThreadIdleStats::BeginCriticalPath ( )
inlinestatic

◆ EndCriticalPath()

static void UE::Stats::FThreadIdleStats::EndCriticalPath ( )
inlinestatic

◆ IsCriticalPath()

bool UE::Stats::FThreadIdleStats::IsCriticalPath ( ) const
inline

◆ Reset()

void UE::Stats::FThreadIdleStats::Reset ( )
inline

Friends And Related Symbol Documentation

◆ TThreadSingleton< FThreadIdleStats >

friend class TThreadSingleton< FThreadIdleStats >
friend

Member Data Documentation

◆ bInIdleScope

bool UE::Stats::FThreadIdleStats::bInIdleScope

◆ IsCriticalPathCounter

int UE::Stats::FThreadIdleStats::IsCriticalPathCounter

◆ Waits

uint32 UE::Stats::FThreadIdleStats::Waits

Total cycles we waited for sleep or event.

◆ WaitsCriticalPath

uint32 UE::Stats::FThreadIdleStats::WaitsCriticalPath

Total cycles we waited for sleep or event on the critical path.

The documentation for this class was generated from the following file: