Navigation
API > API/Runtime > API/Runtime/Core
An element in a profiling / stats tree
The FStatsTreeElement represents a single node in a profiling tree. Each element contains a description including its name, path (invocation path / call-stack) and its duration in system cycles.
| Name | FStatsTreeElement |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Stats/StatsHierarchical.h |
| Include Path | #include "Stats/StatsHierarchical.h" |
Syntax
class FStatsTreeElement
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStatsTreeElement() |
Default constructor. | Stats/StatsHierarchical.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
double AverageSeconds
(
bool bInclusive |
Returns the average number of seconds recorded (total / num) | Stats/StatsHierarchical.h | |
double Contribution
(
bool bAgainstMaximum, |
Returns the contribution between 0.0 and 1.0 within the parent element. | Stats/StatsHierarchical.h | |
const TArray< TSharedPtr< FStatsTreeElement > > & GetChildren() |
Returns all child elements. | Stats/StatsHierarchical.h | |
FName GetFName() |
Returns the name of this element. | Stats/StatsHierarchical.h | |
FString GetName() |
Returns the name of this element as a FString. | Stats/StatsHierarchical.h | |
| Returns the invocation path of this element. | Stats/StatsHierarchical.h | ||
uint32 MaxCycles
(
bool bInclusive |
Returns the number of maximum cycles for this element (and children) | Stats/StatsHierarchical.h | |
uint32 Num
(
bool bInclusive |
Returns the number of invocations collected into this element | Stats/StatsHierarchical.h | |
uint32 TotalCycles
(
bool bInclusive |
Returns the total number of cycles recorded | Stats/StatsHierarchical.h | |
double TotalSeconds
(
bool bInclusive |
Returns the total number of seconds recorded | Stats/StatsHierarchical.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStatsTreeElement * FindChild
(
const FString& InPath |
Returns the child or nullptr based on a given path | Stats/StatsHierarchical.h | |
void UpdatePostMeasurement
(
double InCyclesPerTimerToRemove |
Stats/StatsHierarchical.h |