1. Epic GamesDeveloper
  3. FEngineShowFlags

FEngineShowFlags

ShowFlags are a set of bits (some are fixed in SHIPPING) that are stored in the ViewFamily.

API > API/Runtime > API/Runtime/Engine

ShowFlags are a set of bits (some are fixed in SHIPPING) that are stored in the ViewFamily. They can be used by the artist/designer/developer to debug/profile parts of the rendering. Some ShowFlags are used to customize the rendering e.g. by the SceneCaptureActor, those should not be locked in shipping and not used in inner loops (for performance) They should not be used for scalability (as some might be compiled out for SHIPPING), there we use console variables. ViewModes are on a higher level, they can manipulate show flags before they get used.

   
Name FEngineShowFlags
Type struct
Header File /Engine/Source/Runtime/Engine/Public/ShowFlags.h
Include Path #include "ShowFlags.h"

Syntax

struct FEngineShowFlags

Constructors

Name Remarks Include Path Unreal Specifiers
DO NOT USE. This constructor is for internal usage only for hot-reload purposes. ShowFlags.h  
This constructor defines the default view settings ShowFlags.h  

Enums

Public

Name Remarks
ECustomShowFlag Strong type for custom show flag indices starting from 0 to make interface clearer.
EShowFlag  

Constants

Name Type Remarks Include Path
OnCustomShowFlagRegistered FSimpleMulticastDelegate Delegate fired when a new custom show flag is registered or re-registered so other systems can iterate all show flags and update any related data. ShowFlags.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CustomShowFlags TBitArray NOTE: that the offset of this variable is used mark the end of the variables defined by ShowFlagsValues.inl, no other variables should be added before it. ShowFlags.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DisableAdvancedFeatures()

 For rendering thumbnails, cascade, material editor, static mesh editor keeps bloom as material properties with HDR can be better perceived ShowFlags.h  

void DisableFeaturesForUnlit ( bool bAllowAtmosphere
)

 Features that make sense to disable together for unlit rendering (custom render passes or unlit scene captures) ShowFlags.h  

void EnableAdvancedFeatures()

   ShowFlags.h  

void EngineOverrideCustomShowFlagsFromCVars()

 Supports ShowFlag.* cvars for custom show flags to force custom show flags on/off. ShowFlags.h  

bool GetSingleFlag ( uint32 Index
) const

 O(1) ShowFlags.h  

bool IsVisualizeCalibrationEnabled()

   ShowFlags.h  

void SetActorColoration ( bool bVal
)

      

void SetAllowPrimitiveAlphaHoldout ( bool bVal
)

      

void SetAlphaInvert ( bool bVal
)

      

void SetAmbientCubemap ( bool bVal
)

      

void SetAmbientOcclusion ( bool bVal
)

      

void SetAntiAliasing ( bool bVal
)

      

void SetAtmosphere ( bool bVal
)

      

void SetAudioRadius ( bool bVal
)

      

void SetBillboardSprites ( bool bVal
)

      

void SetBloom ( bool bVal
)

      

void SetBones ( bool bVal
)

      

void SetBounds ( bool bVal
)

      

void SetBrushes ( bool bVal
)

      

void SetBSP ( bool bVal
)

      

void SetBSPSplit ( bool bVal
)

      

void SetBSPTriangles ( bool bVal
)

      

void SetBuilderBrush ( bool bVal
)

      

void SetCameraAspectRatioBars ( bool bVal
)

      

void SetCameraFrustums ( bool bVal
)

      

void SetCameraImperfections ( bool bVal
)

      

void SetCameraInterpolation ( bool bVal
)

      

void SetCameras ( bool bVal
)

      

void SetCameraSafeFrames ( bool bVal
)

      

void SetCapsuleShadows ( bool bVal
)

      

void SetCloud ( bool bVal
)

      

void SetCollision ( bool bVal
)

      

void SetCollisionPawn ( bool bVal
)

      

void SetCollisionVisibility ( bool bVal
)

      

void SetColorGrading ( bool bVal
)

      

void SetCompositeDebugPrimitives ( bool bVal
)

      

void SetCompositeEditorPrimitives ( bool bVal
)

      

void SetConstraints ( bool bVal
)

      

void SetContactShadows ( bool bVal
)

      

void SetCover ( bool bVal
)

      

void SetDebugAI ( bool bVal
)

      

void SetDebugDrawDistantVirtualSMLights ( bool bVal
)

      

void SetDecals ( bool bVal
)

      

void SetDeferredLighting ( bool bVal
)

      

void SetDepthOfField ( bool bVal
)

      

void SetDiffuse ( bool bVal
)

      

