Navigation
Unreal Engine C++ API Reference > Runtime > Core > Stats
References
| Module | Core |
| Header | /Engine/Source/Runtime/Core/Public/Stats/StatsHierarchical.h |
| Include | #include "Stats/StatsHierarchical.h" |
Syntax
class FStatsHierarchical
Remarks
A helper class with static methods to perform hierarchical profiling
The FStatsHierarchical class / namespace can be used to record profiling data in a hierarchical fashion - by nesting scopes in functions that call each other. Profiling entries are recorded per invocation as raw data to ensure minimal impact on the runtime performance - and then can be compacted into a tree at a later time for reporting / display.
Users should refer to the DECLARE_SCOPE_HIERARCHICAL_COUNTER macro instead to place scopes.
Users need to call FStatsHierarchical::BeginMeasurements() and FStatsHierarchical::EndMeasurements() to enable / disable the profiling.
Note: This system is not thread-safe. You want to call it from a single thread only.
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | Enabled measurements / profiling. | |
  |
void | DumpMeasurements
(
FMessageLog& Log, |
Prints the results into a provided log. |
  |
FStatsTreeElement | EndMeasurements
(
FStatsTreeElement MeasurementsToMerge, |
Ends measurements / profiling and returns the compacted profiling tree. |
  |
FStatsTreeElement | Returns the last recorded profiling tree. | |
  |
FName | Returns the name to use for untracked time. | |
  |
bool | IsEnabled () |
Returns true if measurements are enabled. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FScope | Helper class to create a local scope for profiling. |