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 > UWidgetLayoutLibrary::GetMousePositionScaledByDPI

Light Theme

Dark Theme

UWidgetLayoutLibrary::GetMousePositionScaledByDPI

Gets the mouse position of the player controller, scaled by the DPI.

Windows

MacOS

Linux

Deprecated

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.

References

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

Syntax

static bool GetMousePositionScaledByDPI
(
    APlayerController * Player,
    float & LocationX,
    float & LocationY
)

Remarks

Gets the mouse position of the player controller, scaled by the DPI. If you're trying to go from raw mouse screenspace coordinates to fullscreen widget space, you'll need to transform the mouse into DPI Scaled space. This function performs that scaling.

MousePositionScaledByDPI = MousePosition * (1 / ViewportScale).

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

Take our survey

Dismiss