Navigation
API > API/Runtime > API/Runtime/Engine
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.
| Name | FHealthSnapshot |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/ProfilingDebugging/HealthSnapshot.h |
| Include Path | #include "ProfilingDebugging/HealthSnapshot.h" |
Syntax
class FHealthSnapshot
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FHealthSnapshot
(
const TCHAR* Title |
Create a snapshot of the current game health. Captures only memory stats. | ProfilingDebugging/HealthSnapshot.h | |
FHealthSnapshot
(
const TCHAR* Title, |
Create a snapshot of the current game health. Captures both memory and performance stats. | ProfilingDebugging/HealthSnapshot.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FHealthSnapshot() |
ProfilingDebugging/HealthSnapshot.h |
Structs
| Name | Remarks |
|---|---|
| FMemoryStat | Helper class that can describe memory in a system. Some systems may not provide Used/Peak values. |
| FMmaStat | |
| FThreadStat |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AvgFPS | double | ProfilingDebugging/HealthSnapshot.h | ||
| AvgHitchTime | double | ProfilingDebugging/HealthSnapshot.h | ||
| CPUMemoryMB | FMemoryStat< float > | General "how much memory is used". | ProfilingDebugging/HealthSnapshot.h | |
| DrawCalls | FMmaStat< int > | ProfilingDebugging/HealthSnapshot.h | ||
| DynamicResolution | FMmaStat< double > | ProfilingDebugging/HealthSnapshot.h | ||
| FrameTime | FMmaStat< double > | ProfilingDebugging/HealthSnapshot.h | ||
| GameThread | FThreadStat | ProfilingDebugging/HealthSnapshot.h | ||
| GPU | FThreadStat | ProfilingDebugging/HealthSnapshot.h | ||
| HitchesPerMinute | double | ProfilingDebugging/HealthSnapshot.h | ||
| LLMTotalMemoryMB | float | ProfilingDebugging/HealthSnapshot.h | ||
| MeasuredPerfTime | double | Performance data | ProfilingDebugging/HealthSnapshot.h | |
| MVP | double | ProfilingDebugging/HealthSnapshot.h | ||
| PhysicalMemory | FMmaStat< uint64 > | ProfilingDebugging/HealthSnapshot.h | ||
| PhysicalMemoryMB | FMemoryStat< float > | System level info. | ProfilingDebugging/HealthSnapshot.h | |
| PlatformMemoryStats | TArray< typename FPlatformMemoryStats::FPlatformSpecificStat > | ProfilingDebugging/HealthSnapshot.h | ||
| PrimitivesDrawn | FMmaStat< int > | ProfilingDebugging/HealthSnapshot.h | ||
| RenderThread | FThreadStat | ProfilingDebugging/HealthSnapshot.h | ||
| RHIThread | FThreadStat | ProfilingDebugging/HealthSnapshot.h | ||
| StreamingMemoryMB | FMemoryStat< float > | ProfilingDebugging/HealthSnapshot.h | ||
| Title | FString | Title of the Snapshot | ProfilingDebugging/HealthSnapshot.h | |
| VirtualMemory | FMmaStat< uint64 > | ProfilingDebugging/HealthSnapshot.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Dump
(
FOutputDevice& Ar |
Dumps a text blob describing all stats captured by the snapshot to the given output device. | ProfilingDebugging/HealthSnapshot.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CaptureMemoryStats() |
Snapshots current memory stats | ProfilingDebugging/HealthSnapshot.h | |
virtual void CapturePerformanceStats
(
const FPerformanceTrackingChart* GameplayFPSChart |
Snapshots performance stats if the given tracking chart is filled with FPS charting data (MeasuredPerfTime > 0) | ProfilingDebugging/HealthSnapshot.h | |
virtual 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. | ProfilingDebugging/HealthSnapshot.h |