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 > Runtime > UMG > Blueprint > UWidgetLayoutLibrary

Light Theme

Dark Theme

UWidgetLayoutLibrary

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintFunctionLibrary

UWidgetLayoutLibrary

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Blueprint/WidgetLayoutLibrary.h
Include	#include "Blueprint/WidgetLayoutLibrary.h"

Syntax

class UWidgetLayoutLibrary : public UBlueprintFunctionLibrary

Constructors

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

Functions

	Name	Description
FVector2D	GetMousePositionOnPlatform()	Gets the platform's mouse cursor position. This is the 'absolute' desktop location of the mouse.
FVector2D	GetMousePositionOnViewport ( UObject* WorldContextObject )	Gets the platform's mouse cursor position in the local space of the viewport widget.
FGeometry	GetPlayerScreenWidgetGeometry ( APlayerController* PlayerContr... )	Gets the geometry of the widget holding all widgets added to the "Player Screen".
float	GetViewportScale ( UObject* WorldContextObject )	Gets the current DPI Scale being applied to the viewport and all the Widgets.
float	GetViewportScale ( UGameViewportClient* ViewportC... )	Gets the current DPI Scale being applied to the viewport and all the Widgets.
FVector2D	GetViewportSize ( UObject* WorldContextObject )	Gets the size of the game viewport.
FGeometry	GetViewportWidgetGeometry ( UObject* WorldContextObject )	Gets the geometry of the widget holding all widgets added to the "Viewport".
bool	ProjectWorldLocationToWidgetPosition ( APlayerController* PlayerContr..., FVector WorldLocation, FVector2D& ScreenPosition, bool bPlayerViewportRelative )	Gets the projected world to screen position for a player, then converts it into a widget position, which takes into account any quality scaling.
bool	ProjectWorldLocationToWidgetPositionWithDistance ( APlayerController* PlayerContr..., FVector WorldLocation, FVector& ScreenPosition, bool bPlayerViewportRelative )	Convert a World Space 3D position into a 2D Widget Screen Space position, with distance from the camera the Z component.
void	RemoveAllWidgets ( UObject* WorldContextObject )	Removes all widgets from the viewport.
UBorderSlot ...	SlotAsBorderSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Border Slot, allowing you to manipulate layout information.
UCanvasPanel...	SlotAsCanvasSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Canvas Slot, allowing you to manipulate layout information.
UGridSlot &#...	SlotAsGridSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Grid Slot, allowing you to manipulate layout information.
UHorizontalB...	SlotAsHorizontalBoxSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Horizontal Box Slot, allowing you to manipulate its information.
UOverlaySlot...	SlotAsOverlaySlot ( UWidget* Widget )	Gets the slot object on the child widget as a Overlay Slot, allowing you to manipulate layout information.
USafeZoneSlo...	SlotAsSafeBoxSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Safe Box Slot, allowing you to manipulate its information.
UScaleBoxSlo...	SlotAsScaleBoxSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Scale Box Slot, allowing you to manipulate its information.
UScrollBoxSl...	SlotAsScrollBoxSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Scroll Box Slot, allowing you to manipulate its information.
USizeBoxSlot...	SlotAsSizeBoxSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Size Box Slot, allowing you to manipulate its information.
UUniformGrid...	SlotAsUniformGridSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Uniform Grid Slot, allowing you to manipulate layout information.
UVerticalBox...	SlotAsVerticalBoxSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Vertical Box Slot, allowing you to manipulate its information.
UWidgetSwitc...	SlotAsWidgetSwitcherSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Widget Switcher Slot, allowing you to manipulate its information.
UWrapBoxSlot...	SlotAsWrapBoxSlot ( UWidget* Widget )	Gets the slot object on the child widget as a Wrap Box Slot, allowing you to manipulate its information.

Deprecated Functions

		Name	Description
	bool	GetMousePositionScaledByDPI ( APlayerController* Player, float& LocationX, float& LocationY )	Use GetMousePositionOnViewport() instead. Optionally and for more options, you can use GetViewportWidgetGeometry and GetPlayerScreenWidgetGeometry are newly introduced to give you the geometry of the viewport and the player screen for widgets to help convert between spaces.

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

Take our survey

Dismiss