1. Epic GamesDeveloper
  3. FPerformanceTrackingChart

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() as it accumulates each measure from another chart.

API > API/Runtime > API/Runtime/Engine

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.

   
Name FPerformanceTrackingChart
Type class
Header File /Engine/Source/Runtime/Engine/Public/ChartCreation.h
Include Path #include "ChartCreation.h"

Syntax

class FPerformanceTrackingChart : public IPerformanceDataConsumer

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers
  ChartCreation.h  

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

   ChartCreation.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FPerformanceTrackingChart()

   ChartCreation.h  

Variables

Public

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AccumulateWith ( const FPerformanceTrackingChart& Chart
)

   ChartCreation.h  

void ChangeLabel ( const FString& NewLabel
)

   ChartCreation.h  

void DumpChartsToOutputLog ( double WallClockElapsed,
const TArray< const FPerformanceTrackingChart* >& Charts,
const FString& InMapName
)

 Dumps the FPS chart information to the log. ChartCreation.h  

void DumpChartToAnalyticsParams ( const FString& InMapName,
TArray< struct FAnalyticsEventAttribute >& InParamArray,
bool bIncludeClientHWInfo,
bool bIncludeHistograms
) const

 Dumps the FPS chart information to an analytic event param array. ChartCreation.h  

void DumpFPSChart ( const FString& InMapName
)

   ChartCreation.h  

double GetAverageFramerate()

   ChartCreation.h  

double GetAvgHitchesPerMinute()

   ChartCreation.h  

double GetAvgHitchFrameLength()

   ChartCreation.h  

int64 GetNumFrames()

   ChartCreation.h  

int64 GetNumHitches()

   ChartCreation.h  

double GetPercentFramesIOBusy ( int32 StartingBin
) const

   ChartCreation.h  

double GetPercentHitchTime ( bool bSubtractHitchThreshold
) const

   ChartCreation.h  

double GetPercentMissedVSync ( int32 TargetFPS
) const

   ChartCreation.h  

double GetTotalHitchFrameTime ( bool bSubtractHitchThreshold
) const

 Sum of all recorded hitch lengths (in seconds) ChartCreation.h  

double GetTotalTime()

   ChartCreation.h  

void PauseCharting()

   ChartCreation.h  

void Reset ( const FDateTime& InStartTime
)

 Discard all accumulated data. ChartCreation.h  

void ResumeCharting()

   ChartCreation.h  

Overridden from IPerformanceDataConsumer

Name Remarks Include Path Unreal Specifiers

virtual void ProcessFrame ( const FFrameData& FrameData
)

   ChartCreation.h  

virtual void StartCharting()

   ChartCreation.h  

virtual void StopCharting()

   ChartCreation.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page