1. Epic GamesDeveloper
  3. UVPFullScreenUserWidget

UVPFullScreenUserWidget

Will set the Widgets on a viewport either by Widgets are first rendered to a render target, then that render target is displayed in the world.

API > API/Plugins > API/Plugins/VPUtilities > API/Plugins/VPUtilities/Widgets

Inheritance Hierarchy

References

   
Module VPUtilities
Header /Engine/Plugins/Experimental/VirtualProductionUtilities/Source/VPUtilities/Public/Widgets/VPFullScreenUserWidget.h
Include #include "Widgets/VPFullScreenUserWidget.h"

Syntax

UCLASS&40;Meta&61;&40;ShowOnlyInnerProperties&41;&41;  
class UVPFullScreenUserWidget : public UObject

Remarks

Will set the Widgets on a viewport either by Widgets are first rendered to a render target, then that render target is displayed in the world.

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere EVPWidgetDisplayType EditorDisplayType The display type when the world is an editor world.
Protected variable UProperty Category, EditAnywhere EVPWidgetDisplayType GameDisplayType The display type when the world is a game world.
Protected variable UProperty Category, EditAnywhere, Meta EVPWidgetDisplayType PIEDisplayType The display type when the world is a PIE world.
Protected variable UProperty Category, EditAnywhere FVPFullScreenUserWidget_PostProcess PostProcessDisplayTypeWithBlendMaterial Behavior when the widget is rendered via a post process material via post process volume settings; the widget is added only over area rendered by anamorphic squeeze.
Protected variable UProperty Category, EditAnywhere FVPFullScreenUserWidget_PostProcessWithSVE PostProcessWithSceneViewExtensions Behavior when the widget is rendered via a post process material via SceneViewExtensions; the widget is added over entire viewport, ignoring anamorphic squeeze.
Protected variable UProperty Category, EditAnywhere, Meta FVPFullScreenUserWidget_Viewport ViewportDisplayType Behavior when the widget should be display by the slate attached to the viewport.
Protected variable UProperty Category, EditAnywhere TSubclassOf< UUserWidget > WidgetClass The class of User Widget to create and display an instance of

Constructors

  Type Name Description
Public function  

UVPFullScreenUserWidget ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual bool

Display ( UWorld* World
)

  
Public function Static constexpr bool  
Protected function FVector2D  
Public function Const const FVPFullScreenUserWidget_PostProcess &  
Public function FVPFullScreenUserWidget_PostProcess &  
Public function Const EVPWidgetDisplayType

GetDisplayType ( UWorld* World
)

  
Public function Const const FVPFullScreenUserWidget_PostProcessBase * Returns the base post process settings for the given type if DoesDisplayTypeUsePostProcessSettings(Type) returns true.
Public function FVPFullScreenUserWidget_PostProcessBase * Returns the base post process settings for the given type if DoesDisplayTypeUsePostProcessSettings(Type) returns true.
Public function Const const FVPFullScreenUserWidget_PostProcess &  
Public function FVPFullScreenUserWidget_PostProcess &  
Public function FVPFullScreenUserWidget_PostProcessWithSVE &  
Public function Const const FVPFullScreenUserWidget_PostProcessWithSVE &  
Protected function float  
Public function Const UUserWidget * Get a pointer to the inner widget. Note: This should not be stored!
Public function Const TSubclassOf< UUserWidget > Gets the widget class being displayed
Public function Virtual void

Hide ()

  
Protected function bool  
Public function Const bool  
Protected function void  
Public function void Resets the TargetViewport
Public function void

SetCustomPostProcessSettingsSource ( TWeakObjectPtr< UObject > InCustomPostProcessSettingsSource
)

 If using EVPWidgetDisplayType::PostProcessWithBlendMaterial, you can specify a custom post process settings that should be modified.
Public function void

SetDisplayTypes ( EVPWidgetDisplayType InEditorDisplayType,
EVPWidgetDisplayType InGameDisplayType,
EVPWidgetDisplayType InPIEDisplayType
)

 Sets the way the widget is supposed to be displayed
Public function void Sets the TargetViewport to use on both the Viewport and the PostProcess class.
Public function void

SetWidgetClass ( TSubclassOf< UUserWidget > InWidgetClass
)

 Sets the widget class to be displayed.
Public function Const bool

ShouldDisplay ( UWorld* World
)

  
Public function Virtual void

Tick ( float DeltaTime
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page