Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. FVPFullScreenUserWidget_PostProcessBase

FVPFullScreenUserWidget_PostProcessBase

Implements shared widget initialization logic.

API > API/Plugins > API/Plugins/VPUtilities

Implements shared widget initialization logic.

   
Name FVPFullScreenUserWidget_PostProcessBase
Type struct
Header File /Engine/Plugins/Experimental/VirtualProductionUtilities/Source/VPUtilities/Public/Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
Include Path #include "Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h"

Syntax

USTRUCT ()  
struct FVPFullScreenUserWidget_PostProcessBase

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FVPFullScreenUserWidget_PostProcessBase()

   Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FVPFullScreenUserWidget_PostProcessBase()

   Widgets/Fullscreen/VPFullScreenUserWidget_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. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=PostProcess
bUseWidgetDrawSize bool Whether to overwrite the size of the rendered widget. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
  • EditAnywhere
  • Category=PostProcess
  • Meta=(InlineEditConditionToggle)
bWindowFocusable bool Is the virtual window created to host the widget focusable? Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=PostProcess
EditorTargetViewport TWeakPtr< FSceneViewport > The viewport to use for displaying.    

Defaults to GetFirstActiveLevelViewport(). | Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h | |

PostProcessMaterial TObjectPtr< UMaterialInterface > Post process material used to display the widget. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
  • EditAnywhere
  • Category=PostProcess
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). Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
  • EditAnywhere
  • Category=PostProcess
  • Meta=(ClampMin=0.0f, ClampMax=1.0f)
PostProcessTintColorAndOpacity FLinearColor Tint color and opacity for this component. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
  • EditAnywhere
  • Category=PostProcess
RenderTargetBackgroundColor FLinearColor The background color of the render target Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=PostProcess
RenderTargetBlendMode EWidgetBlendMode The blend mode for the widget. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=PostProcess
WidgetDrawSize FIntPoint The size of the rendered widget. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
  • EditAnywhere
  • Category=PostProcess
  • Meta=(EditCondition=bWidgetDrawSize)
WidgetRenderTarget TObjectPtr< UTextureRenderTarget2D > The target to which the user widget is rendered. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
  • Transient
WindowVisibility EWindowVisibility The visibility of the virtual window created to host the widget. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=PostProcess

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentWidgetDrawSize FIntPoint The size of the rendered widget Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h  
CustomHitTestPath TSharedPtr< UE::VPUtilities::Private::FVPWidgetPostProcessHitTester > Hit tester when we want the hardware input. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h  
SlateWindow TSharedPtr< SVirtualWindow > The slate window that contains the user widget content. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h  
ViewportWidget TWeakPtr< SViewport > The slate viewport we are registered to. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h  
WidgetRenderer FWidgetRenderer * Helper class for drawing widgets to a render target. Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedPtr< SVirtualWindow > GetSlateWindow()

   Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h  

virtual void Hide ( UWorld* World
)

 Deinits this output type Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool CreateRenderer ( UWorld* World,
UUserWidget* Widget,
TAttribute< float > InDPIScale
)

   Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h  

virtual void ReleaseRenderer()

   Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h  

void TickRenderer ( UWorld* World,
float DeltaSeconds
)

   Widgets/Fullscreen/VPFullScreenUserWidget_PostProcessBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page