1. Epic GamesDeveloper
  3. FHealthSnapshot

FHealthSnapshot

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

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
Public variable double AvgFPS  
Public variable double AvgHitchTime  
Public variable FMemoryStat< float > CPUMemoryMB General "how much memory is used".
Public variable FMmaStat< int > DrawCalls  
Public variable FMmaStat< double > DynamicResolution  
Public variable FMmaStat< double > FrameTime  
Public variable FThreadStat GameThread  
Public variable FThreadStat GPU  
Public variable double HitchesPerMinute  
Public variable float LLMTotalMemoryMB  
Public variable double MeasuredPerfTime Performance data
Public variable double MVP  
Public variable FMmaStat< uint64 > PhysicalMemory  
Public variable FMemoryStat< float > PhysicalMemoryMB System level info.
Public variable TArray< typename FPlatformMemoryStats::FPlatformSpecificStat > PlatformMemoryStats  
Public variable FMmaStat< int > PrimitivesDrawn  
Public variable FThreadStat RenderThread  
Public variable FThreadStat RHIThread  
Public variable FMemoryStat< float > StreamingMemoryMB  
Public variable FString Title Title of the Snapshot
Public variable FMmaStat< uint64 > VirtualMemory  

Constructors

  Type Name Description
Public function  

FHealthSnapshot ( const TCHAR* Title
)

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

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

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Virtual void Snapshots current memory stats
Protected function Virtual void Snapshots performance stats if the given tracking chart is filled with FPS charting data (MeasuredPerfTime > 0)
Public function void Dumps a text blob describing all stats captured by the snapshot to the given output device.
Protected function Virtual 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

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page