void SetDirectionalLights ( bool bVal
)

      

void SetDirectLighting ( bool bVal
)

      

void SetDisableOcclusionQueries ( bool bVal
)

      

void SetDistanceCulledPrimitives ( bool bVal
)

      

void SetDistanceFieldAO ( bool bVal
)

      

void SetDynamicShadows ( bool bVal
)

      

void SetEditingLevelInstance ( bool bVal
)

      

void SetEditor ( bool bVal
)

      

void SetEyeAdaptation ( bool bVal
)

      

void SetFog ( bool bVal
)

      

void SetForceFeedbackRadius ( bool bVal
)

      

bool SetFromString ( const TCHAR* In
)

 More powerful than SetSingleFlag() as it allows to set/clear multiple flags not optimized but doesn't have to be Tolerates whitespace and user error, as user might manipulate the data ShowFlags.h  

void SetGame ( bool bVal
)

      

void SetGameplayDebug ( bool bVal
)

      

void SetGBufferHints ( bool bVal
)

      

void SetGlobalIllumination ( bool bVal
)

      

void SetGrain ( bool bVal
)

      

void SetGrid ( bool bVal
)

      

void SetHair ( bool bVal
)

      

void SetHeterogeneousVolumes ( bool bVal
)

      

void SetHighResScreenshotMask ( bool bVal
)

      

void SetHISMCClusterTree ( bool bVal
)

      

void SetHISMCOcclusionBounds ( bool bVal
)

      

void SetHitProxies ( bool bVal
)

      

void SetHLODColoration ( bool bVal
)

      

void SetHMDDistortion ( bool bVal
)

      

void SetIndirectLightingCache ( bool bVal
)

      

void SetInputDebugVisualizer ( bool bVal
)

      

void SetInstancedFoliage ( bool bVal
)

      

void SetInstancedGrass ( bool bVal
)

      

void SetInstancedStaticMeshes ( bool bVal
)

      

void SetLandscape ( bool bVal
)

      

void SetLargeVertices ( bool bVal
)

      

void SetLensDistortion ( bool bVal
)

      

void SetLensFlares ( bool bVal
)

      

void SetLightComplexity ( bool bVal
)

      

void SetLightFunctions ( bool bVal
)

      

void SetLightInfluences ( bool bVal
)

      

void SetLighting ( bool bVal
)

      

void SetLightingOnlyOverride ( bool bVal
)

      

void SetLightMapDensity ( bool bVal
)

      

void SetLightRadius ( bool bVal
)

      

void SetLightShafts ( bool bVal
)

      

void SetLocalExposure ( bool bVal
)

      

void SetLOD ( bool bVal
)

      

void SetLODColoration ( bool bVal
)

      

void SetLumenDetailTraces ( bool bVal
)

      

void SetLumenFarFieldTraces ( bool bVal
)

      

void SetLumenGlobalIllumination ( bool bVal
)

      

void SetLumenGlobalTraces ( bool bVal
)

      

void SetLumenReflections ( bool bVal
)

      

void SetLumenScreenTraces ( bool bVal
)

      

void SetLumenSecondaryBounces ( bool bVal
)

      

void SetLumenShortRangeAmbientOcclusion ( bool bVal
)

      

void SetMassProperties ( bool bVal
)

      

void SetMaterialAmbientOcclusion ( bool bVal
)

      

void SetMaterialNormal ( bool bVal
)

      

void SetMaterials ( bool bVal
)

      

void SetMaterialTextureScaleAccuracy ( bool bVal
)

      

void SetMediaPlanes ( bool bVal
)

      

void SetMegaLights ( bool bVal
)

      

void SetMeshEdges ( bool bVal
)

      

void SetMeshUVDensityAccuracy ( bool bVal
)

      

void SetModeWidgets ( bool bVal
)

      

void SetMotionBlur ( bool bVal
)

      

void SetNaniteMeshes ( bool bVal
)

      

void SetNaniteStreamingGeometry ( bool bVal
)

      

void SetNavigation ( bool bVal
)

      

void SetNiagara ( bool bVal
)

      

void SetOcclusionMeshes ( bool bVal
)

      

void SetOnScreenDebug ( bool bVal
)

      

void SetOpaqueCompositeEditorPrimitives ( bool bVal
)

      

void SetOutputMaterialTextureScales ( bool bVal
)

      

void SetOverrideDiffuseAndSpecular ( bool bVal
)

      

void SetPaper2DSprites ( bool bVal
)

      

void SetParticles ( bool bVal
)

      

void SetPathTracing ( bool bVal
)

      

void SetPhysicalMaterialMasks ( bool bVal
)

      

void SetPhysicsField ( bool bVal
)

      

