Slate Namespace Reference

Functions
SlateBrush
bool	EqualEqual_SlateBrush (FSlateBrush A, FSlateBrush B)
	Returns whether brushes A and B are identical.
User Interface|Geometry
void	AbsoluteToViewport (FVector2D AbsoluteDesktopCoordinate, FVector2D &PixelPosition, FVector2D &ViewportPosition)
	Translates absolute coordinate in desktop space of the geometry provided into local viewport coordinates.
void	LocalToViewport (FGeometry Geometry, FVector2D LocalCoordinate, FVector2D &PixelPosition, FVector2D &ViewportPosition)
	Translates local coordinate of the geometry provided into local viewport coordinates.
FVector2D	GetAbsoluteSize (FGeometry Geometry)
	Returns the size of the geometry in absolute space.
FVector2D	GetLocalSize (FGeometry Geometry)
	Returns the size of the geometry in local space.
FVector2D	GetLocalTopLeft (FGeometry Geometry)
	Returns the local top/left of the geometry in local space.
bool	IsUnderLocation (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.
FVector2D	LocalToAbsolute (FGeometry Geometry, FVector2D LocalCoordinate)
	Translates local coordinates into absolute coordinates.
FVector2D	AbsoluteToLocal (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.
void	ScreenToViewport (FVector2D ScreenPosition, FVector2D &ViewportPosition)
	Translates a screen position in pixels into the local space of the viewport widget.
void	ScreenToWidgetAbsolute (FVector2D ScreenPosition, FVector2D &AbsoluteCoordinate, bool bIncludeWindowPosition=false)
	Translates a screen position in pixels into absolute application coordinates. If bIncludeWindowPosition is true, then this method will also remove the game window's position (useful when in windowed mode).
void	ScreenToWidgetLocal (FGeometry Geometry, FVector2D ScreenPosition, FVector2D &LocalCoordinate, bool bIncludeWindowPosition=false)
	Translates a screen position in pixels into the local space of a widget with the given geometry. If bIncludeWindowPosition is true, then this method will also remove the game window's position (useful when in windowed mode).
float32	TransformScalarAbsoluteToLocal (FGeometry Geometry, float32 AbsoluteScalar)
float32	TransformScalarLocalToAbsolute (FGeometry Geometry, float32 LocalScalar)
FVector2D	TransformVectorAbsoluteToLocal (FGeometry Geometry, FVector2D AbsoluteVector)
FVector2D	TransformVectorLocalToAbsolute (FGeometry Geometry, FVector2D LocalVector)

Function Documentation

AbsoluteToLocal()

FVector2D AbsoluteToLocal	(	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.

Returns

Transforms AbsoluteCoordinate into the local space of this Geometry.

AbsoluteToViewport()

void AbsoluteToViewport	(	FVector2D	AbsoluteDesktopCoordinate,
		FVector2D &	PixelPosition,
		FVector2D &	ViewportPosition )

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

Parameters

PixelPosition	The position in the game's viewport, usable for line traces and other uses where you need a coordinate in the space of viewport resolution units.
ViewportPosition	The position in the space of other widgets in the viewport. Like if you wanted to add another widget to the viewport at the same position in viewport space as this location, this is what you would use.

EqualEqual_SlateBrush()

bool EqualEqual_SlateBrush	(	FSlateBrush	A,
		FSlateBrush	B )

Returns whether brushes A and B are identical.

GetAbsoluteSize()

FVector2D GetAbsoluteSize

(

FGeometry

Geometry

)

Returns the size of the geometry in absolute space.

GetLocalSize()

FVector2D GetLocalSize

(

FGeometry

Geometry

)

Returns the size of the geometry in local space.

GetLocalTopLeft()

FVector2D GetLocalTopLeft

(

FGeometry

Geometry

)

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

IsUnderLocation()

bool IsUnderLocation	(	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.

Returns

true if the provided location in absolute coordinates is within the bounds of this geometry.

LocalToAbsolute()

FVector2D LocalToAbsolute	(	FGeometry	Geometry,
		FVector2D	LocalCoordinate )

Translates local coordinates into absolute coordinates.

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

Returns

Absolute coordinates

LocalToViewport()

void LocalToViewport	(	FGeometry	Geometry,
		FVector2D	LocalCoordinate,
		FVector2D &	PixelPosition,
		FVector2D &	ViewportPosition )

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

Parameters

PixelPosition	The position in the game's viewport, usable for line traces and other uses where you need a coordinate in the space of viewport resolution units.
ViewportPosition	The position in the space of other widgets in the viewport. Like if you wanted to add another widget to the viewport at the same position in viewport space as this location, this is what you would use.

ScreenToViewport()

void ScreenToViewport	(	FVector2D	ScreenPosition,
		FVector2D &	ViewportPosition )

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

ScreenToWidgetAbsolute()

void ScreenToWidgetAbsolute	(	FVector2D	ScreenPosition,
		FVector2D &	AbsoluteCoordinate,
		bool	bIncludeWindowPosition = false )

Translates a screen position in pixels into absolute application coordinates. If bIncludeWindowPosition is true, then this method will also remove the game window's position (useful when in windowed mode).

ScreenToWidgetLocal()

void ScreenToWidgetLocal	(	FGeometry	Geometry,
		FVector2D	ScreenPosition,
		FVector2D &	LocalCoordinate,
		bool	bIncludeWindowPosition = false )

Translates a screen position in pixels into the local space of a widget with the given geometry. If bIncludeWindowPosition is true, then this method will also remove the game window's position (useful when in windowed mode).

TransformScalarAbsoluteToLocal()

float32 TransformScalarAbsoluteToLocal	(	FGeometry	Geometry,
		float32	AbsoluteScalar )

TransformScalarLocalToAbsolute()

float32 TransformScalarLocalToAbsolute	(	FGeometry	Geometry,
		float32	LocalScalar )

TransformVectorAbsoluteToLocal()

FVector2D TransformVectorAbsoluteToLocal	(	FGeometry	Geometry,
		FVector2D	AbsoluteVector )

TransformVectorLocalToAbsolute()

FVector2D TransformVectorLocalToAbsolute	(	FGeometry	Geometry,
		FVector2D	LocalVector )