FSceneViewFamily::ConstructionValues Struct Reference

#include <SceneView.h>

Public Member Functions
PRAGMA_DISABLE_DEPRECATION_WARNINGS	ConstructionValues (ConstructionValues &&)=default
	ConstructionValues (const ConstructionValues &Other)=default
ConstructionValues &	operator= (ConstructionValues &&)=default
ConstructionValues &	operator= (const ConstructionValues &Other)=default
PRAGMA_ENABLE_DEPRECATION_WARNINGS ENGINE_API	ConstructionValues (const FRenderTarget *InRenderTarget, FSceneInterface *InScene, const FEngineShowFlags &InEngineShowFlags)
ConstructionValues &	SetRenderTargetDepth (const FRenderTarget *InRenderTargetDepth)
ConstructionValues &	SetTime (const FGameTime &InTime)
ConstructionValues &	SetAdditionalViewFamily (const bool Value)
ConstructionValues &	SetRealtimeUpdate (const bool Value)
ConstructionValues &	SetDeferClear (const bool Value)
ConstructionValues &	SetResolveScene (const bool Value)
ConstructionValues &	SetRequireMobileMultiView (const bool Value)
ConstructionValues &	SetViewModeParam (const int InViewModeParam, const FName &InViewModeParamName)

Public Attributes
const FRenderTarget *	RenderTarget
const FRenderTarget *	RenderTargetDepth
FSceneInterface *	Scene
FEngineShowFlags	EngineShowFlags
int32	ViewModeParam
FName	ViewModeParamName
FGameTime	Time
uint32	bAdditionalViewFamily: 1
uint32	bRealtimeUpdate:1
uint32	bDeferClear:1
uint32	bResolveScene:1
uint32	bTimesSet:1
uint32	bRequireMultiView:1

Detailed Description

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

Parameters

InRenderTarget	The render target which the views are being rendered to.
InScene	The scene being viewed.
InShowFlags	The show flags for the views.

Constructor & Destructor Documentation

ConstructionValues() [1/3]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FSceneViewFamily::ConstructionValues::ConstructionValues ( ConstructionValues &&  )

default

ConstructionValues() [2/3]

FSceneViewFamily::ConstructionValues::ConstructionValues ( const ConstructionValues &  Other )

default

ConstructionValues() [3/3]

FSceneViewFamily::ConstructionValues::ConstructionValues	(	const FRenderTarget *	InRenderTarget,
		FSceneInterface *	InScene,
		const FEngineShowFlags &	InEngineShowFlags
	)

Member Function Documentation

operator=() [1/2]

ConstructionValues & FSceneViewFamily::ConstructionValues::operator= ( const ConstructionValues &  Other )

default

operator=() [2/2]

ConstructionValues & FSceneViewFamily::ConstructionValues::operator= ( ConstructionValues &&  )

default

SetAdditionalViewFamily()

ConstructionValues & FSceneViewFamily::ConstructionValues::SetAdditionalViewFamily ( const bool  Value )

inline

Set whether the view family is additional.

SetDeferClear()

ConstructionValues & FSceneViewFamily::ConstructionValues::SetDeferClear ( const bool  Value )

inline

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

SetRealtimeUpdate()

ConstructionValues & FSceneViewFamily::ConstructionValues::SetRealtimeUpdate ( const bool  Value )

inline

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

SetRenderTargetDepth()

ConstructionValues & FSceneViewFamily::ConstructionValues::SetRenderTargetDepth ( const FRenderTarget *  InRenderTargetDepth )

inline

SetRequireMobileMultiView()

ConstructionValues & FSceneViewFamily::ConstructionValues::SetRequireMobileMultiView ( const bool  Value )

inline

Setting to true results in scene color and depth being multiview-allocated.

SetResolveScene()

ConstructionValues & FSceneViewFamily::ConstructionValues::SetResolveScene ( const bool  Value )

inline

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

SetTime()

ConstructionValues & FSceneViewFamily::ConstructionValues::SetTime ( const FGameTime &  InTime )

inline

Set the world time and real time independently to handle time dilation.

SetViewModeParam()

ConstructionValues & FSceneViewFamily::ConstructionValues::SetViewModeParam ( const int  InViewModeParam, const FName &  InViewModeParamName  )

inline

Set the view param.

Member Data Documentation

bAdditionalViewFamily

uint32 FSceneViewFamily::ConstructionValues::bAdditionalViewFamily

Indicates whether the view family is additional.

bDeferClear

uint32 FSceneViewFamily::ConstructionValues::bDeferClear

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

bRealtimeUpdate

uint32 FSceneViewFamily::ConstructionValues::bRealtimeUpdate

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

bRequireMultiView

uint32 FSceneViewFamily::ConstructionValues::bRequireMultiView

True if scene color and depth should be multiview-allocated

bResolveScene

uint32 FSceneViewFamily::ConstructionValues::bResolveScene

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

bTimesSet

uint32 FSceneViewFamily::ConstructionValues::bTimesSet

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

EngineShowFlags

FEngineShowFlags FSceneViewFamily::ConstructionValues::EngineShowFlags

The engine show flags for the views.

RenderTarget

const FRenderTarget* FSceneViewFamily::ConstructionValues::RenderTarget

The views which make up the family.

RenderTargetDepth

const FRenderTarget* FSceneViewFamily::ConstructionValues::RenderTargetDepth

Scene

FSceneInterface* FSceneViewFamily::ConstructionValues::Scene

The render target which the views are being rendered to.

Time

FGameTime FSceneViewFamily::ConstructionValues::Time

The current time.

ViewModeParam

int32 FSceneViewFamily::ConstructionValues::ViewModeParam

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

ViewModeParamName

FName FSceneViewFamily::ConstructionValues::ViewModeParamName

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

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Engine/Public/SceneView.h
• Engine/Source/Runtime/Engine/Private/SceneView.cpp