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

#include <SceneViewExtension.h>

+ Inheritance diagram for FSceneViewExtensionBase:

Public Member Functions

ENGINE_API FSceneViewExtensionBase (const FAutoRegister &)
 
virtual ENGINE_API ~FSceneViewExtensionBase ()
 
virtual ENGINE_API bool IsActiveThisFrame (const FSceneViewExtensionContext &Context) const override final
 
- Public Member Functions inherited from ISceneViewExtension
virtual void SetupViewFamily (FSceneViewFamily &InViewFamily)
 
virtual void SetupView (FSceneViewFamily &InViewFamily, FSceneView &InView)
 
virtual void SetupViewPoint (APlayerController *Player, FMinimalViewInfo &InViewInfo)
 
virtual void SetupViewProjectionMatrix (FSceneViewProjectionData &InOutProjectionData)
 
virtual void BeginRenderViewFamily (FSceneViewFamily &InViewFamily)
 
virtual void PostCreateSceneRenderer (const FSceneViewFamily &InViewFamily, ISceneRenderer *Renderer)
 
virtual void PreRenderViewFamily_RenderThread (FRDGBuilder &GraphBuilder, FSceneViewFamily &InViewFamily)
 
virtual void PreRenderView_RenderThread (FRDGBuilder &GraphBuilder, FSceneView &InView)
 
virtual void PreInitViews_RenderThread (FRDGBuilder &GraphBuilder)
 
virtual void PreRenderBasePass_RenderThread (FRDGBuilder &GraphBuilder, bool bDepthBufferIsPopulated)
 
virtual void PostRenderBasePassDeferred_RenderThread (FRDGBuilder &GraphBuilder, FSceneView &InView, const FRenderTargetBindingSlots &RenderTargets, TRDGUniformBufferRef< FSceneTextureUniformParameters > SceneTextures)
 
virtual void PostRenderBasePassMobile_RenderThread (FRHICommandList &RHICmdList, FSceneView &InView)
 
virtual void PostTLASBuild_RenderThread (FRDGBuilder &GraphBuilder, FSceneView &InView)
 
virtual void PrePostProcessPass_RenderThread (FRDGBuilder &GraphBuilder, const FSceneView &InView, const FPostProcessingInputs &Inputs)
 
virtual void PrePostProcessPassMobile_RenderThread (FRDGBuilder &GraphBuilder, const FSceneView &InView, const FMobilePostProcessingInputs &Inputs)
 
virtual void SubscribeToPostProcessingPass (EPostProcessingPass Pass, const FSceneView &InView, FPostProcessingPassDelegateArray &InOutPassCallbacks, bool bIsPassEnabled)
 
virtual void PostRenderViewFamily_RenderThread (FRDGBuilder &GraphBuilder, FSceneViewFamily &InViewFamily)
 
virtual void PostRenderView_RenderThread (FRDGBuilder &GraphBuilder, FSceneView &InView)
 
virtual int32 GetPriority () const
 
virtual ESceneViewExtensionFlags GetFlags () const
 
virtual void SubscribeToPostProcessingPass (EPostProcessingPass Pass, FPostProcessingPassDelegateArray &InOutPassCallbacks, bool bIsPassEnabled)
 Deprecated APIs - These are no longer called and must be converted to restore functionality.
 
- Public Member Functions inherited from TSharedFromThis< FSceneViewExtensionBase, ESPMode::ThreadSafe >
TSharedRef< FSceneViewExtensionBase, Mode > AsShared ()
 
TSharedRef< FSceneViewExtensionBase const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FSceneViewExtensionBase, Mode > AsWeak ()
 
TWeakPtr< FSceneViewExtensionBase const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Public Attributes

TArray< FSceneViewExtensionIsActiveFunctor > IsActiveThisFrameFunctions
 

Additional Inherited Members

- Public Types inherited from ISceneViewExtension
enum class  EPostProcessingPass : uint32 {
  BeforeDOF , AfterDOF , TranslucencyAfterDOF , SSRInput ,
  ReplacingTonemapper , MotionBlur , Tonemap , FXAA ,
  SMAA , VisualizeDepthOfField , MAX
}
 
- Protected Member Functions inherited from ISceneViewExtension
virtual bool IsActiveThisFrame_Internal (const FSceneViewExtensionContext &Context) const
 
- Protected Member Functions inherited from TSharedFromThis< FSceneViewExtensionBase, ESPMode::ThreadSafe >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< FSceneViewExtensionBase, ESPMode::ThreadSafe >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Detailed Description

Inherit from this class to make a view extension.

Constructor & Destructor Documentation

◆ FSceneViewExtensionBase()

FSceneViewExtensionBase::FSceneViewExtensionBase ( const FAutoRegister &  )

◆ ~FSceneViewExtensionBase()

FSceneViewExtensionBase::~FSceneViewExtensionBase ( )
virtual

Member Function Documentation

◆ IsActiveThisFrame()

bool FSceneViewExtensionBase::IsActiveThisFrame ( const FSceneViewExtensionContext &  Context) const
finaloverridevirtual

Returning false disables the extension for the current frame in the given context. This will be queried each frame to determine if the extension wants to run.

Reimplemented from ISceneViewExtension.

Member Data Documentation

◆ IsActiveThisFrameFunctions

TArray<FSceneViewExtensionIsActiveFunctor> FSceneViewExtensionBase::IsActiveThisFrameFunctions
The documentation for this class was generated from the following files: