Navigation
Unreal Engine C++ API Reference > Runtime > Engine > ProfilingDebugging
References
Module | Engine |
Header | /Engine/Source/Runtime/Engine/Public/ProfilingDebugging/HealthSnapshot.h |
Include | #include "ProfilingDebugging/HealthSnapshot.h" |
Syntax
class FHealthSnapshot
Remarks
Describes a health snapshot about the game at the current time including memory stats. If given a FPerformanceTrackingChart with MeasuredPerfTime > 0, this will also include a basic summary of the active FPS charting session as performance stats. You can create HealthSnapshots simply by creating a new object with the constructor.
See UHealthSnapshotBlueprintLibrary for static helpers that can manage a performance chart if one does not already exist
Snapshots can be dumped to logs or any other FOutputDevice.
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
double | AvgFPS | |
![]() |
double | AvgHitchTime | |
![]() |
FMemoryStat< float > | CPUMemoryMB | General "how much memory is used". |
![]() |
FMmaStat< int > | DrawCalls | |
![]() |
FMmaStat< double > | DynamicResolution | |
![]() |
FMmaStat< double > | FrameTime | |
![]() |
FThreadStat | GameThread | |
![]() |
FThreadStat | GPU | |
![]() |
double | HitchesPerMinute | |
![]() |
float | LLMTotalMemoryMB | |
![]() |
double | MeasuredPerfTime | Performance data |
![]() |
double | MVP | |
![]() |
FMmaStat< uint64 > | PhysicalMemory | |
![]() |
FMemoryStat< float > | PhysicalMemoryMB | System level info. |
![]() |
TArray< typename FPlatformMemoryStats::FPlatformSpecificStat > | PlatformMemoryStats | |
![]() |
FMmaStat< int > | PrimitivesDrawn | |
![]() |
FThreadStat | RenderThread | |
![]() |
FThreadStat | RHIThread | |
![]() |
FMemoryStat< float > | StreamingMemoryMB | |
![]() |
FString | Title | Title of the Snapshot |
![]() |
FMmaStat< uint64 > | VirtualMemory |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
FHealthSnapshot
(
const TCHAR* Title |
Create a snapshot of the current game health. Captures only memory stats. | |
![]() |
FHealthSnapshot
(
const TCHAR* Title, |
Create a snapshot of the current game health. Captures both memory and performance stats. |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | Snapshots current memory stats | |
![]() ![]() |
void | CapturePerformanceStats
(
const FPerformanceTrackingChart* GameplayFPSChart |
Snapshots performance stats if the given tracking chart is filled with FPS charting data (MeasuredPerfTime > 0) |
![]() |
void | Dump
(
FOutputDevice& Ar |
Dumps a text blob describing all stats captured by the snapshot to the given output device. |
![]() ![]() |
void | DumpStats
(
FOutputDevice& Ar, |
Dump a text blob describing all stats captured by the snapshot to the given output device with the given log category. |
Classes
Type | Name | Description | |
---|---|---|---|
![]() |
FMemoryStat | Helper class that can describe memory in a system. Some systems may not provide Used/Peak values. | |
![]() |
FMmaStat | ||
![]() |
FThreadStat |