Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > VPUtilities > UVPFullScreenUserWidget

Light Theme

Dark Theme

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.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVPFullScreenUserWidget

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Meta=(ShowOnlyInnerProperties))
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

	Name	Description
EVPWidgetDispla...	EditorDisplayType	The display type when the world is an editor world.
EVPWidgetDispla...	GameDisplayType	The display type when the world is a game world.
EVPWidgetDispla...	PIEDisplayType	The display type when the world is a PIE world.
FVPFullScreenUs...	PostProcessDisplayType	Behavior when the widget should be display by a post process.
TWeakPtr< SLeve...	TargetViewport	If set, use this viewport instead of GetFirstActiveLevelViewport()
FVPFullScreenUs...	ViewportDisplayType	Behavior when the widget should be display by the slate attached to the viewport.
TSubclassOf< UU...	WidgetClass	The class of User Widget to create and display an instance of

Constructors

	Name	Description
	UVPFullScreenUserWidget ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	Display ( UWorld* World )
FVector2D	FindSceneViewportSize()
EVPWidgetDis...	GetDisplayType ( UWorld* World )
float	GetViewportDPIScale()
UUserWidget ...	GetWidget()	Get a pointer to the inner widget.
void	Hide()
void	InitWidget()
bool	IsDisplayed()
void	ReleaseWidget()
void	ResetAllTargetViewports()	Resets the TargetViewport
void	SetAllTargetViewports ( TWeakPtr< SLevelViewport > InTarget... )	Sets the TargetViewport to use on both the Viewport and the PostProcess class
void	SetDisplayTypes ( EVPWidgetDisplayType InEditorDispla..., EVPWidgetDisplayType InGameDisplayT..., EVPWidgetDisplayType InPIEDisplayTy... )
bool	ShouldDisplay ( UWorld* World )
void	Tick ( float DeltaTime )

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss