Navigation
API > API/Runtime > API/Runtime/VirtualProduction
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.
| Name | IUpscalerModularFeature |
| Type | class |
| Header File | /Engine/Source/Runtime/VirtualProduction/VirtualProduction/Public/IUpscalerModularFeature.h |
| Include Path | #include "IUpscalerModularFeature.h" |
Syntax
class IUpscalerModularFeature : public IModularFeature
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IUpscalerModularFeature() |
IUpscalerModularFeature.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ModularFeatureName | const TCHAR * | The unique modular feature name. | IUpscalerModularFeature.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddSceneViewExtensionIsActiveFunctor
(
const FSceneViewExtensionIsActiveFunctor& IsActiveFunction |
Adds a functor and returns a GUID to identify it. | IUpscalerModularFeature.h | |
const FText & GetDisplayName() |
Gets the display name shown in the UI. | IUpscalerModularFeature.h | |
const FName & GetName() |
Returns the unique identifier name for this feature. | IUpscalerModularFeature.h | |
virtual bool GetSettings
(
FInstancedPropertyBag& OuUpscalerSettings |
Get default settings for this upscaler | IUpscalerModularFeature.h | |
const FText & GetTooltipText() |
Returns a hint text for the feature. | IUpscalerModularFeature.h | |
bool IsFeatureEnabled () |
Determines whether the feature is currently enabled and available for use. | IUpscalerModularFeature.h | |
bool PostConfigureViewFamily
(
const FInstancedPropertyBag& InUpscalerSettings, |
Configure ViewFamily and it Views for specific settings and use these settings for the views. | IUpscalerModularFeature.h | |
bool RemoveSceneViewExtensionIsActiveFunctor
(
const FGuid& FunctorGuid |
Removes a functor by GUID. | IUpscalerModularFeature.h | |
void SetupSceneView
(
const FInstancedPropertyBag& InUpscalerSettings, |
Setup SceneView for this upscaler. | IUpscalerModularFeature.h |