Navigation
API > API/Plugins > API/Plugins/EditorPerformance
The module holding all of the UI related pieces for EditorPerformance
| Name | FEditorPerformanceModule |
| Type | class |
| Header File | /Engine/Plugins/Experimental/EditorPerformance/Source/EditorPerformance/Public/EditorPerformanceModule.h |
| Include Path | #include "EditorPerformanceModule.h" |
Syntax
class FEditorPerformanceModule : public IModuleInterface
Implements Interfaces
Enums
Public
| Name | Remarks |
|---|---|
| EEditorState |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AssetRegistryScanStartTime | FDateTime | EditorPerformanceModule.h | ||
| AvailableMemoryKPI | FGuid | EditorPerformanceModule.h | ||
| BootToPIETime | float | EditorPerformanceModule.h | ||
| CloudDDCLatencyKPI | FGuid | EditorPerformanceModule.h | ||
| CloudDDCReadSpeedKPI | FGuid | EditorPerformanceModule.h | ||
| CoreCountKPI | FGuid | EditorPerformanceModule.h | ||
| EditorAssetRegistryScanCount | volatile int32 | EditorPerformanceModule.h | ||
| EditorAssetRegistryScanKPI | FGuid | EditorPerformanceModule.h | ||
| EditorAssetRegistryScanTime | float | EditorPerformanceModule.h | ||
| EditorBootKPI | FGuid | EditorPerformanceModule.h | ||
| EditorBootTime | float | EditorPerformanceModule.h | ||
| EditorHitchRateKPI | FGuid | EditorPerformanceModule.h | ||
| EditorInitializeKPI | FGuid | EditorPerformanceModule.h | ||
| EditorLoadMapKPI | FGuid | EditorPerformanceModule.h | ||
| EditorLoadMapTime | float | EditorPerformanceModule.h | ||
| EditorMapName | FString | EditorPerformanceModule.h | ||
| EditorPluginCountKPI | FGuid | EditorPerformanceModule.h | ||
| EditorStallRateKPI | FGuid | EditorPerformanceModule.h | ||
| EditorStartUpTime | float | EditorPerformanceModule.h | ||
| EditorState | EEditorState | EditorPerformanceModule.h | ||
| HeartBeatIntervalSeconds | const float | EditorPerformanceModule.h | ||
| HeartBeatTimerHandle | FTimerHandle | EditorPerformanceModule.h | ||
| HitchRate | float | EditorPerformanceModule.h | ||
| HitchSamplerIntervalSeconds | const float | EditorPerformanceModule.h | ||
| HitchSamplerTimerHandle | FTimerHandle | EditorPerformanceModule.h | ||
| IsFirstTimeToPIE | bool | EditorPerformanceModule.h | ||
| IsLoadingMap | bool | EditorPerformanceModule.h | ||
| KPIProfileName | FString | EditorPerformanceModule.h | ||
| KPIProfiles | TMap< FString, FKPIProfile > | EditorPerformanceModule.h | ||
| KPIRegistry | FKPIRegistry | EditorPerformanceModule.h | ||
| LoadMapStartTime | FDateTime | EditorPerformanceModule.h | ||
| LocalDDCEfficiencyKPI | FGuid | EditorPerformanceModule.h | ||
| MinFPSForHitching | const float | EditorPerformanceModule.h | ||
| MinSamplesForHitching | const uint32 | EditorPerformanceModule.h | ||
| PerformanceReportTab | TWeakPtr< SDockTab > | EditorPerformanceModule.h | ||
| PIEEndTime | FDateTime | EditorPerformanceModule.h | ||
| PIEFirstTransitionKPI | FGuid | EditorPerformanceModule.h | ||
| PIEHitchRateKPI | FGuid | EditorPerformanceModule.h | ||
| PIEShutdownKPI | FGuid | EditorPerformanceModule.h | ||
| PIEStallRateKPI | FGuid | EditorPerformanceModule.h | ||
| PIEStartTime | FDateTime | EditorPerformanceModule.h | ||
| PIETransitionKPI | FGuid | EditorPerformanceModule.h | ||
| StallDetectedCount | volatile int32 | EditorPerformanceModule.h | ||
| StallRate | float | EditorPerformanceModule.h | ||
| TotalDDCEfficiencyKPI | FGuid | EditorPerformanceModule.h | ||
| TotalMemoryKPI | FGuid | EditorPerformanceModule.h | ||
| TotalPluginCount | uint32 | EditorPerformanceModule.h | ||
| TotalTimeToEditorKPI | FGuid | EditorPerformanceModule.h | ||
| TotalTimeToPIEKPI | FGuid | EditorPerformanceModule.h | ||
| VirtualAssetEfficiencyKPI | FGuid | EditorPerformanceModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< SWidget > CreateStatusBarWidget() |
EditorPerformanceModule.h | ||
FEditorPerformanceModule::EEditorState GetEditorState() |
EditorPerformanceModule.h | ||
const FString & GetKPIProfileName() |
EditorPerformanceModule.h | ||
const FKPIRegistry & GetKPIRegistry() |
EditorPerformanceModule.h | ||
bool IsHotLocalCacheCase() |
EditorPerformanceModule.h | ||
bool RecordInsightsSnaphshot
(
const FKPIValue& Value |
EditorPerformanceModule.h | ||
bool RecordTelemetryEvent
(
const FKPIValue& Value |
EditorPerformanceModule.h | ||
void ShowPerformanceReportTab() |
EditorPerformanceModule.h | ||
virtual void ShutdownModule() |
Called before the module is unloaded, right before the module object is destroyed. | EditorPerformanceModule.h | |
virtual void StartupModule() |
Called right after the module DLL has been loaded and the module object has been created | EditorPerformanceModule.h | |
void UpdateKPIs
(
float DeltaTime |
EditorPerformanceModule.h |