Navigation
API > API/Plugins > API/Plugins/VPUtilities
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.
| Name | UVPFullScreenUserWidget |
| Type | class |
| Header File | /Engine/Plugins/Experimental/VirtualProductionUtilities/Source/VPUtilities/Public/Widgets/VPFullScreenUserWidget.h |
| Include Path | #include "Widgets/VPFullScreenUserWidget.h" |
Syntax
UCLASS (Meta=(ShowOnlyInnerProperties))
class UVPFullScreenUserWidget : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVPFullScreenUserWidget
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UVPFullScreenUserWidget
(
const FObjectInitializer& ObjectInitializer |
Widgets/VPFullScreenUserWidget.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDisplayRequested | bool | The user requested the widget to be displayed. | Widgets/VPFullScreenUserWidget.h | |
| CurrentDisplayType | EVPWidgetDisplayType | How we currently displaying the widget. | Widgets/VPFullScreenUserWidget.h |
|
| EditorTargetViewport | TWeakPtr< FSceneViewport > | The viewport to use for displaying. Defaults to GetFirstActiveLevelViewport(). | Widgets/VPFullScreenUserWidget.h | |
| Widget | TObjectPtr< UUserWidget > | The User Widget object displayed and managed by this component | Widgets/VPFullScreenUserWidget.h |
|
| World | TWeakObjectPtr< UWorld > | The world the widget is attached to. | Widgets/VPFullScreenUserWidget.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Display
(
UWorld* World |
Widgets/VPFullScreenUserWidget.h | ||
| Widgets/VPFullScreenUserWidget.h | |||
| Widgets/VPFullScreenUserWidget.h | |||
EVPWidgetDisplayType GetDisplayType
(
UWorld* World |
Widgets/VPFullScreenUserWidget.h | ||
const FVPFullScreenUserWidget_PostProcessBase * GetPostProcessDisplayTypeSettingsFor
(
EVPWidgetDisplayType Type |
Returns the base post process settings for the given type if DoesDisplayTypeUsePostProcessSettings(Type) returns true. | Widgets/VPFullScreenUserWidget.h | |
| Returns the base post process settings for the given type if DoesDisplayTypeUsePostProcessSettings(Type) returns true. | Widgets/VPFullScreenUserWidget.h | ||
| Widgets/VPFullScreenUserWidget.h | |||
| Widgets/VPFullScreenUserWidget.h | |||
| Widgets/VPFullScreenUserWidget.h | |||
| Widgets/VPFullScreenUserWidget.h | |||
UUserWidget * GetWidget() |
Get a pointer to the inner widget. Note: This should not be stored! | Widgets/VPFullScreenUserWidget.h | |
TSubclassOf< UUserWidget > GetWidgetClass() |
Gets the widget class being displayed | Widgets/VPFullScreenUserWidget.h | |
virtual void Hide() |
Widgets/VPFullScreenUserWidget.h | ||
bool IsDisplayed() |
Widgets/VPFullScreenUserWidget.h | ||
void ResetEditorTargetViewport() |
Resets the TargetViewport | Widgets/VPFullScreenUserWidget.h | |
void SetCustomPostProcessSettingsSource
(
TWeakObjectPtr< UObject > InCustomPostProcessSettingsSource |
If using EVPWidgetDisplayType::PostProcessWithBlendMaterial, you can specify a custom post process settings that should be modified. | Widgets/VPFullScreenUserWidget.h | |
void SetDisplayTypes
(
EVPWidgetDisplayType InEditorDisplayType, |
Sets the way the widget is supposed to be displayed | Widgets/VPFullScreenUserWidget.h | |
void SetEditorTargetViewport
(
TWeakPtr< FSceneViewport > InTargetViewport |
Sets the TargetViewport to use on both the Viewport and the PostProcess class. | Widgets/VPFullScreenUserWidget.h | |
void SetWidgetClass
(
TSubclassOf< UUserWidget > InWidgetClass |
Sets the widget class to be displayed. | Widgets/VPFullScreenUserWidget.h | |
bool ShouldDisplay
(
UWorld* World |
Widgets/VPFullScreenUserWidget.h | ||
virtual void Tick
(
float DeltaTime |
Widgets/VPFullScreenUserWidget.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
Widgets/VPFullScreenUserWidget.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Widgets/VPFullScreenUserWidget.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVector2D FindSceneViewportSize() |
Widgets/VPFullScreenUserWidget.h | ||
float GetViewportDPIScale() |
Widgets/VPFullScreenUserWidget.h | ||
bool InitWidget() |
Widgets/VPFullScreenUserWidget.h | ||
void ReleaseWidget() |
Widgets/VPFullScreenUserWidget.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool DoesDisplayTypeUsePostProcessSettings
(
EVPWidgetDisplayType Type |
Widgets/VPFullScreenUserWidget.h |