FSceneViewFamily

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

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

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

 

bIsHDR

When enabled, the post processing will output in HDR space

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

 

bRealtimeUpdate

Indicates whether the view family is updated in realtime.

Public variable

bool

 

bResolveScene

If true then results of scene rendering are copied/resolved to the RenderTarget.

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

The current real time.

Public variable

float

 

CurrentWorldTime

The current world time.

Public variable

EDebugViewShaderMode

 

DebugViewShaderMode

Public variable

float

 

DeltaWorldTime

The difference between the last world time and CurrentWorldTime.

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

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

const FRenderTarget *

 

RenderTarget

The render target which the views are being rendered to.

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< 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.

Constructors

Name Description

Public function

FSceneViewFamily

(
    const ConstructionValues& CVS
)

Initialization constructor.

Public function

FSceneViewFamily

(
    const FSceneViewFamily&& InViewFamily
)

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

Destructors

Name Description

Public function

~FSceneViewFamily()

Functions

Name Description

Public function Const

bool

 

AllowTranslucencyAfterDOF()

Public function Const

EDebugViewShaderMode

 

ChooseDebugViewShaderMode()

Public function Const

EDebugViewShaderMode

 

GetDebugViewShaderMode()

Public function Const

ERHIFeatureLevel::Type

 

GetFeatureLevel()

Public function Const

float

 

GetPrimaryResolutionFractionUpperBound()

Returns the maximum [FSceneViewScreenPercentageConfig::PrimaryResolutionFraction](API\Runtime\Engine\FSceneViewScreenPercentageConfig\PrimaryResolutionFraction).

Public function Const

const ISceneViewFamilyScreenPercentage *

 

GetScreenPercentageInterface()

Public function Const

EShaderPlatform

 

GetShaderPlatform()

Public function Const

const FSceneView &

 

GetStereoEyeView

(
    const EStereoscopicPass Eye
)

Returns the appropriate view for a given eye in a stereo pair.

Public function Const

int32

 

GetViewModeParam()

Public function Const

const FName &

 

GetViewModeParamName()

Public function

void

 

SetScreenPercentageInterface

(
    ISceneViewFamilyScreenPercentage* InScreenPercentageInterface
)

Safely sets the view family's screen percentage interface.

Public function Const

bool

 

SupportsScreenPercentage()

Returns whether the screen percentage show flag is supported or not for this view family.

Public function Const

bool

 

UseDebugViewPS()

Public function Const

bool

 

UseDebugViewVSDSHS()

Operators

Name Description

Public function

void

 

operator=

(
    const FSceneViewFamily&
)

View family assignment operator is not allowed because of ScreenPercentageInterface lifetime.

Classes

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.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback