FHealthSnapshot Class Reference

#include <HealthSnapshot.h>

Classes
struct	FMemoryStat
struct	FMmaStat
struct	FThreadStat

Public Member Functions
ENGINE_API	FHealthSnapshot (const TCHAR *Title)
ENGINE_API	FHealthSnapshot (const TCHAR *Title, const FPerformanceTrackingChart *GameplayFPSChart)
virtual	~FHealthSnapshot ()
ENGINE_API void	Dump (FOutputDevice &Ar)

Public Attributes
FMemoryStat< float >	CPUMemoryMB
FMemoryStat< float >	StreamingMemoryMB
FMemoryStat< float >	PhysicalMemoryMB
float	LLMTotalMemoryMB
FMmaStat< uint64 >	PhysicalMemory
FMmaStat< uint64 >	VirtualMemory
TArray< typename FPlatformMemoryStats::FPlatformSpecificStat >	PlatformMemoryStats
double	MeasuredPerfTime
FThreadStat	GameThread
FThreadStat	RenderThread
FThreadStat	RHIThread
FThreadStat	GPU
double	HitchesPerMinute
double	AvgHitchTime
double	MVP
double	AvgFPS
FMmaStat< int >	DrawCalls
FMmaStat< int >	PrimitivesDrawn
FMmaStat< double >	FrameTime
FMmaStat< double >	DynamicResolution
FString	Title

Protected Member Functions
virtual ENGINE_API void	CaptureMemoryStats ()
virtual ENGINE_API void	CapturePerformanceStats (const FPerformanceTrackingChart *GameplayFPSChart)
virtual ENGINE_API void	DumpStats (FOutputDevice &Ar, FName CategoryName)

Detailed Description

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.

Constructor & Destructor Documentation

FHealthSnapshot() [1/2]

FHealthSnapshot::FHealthSnapshot

(

const TCHAR *

Title

)

Create a snapshot of the current game health. Captures only memory stats.

Parameters

Title The name of the new snapshot.

FHealthSnapshot() [2/2]

FHealthSnapshot::FHealthSnapshot	(	const TCHAR *	Title,
		const FPerformanceTrackingChart *	GameplayFPSChart
	)

Create a snapshot of the current game health. Captures both memory and performance stats.

Parameters

	Title The name of the new snapshot.
	GameplayFPSChart The chart which has been updated with performance stats to be included in the snapshot.

~FHealthSnapshot()

virtual FHealthSnapshot::~FHealthSnapshot ( )

inlinevirtual

Member Function Documentation

CaptureMemoryStats()

void FHealthSnapshot::CaptureMemoryStats ( )

protectedvirtual

Snapshots current memory stats

CapturePerformanceStats()

void FHealthSnapshot::CapturePerformanceStats ( const FPerformanceTrackingChart *  GameplayFPSChart )

protectedvirtual

Snapshots performance stats if the given tracking chart is filled with FPS charting data (MeasuredPerfTime > 0)

Dump()

void FHealthSnapshot::Dump

(

FOutputDevice &

Ar

)

Dumps a text blob describing all stats captured by the snapshot to the given output device. Outputs to the LogHealthSnapshot log category.

Parameters

Ar The output device that will print the snapshot text blob. Use *GLog to simply write to the log.

Returns

: void

DumpStats()

void FHealthSnapshot::DumpStats ( FOutputDevice &  Ar, FName  CategoryName  )

protectedvirtual

Member Data Documentation

AvgFPS

double FHealthSnapshot::AvgFPS

AvgHitchTime

double FHealthSnapshot::AvgHitchTime

CPUMemoryMB

FMemoryStat<float> FHealthSnapshot::CPUMemoryMB

Memory data

DrawCalls

FMmaStat<int> FHealthSnapshot::DrawCalls

DynamicResolution

FMmaStat<double> FHealthSnapshot::DynamicResolution

FrameTime

FMmaStat<double> FHealthSnapshot::FrameTime

GameThread

FThreadStat FHealthSnapshot::GameThread

GPU

FThreadStat FHealthSnapshot::GPU

HitchesPerMinute

double FHealthSnapshot::HitchesPerMinute

LLMTotalMemoryMB

float FHealthSnapshot::LLMTotalMemoryMB

MeasuredPerfTime

double FHealthSnapshot::MeasuredPerfTime

Performance data

MVP

double FHealthSnapshot::MVP

PhysicalMemory

FMmaStat<uint64> FHealthSnapshot::PhysicalMemory

PhysicalMemoryMB

FMemoryStat<float> FHealthSnapshot::PhysicalMemoryMB

PlatformMemoryStats

TArray<typename FPlatformMemoryStats::FPlatformSpecificStat> FHealthSnapshot::PlatformMemoryStats

PrimitivesDrawn

FMmaStat<int> FHealthSnapshot::PrimitivesDrawn

RenderThread

FThreadStat FHealthSnapshot::RenderThread

RHIThread

FThreadStat FHealthSnapshot::RHIThread

StreamingMemoryMB

FMemoryStat<float> FHealthSnapshot::StreamingMemoryMB

Title

FString FHealthSnapshot::Title

Title of the Snapshot

VirtualMemory

FMmaStat<uint64> FHealthSnapshot::VirtualMemory

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/ProfilingDebugging/HealthSnapshot.h
• Engine/Source/Runtime/Engine/Private/ProfilingDebugging/HealthSnapshot.cpp