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 > Engine > ProfilingDebugging > FHealthSnapshot

Light Theme

Dark Theme

FHealthSnapshot

Describes a health snapshot about the game at the current time including memory stats.

Windows

MacOS

Linux

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

	Name	Description
double	AvgFPS
double	AvgHitchTime
FMemoryStat< fl...	CPUMemoryMB	General "how much memory is used".
FMmaStat< int >	DrawCalls
FMmaStat< doubl...	DynamicResolution
FMmaStat< doubl...	FrameTime
FThreadStat	GameThread
FThreadStat	GPU
double	HitchesPerMinute
float	LLMTotalMemoryMB
double	MeasuredPerfTime	Performance data
double	MVP
FMmaStat< uint6...	PhysicalMemory
FMemoryStat< fl...	PhysicalMemoryMB	System level info.
TArray< typenam...	PlatformMemoryStats
FMmaStat< int >	PrimitivesDrawn
FThreadStat	RenderThread
FThreadStat	RHIThread
FMemoryStat< fl...	StreamingMemoryMB
FString	Title	Title of the Snapshot
FMmaStat< uint6...	VirtualMemory

Constructors

	Name	Description
	FHealthSnapshot ( const TCHAR* Title )	Create a snapshot of the current game health. Captures only memory stats.
	FHealthSnapshot ( const TCHAR* Title, const FPerformanceTrackingChart... )	Create a snapshot of the current game health. Captures both memory and performance stats.

Destructors

	Name	Description
	~FHealthSnapshot()

Functions

	Name	Description
void	CaptureMemoryStats()	Snapshots current memory stats
void	CapturePerformanceStats ( const FPerformanceTrackingChart... )	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, FName CategoryName )	Dump a text blob describing all stats captured by the snapshot to the given output device with the given log category.

Classes

	Name	Description
	FMemoryStat	Helper class that can describe memory in a system. Some systems may not provide Used/Peak values.
	FMmaStat
	FThreadStat

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

Take our survey

Dismiss