UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | Friends | List of all members
FViewFamilyInfo Class Reference

#include <SceneRendering.h>

+ Inheritance diagram for FViewFamilyInfo:

Public Member Functions

 FViewFamilyInfo (const FSceneViewFamily &InViewFamily)
 
 FViewFamilyInfo (const FSceneViewFamily::ConstructionValues &CVS, const FViewFamilyInfo &MainViewFamily)
 
virtual ~FViewFamilyInfo ()
 
FSceneTextures & GetSceneTextures ()
 
const FSceneTextures & GetSceneTextures () const
 
FSceneTextures * GetSceneTexturesChecked ()
 
const FSceneTextures * GetSceneTexturesChecked () const
 
- Public Member Functions inherited from FSceneViewFamily
ENGINE_API FSceneViewFamily (const ConstructionValues &CVS)
 
ENGINE_API FSceneViewFamily (const FSceneViewFamily &)
 
virtual ENGINE_API ~FSceneViewFamily ()
 
ENGINE_API ERHIFeatureLevel::Type GetFeatureLevel () const
 
EShaderPlatform GetShaderPlatform () const
 
ENGINE_API EDebugViewShaderMode ChooseDebugViewShaderMode () const
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS ENGINE_API EDebugViewShaderMode GetDebugViewShaderMode () const
 
void SetDebugViewShaderMode (EDebugViewShaderMode InMode)
 
int32 GetViewModeParam () const
 
const FName & GetViewModeParamName () const
 
bool UseDebugViewPS () const
 
PRAGMA_ENABLE_DEPRECATION_WARNINGS ENGINE_API bool SupportsScreenPercentage () const
 
bool AllowTranslucencyAfterDOF () const
 
bool AllowStandardTranslucencySeparated () const
 
const ISceneViewFamilyScreenPercentage * GetScreenPercentageInterface () const
 
void SetScreenPercentageInterface (ISceneViewFamilyScreenPercentage *InScreenPercentageInterface)
 
void SetScreenPercentageInterface_Unchecked (ISceneViewFamilyScreenPercentage *InScreenPercentageInterface)
 
void operator= (const FSceneViewFamily &)=delete
 
ENGINE_API FSceneViewFamily (FSceneViewFamily &&InViewFamily)
 
template<typename TExtensionData >
const TExtensionData * GetExtentionData () const
 
template<typename TExtensionData >
TExtensionData * GetExtentionData ()
 
template<typename TExtensionData >
TExtensionData * GetOrCreateExtentionData ()
 
void SetTemporalUpscalerInterface (UE::Renderer::Private::ITemporalUpscaler *InTemporalUpscalerInterface)
 
const UE::Renderer::Private::ITemporalUpscaler * GetTemporalUpscalerInterface () const
 
void SetPrimarySpatialUpscalerInterface (ISpatialUpscaler *InSpatialUpscalerInterface)
 
const ISpatialUpscaler * GetPrimarySpatialUpscalerInterface () const
 
void SetSecondarySpatialUpscalerInterface (ISpatialUpscaler *InSpatialUpscalerInterface)
 
const ISpatialUpscaler * GetSecondarySpatialUpscalerInterface () const
 
bool GetIsInFocus () const
 
void SetIsInFocus (bool bInIsInFocus)
 
void SetSceneRenderer (ISceneRenderer *NewSceneRenderer)
 
ISceneRenderer * GetSceneRenderer () const
 

Public Attributes

FSceneTexturesConfig SceneTexturesConfig
 
bool bIsSceneTextureSizedCapture = false
 
- Public Attributes inherited from FSceneViewFamily
TArray< const FSceneView * > Views
 
TArray< const FSceneView * > AllViews
 
EViewModeIndex ViewMode
 
const FRenderTarget * RenderTarget
 
const FRenderTarget * RenderTargetDepth
 
FSceneInterface * Scene
 
FEngineShowFlags EngineShowFlags
 
FGameTime Time
 
uint32 FrameNumber
 
uint64 FrameCounter = 0
 
bool bAdditionalViewFamily
 
bool bRealtimeUpdate
 
bool bDeferClear
 
bool bResolveScene
 
bool bMultiGPUForkAndJoin
 
bool bIsMultipleViewFamily = false
 
bool bIsFirstViewInMultipleViewFamily = true
 
bool bIsViewFamilyInfo = false
 
bool bSplitScreenDebugAllowed = false
 
bool bIsMainViewFamily = false
 
ESceneCaptureSource SceneCaptureSource
 
ESceneCaptureCompositeMode SceneCaptureCompositeMode
 
bool bThumbnailRendering = false
 
bool bWorldIsPaused
 
bool bIsHDR
 
bool bRequireMultiView
 
float DebugDPIScale = 1.0f
 
FExposureSettings ExposureSettings
 
TArray< TSharedRef< class ISceneViewExtension, ESPMode::ThreadSafe > > ViewExtensions
 
FDisplayInternalsData DisplayInternalsData
 
float SecondaryViewFraction
 
ESecondaryScreenPercentageMethod SecondaryScreenPercentageMethod
 
int8 LandscapeLODOverride
 
bool bCurrentlyBeingEdited
 
bool bOverrideVirtualTextureThrottle
 
int32 VirtualTextureFeedbackFactor
 
FString ProfileDescription
 
float * ProfileSceneRenderTime = nullptr
 
TArray< FVector, TInlineAllocator< 2 > > StreamingViewOrigins
 
EDebugViewShaderMode DebugViewShaderMode = DVSM_MAX
 
int32 ViewModeParam
 
FName ViewModeParamName
 

Friends

struct FMinimalSceneTextures
 
struct FSceneTextures
 

Detailed Description

View family plus associated transient scene textures.

Constructor & Destructor Documentation

◆ FViewFamilyInfo() [1/2]

FViewFamilyInfo::FViewFamilyInfo ( const FSceneViewFamily &  InViewFamily)
explicit

◆ FViewFamilyInfo() [2/2]

FViewFamilyInfo::FViewFamilyInfo ( const FSceneViewFamily::ConstructionValues &  CVS,
const FViewFamilyInfo &  MainViewFamily 
)
explicit

◆ ~FViewFamilyInfo()

FViewFamilyInfo::~FViewFamilyInfo ( )
virtual

Member Function Documentation

◆ GetSceneTextures() [1/2]

FSceneTextures & FViewFamilyInfo::GetSceneTextures ( )
inline

Get scene textures associated with this view family – asserts or checks that they have been initialized

◆ GetSceneTextures() [2/2]

const FSceneTextures & FViewFamilyInfo::GetSceneTextures ( ) const
inline

◆ GetSceneTexturesChecked() [1/2]

FSceneTextures * FViewFamilyInfo::GetSceneTexturesChecked ( )
inline

◆ GetSceneTexturesChecked() [2/2]

const FSceneTextures * FViewFamilyInfo::GetSceneTexturesChecked ( ) const
inline

Friends And Related Symbol Documentation

◆ FMinimalSceneTextures

friend struct FMinimalSceneTextures
friend

◆ FSceneTextures

friend struct FSceneTextures
friend

Member Data Documentation

◆ bIsSceneTextureSizedCapture

bool FViewFamilyInfo::bIsSceneTextureSizedCapture = false

Set to true if this is a scene capture sized to scene texture size

◆ SceneTexturesConfig

FSceneTexturesConfig FViewFamilyInfo::SceneTexturesConfig
The documentation for this class was generated from the following files: