1. Epic GamesDeveloper
  3. FSceneViewFamily

FSceneViewFamily

A set of views into a scene which only have different view transforms and owner actors.

API > API/Runtime > API/Runtime/Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/SceneView.h
Include #include "SceneView.h"

Syntax

class FSceneViewFamily

Remarks

A set of views into a scene which only have different view transforms and owner actors.

Variables

  Type Name Description
Public variable TArray< const FSceneView * > AllViews All views include main camera views and scene capture views.
Public variable bool bAdditionalViewFamily Indicates this view family is an additional one.
Public variable bool bCurrentlyBeingEdited Whether the scene is currently being edited, which can be used to speed up lighting propagation.
Public variable bool bDeferClear Used to defer the back buffer clearing to just before the back buffer is drawn to
Public variable bool bDrawBaseInfo Indicates whether, or not, the base attachment volume should be drawn.
Public variable bool bIsFirstViewInMultipleViewFamily Whether this view is the first of multiple view families rendered in a single frame.
Public variable bool bIsHDR When enabled, the post processing will output in HDR space
Public variable bool bIsMainViewFamily Whether this is the "main" view family.
Public variable bool bIsMultipleViewFamily Whether this view is one of multiple view families rendered in a single frame.
Public variable bool bIsViewFamilyInfo  
Public variable bool bMultiGPUForkAndJoin If true then each view is not rendered using the same GPUMask.
Public variable bool bNullifyWorldSpacePosition Indicates whether the shader world space position should be forced to 0.
Public variable bool bOverrideVirtualTextureThrottle Whether to disable virtual texture update throttling.
Public variable bool bRealtimeUpdate Indicates whether the view family is updated in realtime.
Public variable bool bRequireMultiView True if scenecolor and depth should be multiview-allocated
Public variable bool bResolveScene If true then results of scene rendering are copied/resolved to the RenderTarget.
Public variable bool bSplitScreenDebugAllowed Whether this view allows split screen debug we only want it for editor and game viewports, not other random scene renders
Public variable bool bThumbnailRendering Whether this view is for thumbnail rendering
Public variable bool bUsedDebugViewVSDSHS  
Public variable bool bWorldIsPaused GetWorld->IsPaused() && !Simulate Simulate is excluded as the camera can move which invalidates motionblur
Public variable float CurrentRealTime  
Public variable float CurrentWorldTime  
Public variable float DebugDPIScale DPI scale to be used for debugging font.
Public variable EDebugViewShaderMode DebugViewShaderMode  
Public variable float DeltaWorldTime  
Public variable FDisplayInternalsData DisplayInternalsData For r.DisplayInternals (allows for easy passing down data from main to render thread)
Public variable FEngineShowFlags EngineShowFlags The new show flags for the views (meant to replace the old system).
Public variable FExposureSettings ExposureSettings Editor setting to allow designers to override the automatic expose.
Public variable uint64 FrameCounter Copy from main thread GFrameCounter to be accessible on render thread side.
Public variable uint32 FrameNumber Copy from main thread GFrameNumber to be accessible on render thread side.
Public variable float GammaCorrection Gamma correction used when rendering this family. Default is 1.0
Public variable int8 LandscapeLODOverride Override the LOD of landscape in this viewport.
Public variable TOptional< uint64 > OverrideFrameCounter When deleted, remove PRAGMA_DISABLE_DEPRECATION_WARNINGS / PRAGMA_ENABLE_DEPRECATION_WARNINGS from ~FSceneViewFamily()
Public variable FString ProfileDescription Optional description of view family for Unreal Insights profiling.
Public variable float * ProfileSceneRenderTime Optional tracking of scene render time in seconds, useful when rendering multiple scenes (such as via UDisplayClusterViewportClient) where the user may want a live breakdown of where render time is going per scene, which the stat system otherwise doesn't provide.
Public variable const FRenderTarget * RenderTarget The render target which the views are being rendered to.
Public variable const FRenderTarget * RenderTargetDepth  
Public variable FSceneInterface * Scene The scene being viewed.
Public variable ESceneCaptureCompositeMode SceneCaptureCompositeMode When enabled, the scene capture will composite into the render target instead of overwriting its contents.
Public variable ESceneCaptureSource SceneCaptureSource Which component of the scene rendering should be output to the final render target.
Public variable ESecondaryScreenPercentageMethod SecondaryScreenPercentageMethod  
Public variable float SecondaryViewFraction Secondary view fraction to support High DPI monitor still with same primary screen percentage range for temporal upscale to test content consistently in editor no mater of the HighDPI scale.
Public variable TArray< FVector, TInlineAllocator< 2 > > StreamingViewOrigins Views' origin of the (optional) streaming views. Used for prefetching rendering data ahead of time.
Public variable FGameTime Time The current time.
Public variable TArray< TSharedRef< class ISceneViewExtension, ESPMode::ThreadSafe > > ViewExtensions Extensions that can modify view parameters on the render thread.
Public variable EViewModeIndex ViewMode View mode of the family.
Public variable int32 ViewModeParam  
Public variable FName ViewModeParamName  
Public variable TArray< const FSceneView * > Views The views which make up the family.
Public variable int32 VirtualTextureFeedbackFactor Size in pixels of a virtual texture feedback tile.

Constructors

  Type Name Description
Public function   Initialization constructor.
Public function  

FSceneViewFamily ( FSceneViewFamily&& InViewFamily
)

 Allow moving view family as long as no screen percentage interface are set.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const bool  
Public function Const bool  
Public function Const EDebugViewShaderMode  
Public function Const EDebugViewShaderMode  
Public function Const const TExtensionData *  
Public function TExtensionData *  
Public function Const ERHIFeatureLevel::Type  
Public function Const bool  
Public function TExtensionData *  
Public function Const const ISpatialUpscaler *  
Public function Const ISceneRenderer *  
Public function Const const ISceneViewFamilyScreenPercentage *  
Public function Const const ISpatialUpscaler *  
Public function Const EShaderPlatform  
Public function Const const UE::Renderer::Private::ITemporalUpscaler *  
Public function Const int32  
Public function Const const FName &  
Public function void

SetIsInFocus ( bool bInIsInFocus
)

  
Public function void

SetPrimarySpatialUpscalerInterface ( ISpatialUpscaler* InSpatialUpscalerInterface
)

  
Public function void

SetSceneRenderer ( ISceneRenderer* NewSceneRenderer
)

  
Public function void Safely sets the view family's screen percentage interface.
Public function void

SetSecondarySpatialUpscalerInterface ( ISpatialUpscaler* InSpatialUpscalerInterface
)

  
Public function void  
Public function Const bool Returns whether the screen percentage show flag is supported or not for this view family.
Public function Const bool  
Public function Const bool  

Operators

  Type Name Description
Public function void View family assignment operator is not allowed because of ScreenPercentageInterface lifetime.

Classes

  Type Name Description
Public struct ConstructionValues Helper struct for creating FSceneViewFamily instances If created with specifying a time it will retrieve them from the world in the given scene.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page