USlateBlueprintLibrary

class UMG Blueprint Since 4.7

Inherits: UObjectBase › UObjectBaseUtility › UObject › UBlueprintFunctionLibrary

#include "Blueprint/SlateBlueprintLibrary.h"

Description

Blueprint function library exposing Slate geometry and coordinate conversion utilities to Blueprints and C++. Provides the recommended way to translate between local widget space, absolute Slate space, and viewport/screen pixel space.

Caveats & Gotchas

• All functions are static BlueprintPure — they take the geometry as an explicit parameter rather than being called on a widget object. You must have access to the FGeometry of the widget (available in event bindings such as OnMouseMove or via GetCachedGeometry).
• Viewport-relative functions require a WorldContextObject to resolve the current GameViewportClient. In non-game contexts (e.g., editor utility widgets) the viewport may be null, causing no-ops or zero results.

Functions (9)

Geometry 9

Geometry

9 ▼

Access	Type	Name	Description
public	function	USlateBlueprintLibrary::AbsoluteToLocal	Transforms a point from absolute Slate space into a widget's local space.
public	function	USlateBlueprintLibrary::LocalToAbsolute	Transforms a point from a widget's local space into absolute Slate space using the widget's accumulated render transform.
public	function	USlateBlueprintLibrary::LocalToViewport	Converts a local widget coordinate into both game-viewport pixel space and UMG viewport widget space in a single call.
public	function	USlateBlueprintLibrary::ScreenToViewport	Converts a screen-pixel coordinate directly into UMG viewport widget space, suitable for positioning widgets added via AddToViewport at the same logical location.
public	function	USlateBlueprintLibrary::AbsoluteToViewport	Converts an absolute desktop-space coordinate into both viewport pixel space and UMG viewport widget space.
public	function	USlateBlueprintLibrary::Scalar_AbsoluteToLocal	Converts a scalar value from absolute space to local space by dividing by the geometry's accumulated layout scale.
public	function	USlateBlueprintLibrary::ScreenToWidgetAbsolute	Converts a screen-pixel position into absolute Slate application coordinates without knowing the target widget's geometry.
public	function	USlateBlueprintLibrary::ScreenToWidgetLocal	Converts a screen-pixel position (as obtained from OS input or GetMousePosition) into the local space of the given widget's geometry.
public	function	USlateBlueprintLibrary::Vector_LocalToAbsolute	Transforms a direction vector from a widget's local space into absolute (desktop or window) space.

Version History

Introduced in: 4.7

Version	Status	Notes
5.6	stable	TransformScalar* and TransformVector* functions deprecated; replaced by correctly-named Scalar_* and Vector_* variants.
5.5	stable	—

Feedback

Was this helpful?