FSceneViewFamily

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSceneViewFamily

FSceneViewFamilyContext

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

	Name	Description
bool	bAdditionalViewFamily	Indicates this view family is an additional one.
bool	bDeferClear	Used to defer the back buffer clearing to just before the back buffer is drawn to
bool	bDrawBaseInfo	Indicates whether, or not, the base attachment volume should be drawn.
bool	bIsHDR	When enabled, the post processing will output in HDR space
bool	bIsRenderedImmediatelyAfterAnotherViewFamily	Whether this view is rendered in BeginRenderingViewFamily() immediately after another render.
bool	bMultiGPUForkAndJoin	If true then each view is not rendered using the same GPUMask.
bool	bNullifyWorldSpacePosition	Indicates whether the shader world space position should be forced to 0.
bool	bRealtimeUpdate	Indicates whether the view family is updated in realtime.
bool	bRequireMultiView	True if scenecolor and depth should be multiview-allocated
bool	bResolveScene	If true then results of scene rendering are copied/resolved to the RenderTarget.
bool	bUsedDebugViewVSDSHS
bool	bWorldIsPaused	GetWorld->IsPaused() && !Simulate Simulate is excluded as the camera can move which invalidates motionblur
bool	bWorldIsPaused_IncludingSimulatingInEditor	GetWorld->IsPaused(). Simulate-in-Editor included.
float	DebugDPIScale	DPI scale to be used for debugging font.
EDebugViewShade...	DebugViewShaderMode
FDisplayInterna...	DisplayInternalsData	For r.DisplayInternals (allows for easy passing down data from main to render thread)
FEngineShowFlag...	EngineShowFlags	The new show flags for the views (meant to replace the old system).
FExposureSettin...	ExposureSettings	Editor setting to allow designers to override the automatic expose.
uint32	FrameNumber	Copy from main thread GFrameNumber to be accessible on render thread side.
float	GammaCorrection	Gamma correction used when rendering this family. Default is 1.0
int8	LandscapeLODOverride	Override the LOD of landscape in this viewport.
FString	ProfileDescription	Optional description of view family for Unreal Insights profiling.
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.
const FRenderTa...	RenderTarget	The render target which the views are being rendered to.
FSceneInterface...	Scene	The scene being viewed.
ESceneCaptureCo...	SceneCaptureCompositeMode	When enabled, the scene capture will composite into the render target instead of overwriting its contents.
ESceneCaptureSo...	SceneCaptureSource	Which component of the scene rendering should be output to the final render target.
ESecondaryScree...	SecondaryScreenPercentageMethod
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.
FGameTime	Time	The current time.
TArray< TShared...	ViewExtensions	Extensions that can modify view parameters on the render thread.
EViewModeIndex	ViewMode	View mode of the family.
int32	ViewModeParam
FName	ViewModeParamName
TArray< const F...	Views	The views which make up the family.

Constructors

	Name	Description
	FSceneViewFamily ( const ConstructionValues& CVS )	Initialization constructor.
	FSceneViewFamily ( const FSceneViewFamily&& InViewFam... )	Allow moving view family as long as no screen percentage interface are set.

Destructors

	Name	Description
	~FSceneViewFamily()

Functions

	Name	Description
bool	AllowTranslucencyAfterDOF()
EDebugViewSh...	ChooseDebugViewShaderMode()
EDebugViewSh...	GetDebugViewShaderMode()
ERHIFeatureL...	GetFeatureLevel()
float	GetPrimaryResolutionFractionUpperBound()	Returns the maximum PrimaryResolutionFraction.
const ISpati...	GetPrimarySpatialUpscalerInterface()
const IScene...	GetScreenPercentageInterface()
const ISpati...	GetSecondarySpatialUpscalerInterface()
EShaderPlatf...	GetShaderPlatform()
const ITempo...	GetTemporalUpscalerInterface()
int32	GetViewModeParam()
const FName ...	GetViewModeParamName()
void	SetPrimarySpatialUpscalerInterface ( ISpatialUpscaler* InSpatialUps... )
void	SetScreenPercentageInterface ( ISceneViewFamilyScreenPercentage&#... )	Safely sets the view family's screen percentage interface.
void	SetSecondarySpatialUpscalerInterface ( ISpatialUpscaler* InSpatialUps... )
void	SetTemporalUpscalerInterface ( const ITemporalUpscaler* InTem... )
bool	SupportsScreenPercentage()	Returns whether the screen percentage show flag is supported or not for this view family.
bool	UseDebugViewPS()
bool	UseDebugViewVSDSHS()

Operators

		Name	Description
	void	operator= ( const FSceneViewFamily& )	View family assignment operator is not allowed because of ScreenPercentageInterface lifetime.

Classes

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

Deprecated Variables

	Name	Description
float	CurrentRealTime	Use FSceneViewFamily::Time
float	CurrentWorldTime	Use FSceneViewFamily::Time
float	DeltaWorldTime	Use FSceneViewFamily::Time