void SetPivot ( bool bVal
)

      

void SetPointLights ( bool bVal
)

      

void SetPostProcessing ( bool bVal
)

      

void SetPostProcessMaterial ( bool bVal
)

      

void SetPrecomputedVisibility ( bool bVal
)

      

void SetPrecomputedVisibilityCells ( bool bVal
)

      

void SetPreviewShadowsIndicator ( bool bVal
)

      

void SetPrimitiveDistanceAccuracy ( bool bVal
)

      

void SetQuadOverdraw ( bool bVal
)

      

void SetRayTracedDistanceFieldShadows ( bool bVal
)

      

void SetRayTracingDebug ( bool bVal
)

      

void SetRectLights ( bool bVal
)

      

void SetReflectionEnvironment ( bool bVal
)

      

void SetReflectionOverride ( bool bVal
)

      

void SetRefraction ( bool bVal
)

      

void SetRendering ( bool bVal
)

      

void SetRequiredTextureResolution ( bool bVal
)

      

void SetSceneCaptureCopySceneDepth ( bool bVal
)

      

void SetSceneColorFringe ( bool bVal
)

      

void SetScreenPercentage ( bool bVal
)

      

void SetScreenSpaceAO ( bool bVal
)

      

void SetScreenSpaceReflections ( bool bVal
)

      

void SetSelection ( bool bVal
)

      

void SetSelectionOutline ( bool bVal
)

      

void SetSeparateTranslucency ( bool bVal
)

      

void SetServerDrawDebug ( bool bVal
)

      

void SetShaderComplexity ( bool bVal
)

      

void SetShaderComplexityWithQuadOverdraw ( bool bVal
)

      

void SetShaderPrint ( bool bVal
)

      

void SetShadowFrustums ( bool bVal
)

      

void SetSingleFlag ( uint32 Index,
bool bSet
)

 The following methods are there for serialization, localization and in general to iterate and manipulate flags. ShowFlags.h  

void SetSkeletalMeshes ( bool bVal
)

      

void SetSkyLighting ( bool bVal
)

      

void SetSnap ( bool bVal
)

      

void SetSpecular ( bool bVal
)

      

void SetSplines ( bool bVal
)

      

void SetSpotLights ( bool bVal
)

      

void SetStaticMeshes ( bool bVal
)

      

void SetStationaryLightOverlap ( bool bVal
)

      

void SetStereoRendering ( bool bVal
)

      

void SetStreamingBounds ( bool bVal
)

      

void SetSubsurfaceScattering ( bool bVal
)

      

void SetTemporalAA ( bool bVal
)

      

void SetTestImage ( bool bVal
)

      

void SetTextRender ( bool bVal
)

      

void SetTexturedLightProfiles ( bool bVal
)

      

void SetToneCurve ( bool bVal
)

      

void SetTonemapper ( bool bVal
)

      

void SetTranslucency ( bool bVal
)

      

void SetUnlitRichView ( bool bVal
)

      

void SetUnlitViewmode ( bool bVal
)

      

void SetVectorFields ( bool bVal
)

      

void SetVertexColors ( bool bVal
)

      

void SetVignette ( bool bVal
)

      

void SetVirtualShadowMapPersistentData ( bool bVal
)

      

void SetVirtualTexturePrimitives ( bool bVal
)

      

void SetVirtualTextureResidency ( bool bVal
)

      

void SetVisLog ( bool bVal
)

      

void SetVisualizeBuffer ( bool bVal
)

      

void SetVisualizeCalibrationColor ( bool bVal
)

      

void SetVisualizeCalibrationCustom ( bool bVal
)

      

void SetVisualizeCalibrationGrayscale ( bool bVal
)

      

void SetVisualizeDistanceFieldAO ( bool bVal
)

      

void SetVisualizeDOF ( bool bVal
)

      

void SetVisualizeGlobalDistanceField ( bool bVal
)

      

void SetVisualizeGPUSkinCache ( bool bVal
)

      

void SetVisualizeGroom ( bool bVal
)

      

void SetVisualizeHDR ( bool bVal
)

      

void SetVisualizeInstanceOcclusionQueries ( bool bVal
)

      

void SetVisualizeInstanceUpdates ( bool bVal
)

      

void SetVisualizeLevelInstanceEditing ( bool bVal
)

      

void SetVisualizeLightCulling ( bool bVal
)

      

void SetVisualizeLightFunctionAtlas ( bool bVal
)

      

void SetVisualizeLightingOnProbes ( bool bVal
)

      

void SetVisualizeLocalExposure ( bool bVal
)

      

void SetVisualizeLocalFogVolumes ( bool bVal
)

      

