FFramePerformanceProviderMessage

API > API/Plugins > API/Plugins/StageMonitorCommon

Message containing information about frame timings. Sent at regular intervals


Name	FFramePerformanceProviderMessage
Type	struct
Header File	/Engine/Plugins/VirtualProduction/StageMonitoring/Source/StageMonitorCommon/Public/StageMonitorUtils.h
Include Path	#include "StageMonitorUtils.h"

Syntax

USTRUCT ()  
struct FFramePerformanceProviderMessage : public FStageProviderPeriodicMessage

Inheritance Hierarchy

FStageDataBaseMessage → FStageProviderMessage → FStageProviderPeriodicMessage → FFramePerformanceProviderMessage

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FFramePerformanceProviderMessage ()		StageMonitorUtils.h
FFramePerformanceProviderMessage ( EStageMonitorNodeStatus InStatus, float GameThreadTime, float GameThreadWaitTime, float RenderThreadTime, float RenderThreadWaitTime, float GPUTime, float IdleTime, uint64 CPUMem, uint64 GPUMem, int32 InAssetsToCompile )		StageMonitorUtils.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AssetInStatus	FString	Full path name of the asset involved in the status.	StageMonitorUtils.h	VisibleAnywhere Category="Performance"
AverageFPS	float	Average FrameRate read from GAverageFPS	StageMonitorUtils.h	VisibleAnywhere Category="Performance"
CompilationTasksRemaining	int32	Number of asynchronous compilation tasks currently in progress.	StageMonitorUtils.h	VisibleAnywhere Category="Performance"
CPU_MEM	uint64	Current CPU Memory Usage (Physical) in bytes	StageMonitorUtils.h	VisibleAnywhere Category="Performance"
GameThreadMS	float	Current GameThread time read from GGameThreadTime in milliseconds	StageMonitorUtils.h	VisibleAnywhere Category="Performance" Meta=(Unit="ms")
GameThreadWaitMS	float	Current GameThread wait time read from GGameThreadWaitTime in milliseconds	StageMonitorUtils.h	VisibleAnywhere Category="Performance" Meta=(Unit="ms")
GPU_MEM	uint64	Current GPU Memory Usage (Physical) in bytes	StageMonitorUtils.h	VisibleAnywhere Category="Performance"
GPU_MS	float	Current GPU time read from RHIGetGPUFrameCycles() in milliseconds	StageMonitorUtils.h	VisibleAnywhere Category="Performance" Meta=(Unit="ms")
IdleTimeMS	float	Idle time (slept) in milliseconds during last frame	StageMonitorUtils.h	VisibleAnywhere Category="Performance" Meta=(Unit="ms")
RenderThreadMS	float	Current RenderThread time read from GRenderThreadTime in milliseconds	StageMonitorUtils.h	VisibleAnywhere Category="Performance" Meta=(Unit="ms")
RenderThreadWaitMS	float	Current RenderThread wait time read from GRenderThreadWaitTime in milliseconds	StageMonitorUtils.h	VisibleAnywhere Category="Performance" Meta=(Unit="ms")
Status	EStageMonitorNodeStatus	Average FrameRate read from GAverageFPS	StageMonitorUtils.h	VisibleAnywhere Category="Performance"

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Functions

Public