USlateBlueprintLibrary

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

UMG

Header

/Engine/Source/Runtime/UMG/Public/Blueprint/SlateBlueprintLibrary.h

Include

#include "Blueprint/SlateBlueprintLibrary.h"

Syntax

class USlateBlueprintLibrary : public UBlueprintFunctionLibrary

Constructors

Name Description

Public function

USlateBlueprintLibrary

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

FVector2D

 

AbsoluteToLocal

(
    const FGeometry& Geometry,
    FVector2D AbsoluteCoordinate
)

Absolute coordinates could be either desktop or window space depending on what space the root of the widget hierarchy is in.

Public function Static

void

 

AbsoluteToViewport

(
    UObject* WorldContextObject,
    FVector2D AbsoluteDesktopCoordinate,
    FVector2D& PixelPosition,
    FVector2D& ViewportPosition
)

Translates absolute coordinate in desktop space of the geometry provided into local viewport coordinates.

Public function Static

bool

 

EqualEqual_SlateBrush

(
    const FSlateBrush& A,
    const FSlateBrush& B
)

Returns whether brushes A and B are identical.

Public function Static

FVector2D

 

GetAbsoluteSize

(
    const FGeometry& Geometry
)

Returns the size of the geometry in absolute space.

Public function Static

FVector2D

 

GetLocalSize

(
    const FGeometry& Geometry
)

Returns the size of the geometry in local space.

Public function Static

FVector2D

 

GetLocalTopLeft

(
    const FGeometry& Geometry
)

Returns the local top/left of the geometry in local space.

Public function Static

bool

 

IsUnderLocation

(
    const FGeometry& Geometry,
    const FVector2D& AbsoluteCoordinat...
)

Absolute coordinates could be either desktop or window space depending on what space the root of the widget hierarchy is in.

Public function Static

FVector2D

 

LocalToAbsolute

(
    const FGeometry& Geometry,
    FVector2D LocalCoordinate
)

Translates local coordinates into absolute coordinates

Public function Static

void

 

LocalToViewport

(
    UObject* WorldContextObject,
    const FGeometry& Geometry,
    FVector2D LocalCoordinate,
    FVector2D& PixelPosition,
    FVector2D& ViewportPosition
)

Translates local coordinate of the geometry provided into local viewport coordinates.

Public function Static

void

 

ScreenToViewport

(
    UObject* WorldContextObject,
    FVector2D ScreenPosition,
    FVector2D& ViewportPosition
)

Translates a screen position in pixels into the local space of the viewport widget.

Public function Static

void

 

ScreenToWidgetAbsolute

(
    UObject* WorldContextObject,
    FVector2D ScreenPosition,
    FVector2D& AbsoluteCoordinate,
    bool bIncludeWindowPosition
)

Translates a screen position in pixels into absolute application coordinates.

Public function Static

void

 

ScreenToWidgetLocal

(
    UObject* WorldContextObject,
    const FGeometry& Geometry,
    FVector2D ScreenPosition,
    FVector2D& LocalCoordinate,
    bool bIncludeWindowPosition
)

Translates a screen position in pixels into the local space of a widget with the given geometry.

Public function Static

float

 

TransformScalarAbsoluteToLocal

(
    const FGeometry& Geometry,
    float AbsoluteScalar
)

Public function Static

float

 

TransformScalarLocalToAbsolute

(
    const FGeometry& Geometry,
    float LocalScalar
)

Public function Static

FVector2D

 

TransformVectorAbsoluteToLocal

(
    const FGeometry& Geometry,
    FVector2D AbsoluteVector
)

Public function Static

FVector2D

 

TransformVectorLocalToAbsolute

(
    const FGeometry& Geometry,
    FVector2D LocalVector
)