1. Epic GamesDeveloper
  3. UEditorPerformanceSettings

UEditorPerformanceSettings

API > API/Editor > API/Editor/UnrealEd

   
Name UEditorPerformanceSettings
Type class
Header File /Engine/Source/Editor/UnrealEd/Classes/Editor/EditorPerformanceSettings.h
Include Path #include "Editor/EditorPerformanceSettings.h"

Syntax

UCLASS (MinimalAPI, Config=EditorSettings,  
       Meta=(DisplayName="Performance", ToolTip="Settings to tweak the performance of the editor"))  
class UEditorPerformanceSettings : public UDeveloperSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UEditorPerformanceSettings ( const FObjectInitializer& ObjectInitializer
)

   Editor/EditorPerformanceSettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDisableRealtimeViewportsInRemoteSessions uint32 Disables realtime viewports by default when connected via a remote session Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformance
  • Meta=(DisplayName="Disable realtime viewports by default in Remote Sessions")
bEnableEditorPeformanceTool bool Whether to enable Editor Perf Tool Completely Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformanceTool
  • Meta=(DisplayName="Enable Tool", ConfigRestartRequired=true)
bEnableExperimentalFeatures bool Whether to enable Editor Perf Tool Experimental Features Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformanceTool
  • Meta=(DisplayName="Experimental Features", ConfigRestartRequired=true, EditCondition="bEnableEditorPeformanceTool")
bEnableNotifications bool Whether to enable Editor Perf Warnings Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformanceTool
  • Meta=(DisplayName="Enable Notifications", ConfigRestartRequired=false, EditCondition="bEnableEditorPeformanceTool")
bEnableScalabilityWarningIndicator uint32 When enabled, a warning will appear in the viewport when your editors scalability settings are non-default and you may be viewing a low quality scene Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformance
  • Meta=(DisplayName="Enable Scalability Warning Indicator")
bEnableSharedDDCPerformanceNotifications uint32 When enabled, Shared Data Cache performance notifications may be displayed when not connected to a shared cache Editor/EditorPerformanceSettings.h  
bEnableSnapshots bool Whether to create Insights Snapshots Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformanceTool
  • Meta=(DisplayName="Enable Snapshots", ConfigRestartRequired=false, EditCondition="bEnableEditorPeformanceTool")
bEnableTelemetry bool Whether to enable Telemetry Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformanceTool
  • Meta=(DisplayName="Enable Telemetry", ConfigRestartRequired=false, EditCondition="bEnableEditorPeformanceTool")
bEnableVSync uint32 Should VSync be enabled in editor? Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformance
  • Meta=(DisplayName="Enable VSync", ConsoleVariable="r.VSyncEditor")
bMonitorEditorPerformance uint32 When turned on, the editor will constantly monitor performance and adjust scalability settings for you when performance drops (disabled in debug) Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformance
bShowFrameRateAndMemory uint32 When enabled, the application frame rate, memory and Unreal object count will be displayed in the main editor UI Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformance
bShowWarningsOnly bool Whether to Show Warnings Only Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformanceTool
  • Meta=(DisplayName="Show Warnings Only", ConfigRestartRequired=false, EditCondition="bEnableEditorPeformanceTool")
bThrottleCPUWhenNotForeground uint32 Lowers CPU usage when the editor is in the background and not the active application Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformance
  • Meta=(DisplayName="Use Less CPU when in Background")
ConsoleVariable     Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=ViewportResolution
  • Meta=(DisplayName="Displays viewports' at high DPI", ConsoleVariable="r.Editor.Viewport.HighDPI")
DisplayName   By default the editor will adjust scene scaling (quality) for high DPI in order to ensure consistent performance with very large render targets. Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=ViewportResolution
  • Meta=(DisplayName="Displays viewports' at high DPI", ConsoleVariable="r.Editor.Viewport.HighDPI")
EditCondition   Editor viewport screen percentage Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=ViewportResolution
  • Meta=(EditCondition="bOverrideManualScreenPercentage", DisplayName="Editor viewport screen percentage.")
NotifyList TArray< FName > Specific measurements to notify Editor/EditorPerformanceSettings.h
  • EditAnywhere
  • Config
  • Category=EditorPerformanceTool
  • Meta=(ConfigRestartRequired=false, EditCondition="bEnableEditorPeformanceTool")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

 UObject interface Editor/EditorPerformanceSettings.h  

Overridden from UDeveloperSettings

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Editor/EditorPerformanceSettings.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
NotificationList_DEPRECATED TArray< FName > Specific measurements to notify Editor/EditorPerformanceSettings.h
  • Config
  • Meta=(DisplayName="Notification List", ConfigRestartRequired=false)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page