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 > FPerformanceTrackingChart

Light Theme

Dark Theme

FPerformanceTrackingChart

Chart for a single portion of gameplay (e.g., gameplay or in-game-shop or settings menu open) WARNING: If you add members here, you MUST also update [AccumulateWith()](API\Runtime\Engine\FPerformanceTrackingChart\AccumulateWith) as it accumulates each measure from another chart.

Windows

MacOS

Linux

Inheritance Hierarchy

IPerformanceDataConsumer

FPerformanceTrackingChart

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/ChartCreation.h
Include	#include "ChartCreation.h"

Syntax

class FPerformanceTrackingChart : public IPerformanceDataConsumer

Remarks

Chart for a single portion of gameplay (e.g., gameplay or in-game-shop or settings menu open) WARNING: If you add members here, you MUST also update AccumulateWith() as it accumulates each measure from another chart.

Variables

	Name	Description
double	AccumulatedChartTime	Total accumulated raw (including idle) time spent with the chart registered
bool	bIsChartingPaused
FDateTime	CaptureStartTime	Start time of the capture
FString	ChartLabel	The mode being tracked by this chart.
FString	DeviceProfileName	WARNING: This value could technically change while data collection is ongoing.
FHistogram	DynamicResHistogram	Hitch time histogram (in seconds)
int	FramesDisregarded	Number of frames that were disregarded because the frame was too long.
FHistogram	FrametimeHistogram	Frame time histogram (in seconds)
FHistogram	HitchTimeHistogram	Hitch time histogram (in seconds)
int32	MaxDrawCalls	Total number of draw calls made
int32	MaxDrawnPrimitives	Total number of primitives drawn
double	MaxFlushAsyncLoadingTime
uint64	MaxPhysicalMemory	Memory stats
int32	MaxPlayerTicks	Total number of player ticks ( it is up to the game to populate this field) WARNING: Legacy fields.
int32	MaxVehicleTicks	Total number of vehicle ticks ( it is up to the game to populate this field) WARNING: Legacy field.
uint64	MaxVirtualMemory
int32	MinDrawCalls
int32	MinDrawnPrimitives
uint64	MinPhysicalMemory
int32	MinPlayerTicks
uint64	MinVirtualMemory
uint32	NumFramesBound_GameThread	Number of frames for each time of
uint32	NumFramesBound_GPU
uint32	NumFramesBound_RenderThread
uint32	NumFramesBound_RHIThread
int	StartBatteryLevel
float	StartTemperatureLevel
int	StopBatteryLevel
float	StopTemperatureLevel
double	TimeDisregarded	Total time (sec) that were disregarded because the frame was too long.
int32	TotalDrawCalls
int64	TotalDrawnPrimitives
int32	TotalFlushAsyncLoadingCalls
double	TotalFlushAsyncLoadingTime	Total time spent flushing async loading (in seconds), and call count
double	TotalFramesBoundTime_GameThread	Time spent bound on each kind of thing (in seconds)
double	TotalFramesBoundTime_GPU
double	TotalFramesBoundTime_RenderThread
double	TotalFramesBoundTime_RHIThread
double	TotalFrameTime_GameThread	Total time spent on each thread (in seconds)
double	TotalFrameTime_GPU
double	TotalFrameTime_RenderThread
double	TotalFrameTime_RHIThread
int32	TotalGameThreadBoundHitchCount	Total number of hitches bound by each kind of thing
int32	TotalGPUBoundHitchCount
uint64	TotalPhysicalMemoryUsed
int32	TotalPlayerTicks
int32	TotalRenderThreadBoundHitchCount
int32	TotalRHIThreadBoundHitchCount
uint32	TotalSyncLoadCount	Total number of sync loads
int32	TotalVehicleTicks
uint64	TotalVirtualMemoryUsed

Constructors

	Name	Description
	FPerformanceTrackingChart()
	FPerformanceTrackingChart ( const FDateTime& InStartTime, const FString& InChartLabel )

Destructors

	Name	Description
	~FPerformanceTrackingChart()

Functions

	Name	Description
void	AccumulateWith ( const FPerformanceTrackingChart& C... )
void	ChangeLabel ( const FString& NewLabel )
void	DumpChartsToOutputLog ( double WallClockElapsed, const TArray< const FPerformanceTra..., const FString& InMapName )	Dumps the FPS chart information to the log.
void	DumpChartToAnalyticsParams ( const FString& InMapName, TArray< struct FAnalyticsEventAttri..., bool bIncludeClientHWInfo, bool bIncludeHistograms )	Dumps the FPS chart information to an analytic event param array.
void	DumpFPSChart ( const FString& InMapName )
double	GetAverageFramerate()
double	GetAvgHitchesPerMinute()
double	GetAvgHitchFrameLength()
int64	GetNumFrames()
int64	GetNumHitches()
double	GetPercentMissedVSync ( int32 TargetFPS )
int64	GetTotalHitchFrameTime()
double	GetTotalTime()
void	PauseCharting()
void	Reset ( const FDateTime& InStartTime )	Discard all accumulated data.
void	ResumeCharting()

Overridden from IPerformanceDataConsumer

		Name	Description
	void	ProcessFrame ( const FFrameData& FrameData )
	void	StartCharting()
	void	StopCharting()

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

Take our survey

Dismiss