Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Stats > FStatsTreeElement

Light Theme

Dark Theme

FStatsTreeElement

An element in a profiling / stats tree

Windows

MacOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Stats/StatsHierarchical.h
Include	#include "Stats/StatsHierarchical.h"

Syntax

class FStatsTreeElement

Remarks

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.

Variables

	Name	Description
TArray< TShared...	Children	Children of the tree
uint32	Cycles
uint32	CyclesOfChildren	Derived data (computed by UpdatePoseMeasurement)
uint32	Invocations
FName	Name
FString	Path
double	RatioAgainstMaximumExclusive
double	RatioAgainstMaximumInclusive
double	RatioAgainstTotalExclusive
double	RatioAgainstTotalInclusive

Constructors

	Name	Description
	FStatsTreeElement()	Default constructor.

Functions

	Name	Description
double	AverageSeconds ( bool bInclusive )	Returns the average number of seconds recorded (total / num)
double	Contribution ( bool bAgainstMaximum, bool bInclusive )	Returns the contribution between 0.0 and 1.0 within the parent element.
FStatsTreeEl...	FindChild ( const FString& InPath )	Returns the child or nullptr based on a given path
const TArray...	GetChildren()	Returns all child elements.
FName	GetFName()	Returns the name of this element.
FString	GetName()	Returns the name of this element as a FString.
FString	GetPath()	Returns the invocation path of this element.
uint32	MaxCycles ( bool bInclusive )	Returns the number of maximum cycles for this element (and children)
uint32	Num ( bool bInclusive )	Returns the number of invocations collected into this element
uint32	TotalCycles ( bool bInclusive )	Returns the total number of cycles recorded
double	TotalSeconds ( bool bInclusive )	Returns the total number of seconds recorded
void	UpdatePostMeasurement ( double InCyclesPerTimerToRemove )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss