UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Attributes | List of all members
UE::VirtualProduction::IUpscalerModularFeature Class Referenceabstract

#include <IUpscalerModularFeature.h>

+ Inheritance diagram for UE::VirtualProduction::IUpscalerModularFeature:

Public Member Functions

virtual ~IUpscalerModularFeature ()=default
 
virtual const FName & GetName () const =0
 
virtual const FText & GetDisplayName () const =0
 
virtual const FText & GetTooltipText () const =0
 
virtual bool IsFeatureEnabled () const =0
 
virtual bool AddSceneViewExtensionIsActiveFunctor (const FSceneViewExtensionIsActiveFunctor &IsActiveFunction)=0
 
virtual bool RemoveSceneViewExtensionIsActiveFunctor (const FGuid &FunctorGuid)=0
 
virtual bool GetSettings (FInstancedPropertyBag &OuUpscalerSettings) const
 
virtual void SetupSceneView (const FInstancedPropertyBag &InUpscalerSettings, FSceneView &InOutView)=0
 
virtual bool PostConfigureViewFamily (const FInstancedPropertyBag &InUpscalerSettings, const FUpscalerModularFeatureParameters &InUpscalerParam, FSceneViewFamilyContext &InOutViewFamily)=0
 

Static Public Attributes

static constexpr const TCHAR * ModularFeatureName = TEXT("UpscalerModularFeature")
 

Detailed Description

Interface for a modular feature of a Upscaler.

This interface provides a way to interact with the upscaler without requiring the presence of their specific plugins. It allows modular features to be integrated and accessed within the rendering pipeline in a flexible and decoupled manner.

Classes implementing this interface can define custom behavior and settings for Scene View Extensions while maintaining compatibility with other parts of the Unreal Engine system.

Constructor & Destructor Documentation

◆ ~IUpscalerModularFeature()

virtual UE::VirtualProduction::IUpscalerModularFeature::~IUpscalerModularFeature ( )
virtualdefault

Member Function Documentation

◆ AddSceneViewExtensionIsActiveFunctor()

virtual bool UE::VirtualProduction::IUpscalerModularFeature::AddSceneViewExtensionIsActiveFunctor ( const FSceneViewExtensionIsActiveFunctor &  IsActiveFunction)
pure virtual

Adds a functor and returns a GUID to identify it.

Parameters
IsActiveFunction- the functor with custom logic for the upscaler ViewExtension
Returns
true on success

◆ GetDisplayName()

virtual const FText & UE::VirtualProduction::IUpscalerModularFeature::GetDisplayName ( ) const
pure virtual

Gets the display name shown in the UI.

◆ GetName()

virtual const FName & UE::VirtualProduction::IUpscalerModularFeature::GetName ( ) const
pure virtual

Returns the unique identifier name for this feature.

◆ GetSettings()

virtual bool UE::VirtualProduction::IUpscalerModularFeature::GetSettings ( FInstancedPropertyBag &  OuUpscalerSettings) const
inlinevirtual

Get default settings for this upscaler

Parameters
OuUpscalerSettings- (out) default settings
Returns
true if successed.

◆ GetTooltipText()

virtual const FText & UE::VirtualProduction::IUpscalerModularFeature::GetTooltipText ( ) const
pure virtual

Returns a hint text for the feature.

◆ IsFeatureEnabled()

virtual bool UE::VirtualProduction::IUpscalerModularFeature::IsFeatureEnabled ( ) const
pure virtual

Determines whether the feature is currently enabled and available for use. This can depend on config, platform, or runtime logic.

◆ PostConfigureViewFamily()

virtual bool UE::VirtualProduction::IUpscalerModularFeature::PostConfigureViewFamily ( const FInstancedPropertyBag &  InUpscalerSettings,
const FUpscalerModularFeatureParameters &  InUpscalerParam,
FSceneViewFamilyContext &  InOutViewFamily 
)
pure virtual

Configure ViewFamily and it Views for specific settings and use these settings for the views. Note: Expected that these parameters should be configured: InOutViewFamily.SetScreenPercentageInterface(); InOutViewFamily.SecondaryViewFraction; 241300 Some features from the settings may require additional customization in the view family or view structures.

Parameters
InUpscalerSettings- (in) upscaler settings which we want to use. This settings should be associated with the InOutViews.
InUpscalerParam- (in) upscaler parameters that is used to configure view family.
InOutViewFamily- (in, out) The view family that will be configured.

◆ RemoveSceneViewExtensionIsActiveFunctor()

virtual bool UE::VirtualProduction::IUpscalerModularFeature::RemoveSceneViewExtensionIsActiveFunctor ( const FGuid &  FunctorGuid)
pure virtual

Removes a functor by GUID.

Parameters
FunctorGuid- use value from the FSceneViewExtensionIsActiveFunctor::GetGuid()
Returns
true if the functor exists and has been deleted

◆ SetupSceneView()

virtual void UE::VirtualProduction::IUpscalerModularFeature::SetupSceneView ( const FInstancedPropertyBag &  InUpscalerSettings,
FSceneView &  InOutView 
)
pure virtual

Setup SceneView for this upscaler. Upscalers should configure the view properties (e.g. AntiAliasingMethod) for their rendering pipeline (temporal/spatial/etc.).

Parameters
InUpscalerSettings- (in) upscaler settings which we want to use. This settings should be associated with the InOutViews.
InOutView- (in) scene view to that will be configured.

Member Data Documentation

◆ ModularFeatureName

constexpr const TCHAR* UE::VirtualProduction::IUpscalerModularFeature::ModularFeatureName = TEXT("UpscalerModularFeature")
staticconstexpr

The unique modular feature name.

The documentation for this class was generated from the following file: