Navigation
API > API/Plugins > API/Plugins/ViewportWidgetOverlay
Implements shared widget initialization logic.
| Name | FViewportWidgetOverlay_PostProcessBase |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/ViewportWidgetOverlay/Source/ViewportWidgetOverlay/Public/Misc/ViewportWidgetOverlay_PostProcessBase.h |
| Include Path | #include "Misc/ViewportWidgetOverlay_PostProcessBase.h" |
Syntax
USTRUCT ()
struct FViewportWidgetOverlay_PostProcessBase
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FViewportWidgetOverlay_PostProcessBase() |
Misc/ViewportWidgetOverlay_PostProcessBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FViewportWidgetOverlay_PostProcessBase() |
Misc/ViewportWidgetOverlay_PostProcessBase.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bReceiveHardwareInput | bool | Register with the viewport for hardware input from the mouse and keyboard. | Misc/ViewportWidgetOverlay_PostProcessBase.h |
|
| bUseWidgetDrawSize | bool | Whether to overwrite the size of the rendered widget. | Misc/ViewportWidgetOverlay_PostProcessBase.h |
|
| bWindowFocusable | bool | Is the virtual window created to host the widget focusable? | Misc/ViewportWidgetOverlay_PostProcessBase.h |
|
| EditorTargetViewport | TWeakPtr< FSceneViewport > | The viewport to use for displaying. |
Defaults to GetFirstActiveLevelViewport(). | Misc/ViewportWidgetOverlay_PostProcessBase.h | |
| PostProcessMaterial | TObjectPtr< UMaterialInterface > | Post process material used to display the widget. | Misc/ViewportWidgetOverlay_PostProcessBase.h |
|
| PostProcessOpacityFromTexture | float | Sets the amount of opacity from the widget's UI texture to use when rendering the translucent or masked UI to the viewport (0.0-1.0). | Misc/ViewportWidgetOverlay_PostProcessBase.h |
|
| PostProcessTintColorAndOpacity | FLinearColor | Tint color and opacity for this component. | Misc/ViewportWidgetOverlay_PostProcessBase.h |
|
| RenderTargetBackgroundColor | FLinearColor | The background color of the render target | Misc/ViewportWidgetOverlay_PostProcessBase.h |
|
| RenderTargetBlendMode | EWidgetBlendMode | The blend mode for the widget. | Misc/ViewportWidgetOverlay_PostProcessBase.h |
|
| WidgetDrawSize | FIntPoint | The size of the rendered widget. | Misc/ViewportWidgetOverlay_PostProcessBase.h |
|
| WidgetRenderTarget | TObjectPtr< UTextureRenderTarget2D > | The target to which the user widget is rendered. | Misc/ViewportWidgetOverlay_PostProcessBase.h |
|
| WindowVisibility | EWindowVisibility | The visibility of the virtual window created to host the widget. | Misc/ViewportWidgetOverlay_PostProcessBase.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentWidgetDrawSize | FIntPoint | The size of the rendered widget | Misc/ViewportWidgetOverlay_PostProcessBase.h | |
| CustomHitTestPath | TSharedPtr< UE::VPUtilities::Private::FVPWidgetPostProcessHitTester > | Hit tester when we want the hardware input. | Misc/ViewportWidgetOverlay_PostProcessBase.h | |
| SlateWindow | TSharedPtr< SVirtualWindow > | The slate window that contains the user widget content. | Misc/ViewportWidgetOverlay_PostProcessBase.h | |
| ViewportWidget | TWeakPtr< SViewport > | The slate viewport we are registered to. | Misc/ViewportWidgetOverlay_PostProcessBase.h | |
| WidgetRenderer | FWidgetRenderer * | Helper class for drawing widgets to a render target. | Misc/ViewportWidgetOverlay_PostProcessBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< SVirtualWindow > GetSlateWindow() |
Misc/ViewportWidgetOverlay_PostProcessBase.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Hide
(
UWorld* World |
Deinits this output type | Misc/ViewportWidgetOverlay_PostProcessBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CreateRenderer
(
UWorld* World, |
Misc/ViewportWidgetOverlay_PostProcessBase.h | ||
void TickRenderer
(
UWorld* World, |
Misc/ViewportWidgetOverlay_PostProcessBase.h |
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseRenderer() |
Misc/ViewportWidgetOverlay_PostProcessBase.h |