void SetVisualizeLumen ( bool bVal
)

      

void SetVisualizeLWCComplexity ( bool bVal
)

      

void SetVisualizeMeshDistanceFields ( bool bVal
)

      

void SetVisualizeMotionBlur ( bool bVal
)

      

void SetVisualizeMotionVectors ( bool bVal
)

      

void SetVisualizeNanite ( bool bVal
)

      

void SetVisualizeOutOfBoundsPixels ( bool bVal
)

      

void SetVisualizePostProcessStack ( bool bVal
)

      

void SetVisualizeReprojection ( bool bVal
)

      

void SetVisualizeSenses ( bool bVal
)

      

void SetVisualizeShadingModels ( bool bVal
)

      

void SetVisualizeSkyAtmosphere ( bool bVal
)

      

void SetVisualizeSkyLightIlluminance ( bool bVal
)

      

void SetVisualizeSSR ( bool bVal
)

      

void SetVisualizeSSS ( bool bVal
)

      

void SetVisualizeSubstrate ( bool bVal
)

      

void SetVisualizeTemporalUpscaler ( bool bVal
)

      

void SetVisualizeTSR ( bool bVal
)

      

void SetVisualizeVirtualShadowMap ( bool bVal
)

      

void SetVisualizeVirtualTexture ( bool bVal
)

      

void SetVisualizeVolumetricCloudConservativeDensity ( bool bVal
)

      

void SetVisualizeVolumetricCloudEmptySpaceSkipping ( bool bVal
)

      

void SetVisualizeVolumetricLightmap ( bool bVal
)

      

void SetVolumeLightingSamples ( bool bVal
)

      

void SetVolumes ( bool bVal
)

      

void SetVolumetricFog ( bool bVal
)

      

void SetVolumetricLightmap ( bool bVal
)

      

void SetVREditing ( bool bVal
)

      

void SetWidgetComponents ( bool bVal
)

      

void SetWireframe ( bool bVal
)

      

FString ToString()

 Not optimized for speed, good for serialization and debugging ShowFlags.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddNameByIndex ( uint32 InIndex,
FString& Out
)

   ShowFlags.h  

static bool CanBeToggledInEditor ( const TCHAR* Name
)

   ShowFlags.h  

static ECustomShowFlag FindCustomShowFlagByName ( const FString& Name
)

   ShowFlags.h  

static bool FindCustomShowFlagDisplayName ( const FString& InName,
FText& OutText
)

 Lookup functions for custom show flags matching engine ones. ShowFlags.h  

static int32 FindIndexByName ( const TCHAR* Name,
const TCHAR* CommaSeparatedNames
)

   ShowFlags.h  

static FString FindNameByIndex ( uint32 InIndex
)

   ShowFlags.h  

static bool FindShowFlagDisplayName ( const FString& InName,
FText& OutText
)

 Retrieve the localized display name for a named show flag ShowFlags.h  

static EShowFlagGroup FindShowFlagGroup ( const TCHAR* Name
)

 This function defines the grouping in the editor. ShowFlags.h  

static FText GetCustomShowFlagDisplayName ( ECustomShowFlag Index
)

   ShowFlags.h  

static EShowFlagGroup GetCustomShowFlagGroup ( ECustomShowFlag Index
)

   ShowFlags.h  

static FString GetCustomShowFlagName ( ECustomShowFlag Index
)

   ShowFlags.h  

static bool IsForceFlagSet ( uint32 Index
)

 O(1) Check if a CVar is forcing a particular flag on / off ShowFlags.h  

static bool IsNameThere ( const TCHAR* Name,
const TCHAR* CommaSeparatedNames
)

   ShowFlags.h  

static bool IsRegisteredCustomShowFlag ( ECustomShowFlag Index
)

   ShowFlags.h  

static void IterateAllFlags ( T& Sink
)

 Allows to iterate through all flags (if you want to change or read the actual flag settings you need to pass in your own instance of FEngineShowFlags). ShowFlags.h  

static void IterateAllFlags ( T& Sink,
const TCHAR* CommaSeparatedNames
)

 Allows to iterate through all flags (if you want to change or read the actual flag settings you need to pass in your own instance of FEngineShowFlags). ShowFlags.h  

static void IterateCustomFlags ( TFunctionRef< bool(uint32, const FString&)> Functor
)

 Iterate all registered custom show flags. ShowFlags.h  

static ECustomShowFlag RegisterCustomShowFlag ( const TCHAR* Name,
bool DefaultEnabled,
EShowFlagGroup Group,
FText DisplayName
)

 Used by TCustomShowFlag to register a show flag from another module. ShowFlags.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page