ConstructionValues

Helper struct for creating [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) instances If created with specifying a time it will retrieve them from the world in the given scene.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/SceneView.h

Include

#include "SceneView.h"

Syntax

struct ConstructionValues

Remarks

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

Variables

Name Description

Public variable

uint32: 1

 

bAdditionalViewFamily

Indicates whether the view family is additional.

Public variable

uint32: 1

 

bDeferClear

Used to defer the back buffer clearing to just before the back buffer is drawn to

Public variable

uint32: 1

 

bRealtimeUpdate

Indicates whether the view family is updated in real-time.

Public variable

uint32: 1

 

bResolveScene

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

Public variable

uint32: 1

 

bTimesSet

Safety check to ensure valid times are set either from a valid world/scene pointer or via the SetWorldTimes function

Public variable

float

 

CurrentRealTime

The current real time.

Public variable

float

 

CurrentWorldTime

The current world time.

Public variable

float

 

DeltaWorldTime

The difference between the last world time and CurrentWorldTime.

Public variable

FEngineShowFlag...

 

EngineShowFlags

The engine show flags for the views.

Public variable

float

 

GammaCorrection

Gamma correction used when rendering this family. Default is 1.0

Public variable

const FRenderTa...

 

RenderTarget

The views which make up the family.

Public variable

FSceneInterface...

 

Scene

The render target which the views are being rendered to.

Public variable

int32

 

ViewModeParam

Additional view params related to the current viewmode (example : texcoord index)

Public variable

FName

 

ViewModeParamName

An name bound to the current viewmode param. (example : texture name)

Constructors

Name Description

Public function

ConstructionValues

(
    const FRenderTarget* InRenderT...,
    FSceneInterface* InScene,
    const FEngineShowFlags& InEngineSh...
)

Functions

Name Description

Public function

Construction...

 

SetAdditionalViewFamily

(
    const bool Value
)

Set whether the view family is additional.

Public function

Construction...

 

SetDeferClear

(
    const bool Value
)

Set whether to defer the back buffer clearing to just before the back buffer is drawn to

Public function

Construction...

 

SetGammaCorrection

(
    const float Value
)

Set Gamma correction used when rendering this family.

Public function

Construction...

 

SetRealtimeUpdate

(
    const bool Value
)

Set whether the view family is updated in real-time.

Public function

Construction...

 

SetResolveScene

(
    const bool Value
)

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

Public function

Construction...

 

SetViewModeParam

(
    const int InViewModeParam,
    const FName& InViewModeParamName
)

Set the view param.

Public function

Construction...

 

SetWorldTimes

(
    const float InCurrentWorldTime,
    const float InDeltaWorldTime,
    const float InCurrentRealTime
)

Set the world time ,difference between the last world time and CurrentWorldTime and current real time.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss