UWidgetLayoutLibrary

class UMG Blueprint Since 4.7

Inherits: UObjectBase › UObjectBaseUtility › UObject › UBlueprintFunctionLibrary › UWidgetLayoutLibrary

#include "Blueprint/WidgetLayoutLibrary.h"

Description

A Blueprint function library providing utility functions for querying viewport size, DPI scale, mouse position, and for projecting world-space locations into widget space. All functions are static and cosmetic (client-side only).

Caveats & Gotchas

• Most functions are marked BlueprintCosmetic and will not execute on a dedicated server — guard server-side code accordingly.
• DPI-scaled positions from this library are already in widget space; mixing them with raw screen-pixel coordinates will produce incorrect results.

Functions (8)

Viewport 8

Viewport

8 ▼

Access	Type	Name	Description
public	function	UWidgetLayoutLibrary::GetMousePositionOnViewport	Returns the current mouse cursor position in the local coordinate space of the viewport widget.
public	function	UWidgetLayoutLibrary::GetViewportSize	Returns the current size of the game viewport in pixels.
public	function	UWidgetLayoutLibrary::GetMousePositionScaledByDPI	Returns the player controller's mouse cursor position scaled by (1/DPI).
public	function	UWidgetLayoutLibrary::GetPlayerScreenWidgetGeometry	Returns the FGeometry of the player-screen widget container for a specific player.
public	function	UWidgetLayoutLibrary::GetViewportScale	Returns the DPI scale factor currently applied to the game viewport.
public	function	UWidgetLayoutLibrary::GetViewportWidgetGeometry	Returns the FGeometry of the root viewport widget — the container that holds all widgets added via AddToViewport.
public	function	UWidgetLayoutLibrary::ProjectWorldLocationToWidgetPosition	Projects a world-space 3D location into 2D widget screen space for a specific player, accounting for DPI scaling and optional quality scaling.
public	function	UWidgetLayoutLibrary::GetMousePositionOnPlatform	Returns the platform mouse cursor position in absolute desktop coordinates, independent of the game window.

Version History

Introduced in: 4.7

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?