Layout

Choose your operating system:

Windows

macOS

Linux

Classes

Name

Description

Public struct

AlignmentArrangeResult

Public struct

EVisibility

Is an entity visible?

Public class

FArrangedChildren

The results of an ArrangeChildren are always returned as an FArrangedChildren.

Public class

FArrangedWidget

A pair: Widget and its Geometry.

Public class

FBasicLayoutWidgetSlot

The basic slot that can be used by layout.

Public class

FChildren

FChildren is an interface that must be implemented by all child containers.

Public struct

FClipStateHandle

Public class

FCombinedChildren

Occasionally you may need to keep multiple discrete sets of children with differing slot requirements.

Public struct

FGeometry

Represents the position, size, and absolute position of a Widget in Slate.

Public class

FLayoutGeometry

Public class

FLayoutLocalization

Class containing utilities for getting layout localization information.

Public struct

FMargin

Describes the space around a Widget.

Public class

FNoChildren

Widgets with no Children can return an instance of FNoChildren.

Public struct

FPaintGeometry

A Paint geometry contains the window-space (draw-space) info to draw an element on the screen.

Public class

FSingleWidgetChildrenWithBasicLayoutSlot

Public class

FSingleWidgetChildrenWithSlot

A FChildren that has only one child.

Public class

FSlateCachedClipState

Public class

FSlateClippingManager

The clipping manager maintain the running clip state.

Public class

FSlateClippingState

Captures everything about a single draw calls clipping state.

Public class

FSlateClippingZone

The Clipping Zone represents some arbitrary plane segment that can be used to clip the geometry in Slate.

Public class

FSlateRect

A rectangle defined by upper-left and lower-right corners.

Public struct

FSlateRotatedRect

Stores a rectangle that has been transformed by an arbitrary render transform.

Public class

FWeakWidgetPath

Just like a WidgetPath, but uses weak pointers and does not store geometry.

Public struct

FWidgetAndPointer

Public struct

FWidgetMatcher

Matches widgets against InWidget

Public class

FWidgetPath

A widget path is a vertical slice through the tree.

Public struct

GetChildAlignment

Gets the alignment of an axis-agnostic int32 so that we can do alignment on an axis without caring about its orientation

Public class

TAlignmentSingleWidgetSlotMixin

Mixin to add the alignment functionality to a base slot that is also a single children.

Public class

TAlignmentWidgetSlotMixin

Mixin to add the alignment functionality to a base slot.

Public class

TBasicLayoutWidgetSlot

A templated basic slot that can be used by layout.

Public class

TOneDynamicChild

Required to implement GetChildren() in a way that can dynamically return the currently active child.

Public class

TPaddingSingleWidgetSlotMixin

Mixin to add the padding functionality to a base slot that is also a single children.

Public class

TPaddingWidgetSlotMixin

Mixin to add the padding functionality to a base slot.

Public class

TPanelChildren

A slot that support alignment of content and padding A generic FChildren that stores children along with layout-related information.

Public class

TPanelChildrenConstIterator

Public class

TSingleWidgetChildrenWithBasicLayoutSlot

A FChildren that has only one child and support alignment and padding.

Public class

TSingleWidgetChildrenWithSlot

A FChildren that has only one child and can take a templated slot.

Public class

TSlotlessChildren

Some advanced widgets contain no layout information, and do not require slots.

Public class

TWeakChild

For widgets that do not own their content, but are responsible for presenting someone else's content.

Public class

TWidgetSlotWithAttributeSupport

A base slot that supports TSlateContainedAttribute.

Enums

Name

Description

Public enum

EClippingFlags

Indicates the method of clipping that should be used on the GPU.

Public enum

EClippingMethod

Indicates the method of clipping that should be used on the GPU.

Public enum

EFlowDirection

Widgets may need to flow left or right depending upon the current culture/localization that's active.

Public enum

EFlowDirectionPreference

Public enum

EWidgetClipping

This enum controls clipping of widgets in Slate.

Functions

Name Description

Public function Static

AlignmentArr...

 

AlignChild

(
    float AllottedSize,
    const SlotType& ChildToArrange,
    const FMargin& SlotPadding,
    const float& ContentScale,
    bool bClampToParent
)

Public function Static

AlignmentArr...

 

AlignChild

(
    EFlowDirection InLayoutFlow,
    float AllottedSize,
    float ChildDesiredSize,
    const SlotType& ChildToArrange,
    const FMargin& SlotPadding,
    const float& ContentScale,
    bool bClampToParent
)

Helper method to BoxPanel::ArrangeChildren.

Public function Static

AlignmentArr...

 

AlignChild

(
    EFlowDirection InLayoutFlow,
    float AllottedSize,
    const SlotType& ChildToArrange,
    const FMargin& SlotPadding,
    const float& ContentScale,
    bool bClampToParent
)

Public function Static

AlignmentArr...

 

AlignChild

(
    float AllottedSize,
    float ChildDesiredSize,
    const SlotType& ChildToArrange,
    const FMargin& SlotPadding,
    const float& ContentScale,
    bool bClampToParent
)

Public function Static

void

 

ArrangeSingleChild

(
    EFlowDirection InFlowDirection,
    const FGeometry& AllottedGeometry,
    FArrangedChildren& ArrangedChildre...,
    const SlotType& ChildSlot,
    const FVector2D& ContentScale
)

Public function Static

void

 

ArrangeSingleChild

(
    EFlowDirection InFlowDirection,
    const FGeometry& AllottedGeometry,
    FArrangedChildren& ArrangedChildre...,
    const SlotType& ChildSlot,
    const TAttribute< FVector2D >& Con...
)

Public function Static

void

 

ArrangeSingleChild

(
    const FGeometry& AllottedGeometry,
    FArrangedChildren& ArrangedChildre...,
    const SlotType& ChildSlot,
    const FVector2D& ContentScale
)

Public function Static

void

 

ArrangeSingleChild

(
    const FGeometry& AllottedGeometry,
    FArrangedChildren& ArrangedChildre...,
    const SlotType& ChildSlot,
    const TAttribute< FVector2D >& Con...
)

Arrange a ChildSlot within the AllottedGeometry and populate ArrangedChildren with the arranged result.

Public function

FVector2D

 

ComputePopupFitInRect

(
    const FSlateRect& InAnchor,
    const FSlateRect& PopupRect,
    const EOrientation& Orientation,
    const FSlateRect& RectToFit
)

Given information about a popup and the space available for displaying that popup, compute best placement for it.

Public function

class

 

deprecated

(
    "TSupportsOneChildMixin is deprecat...,
    otherwise your project will no long...
)

Widgets that will only have one child.

Public function

class

 

deprecated

(
    "Renamed TSupportsContentPaddingMix...,
    otherwise your project will no long...
)

Public function

class

 

deprecated

(
    "Renamed TSupportsContentPaddingMix...,
    otherwise your project will no long...
)

Public function

uint32

 

GetTypeHash

(
    const FSlateClippingZone& Zone
)

Public function Static

FMargin

 

LayoutPaddingWithFlow

(
    EFlowDirection InLayoutFlow,
    const FMargin& InPadding
)

Public function

constexpr bo...

 

operator!

(
    EClippingFlags E
)

Public function

constexpr EC...

 

operator&

(
    EClippingFlags Lhs,
    EClippingFlags Rhs
)

Public function

EClippingFla...

 

operator&=

(
    EClippingFlags& Lhs,
    EClippingFlags Rhs
)

Public function

constexpr EC...

 

operator^

(
    EClippingFlags Lhs,
    EClippingFlags Rhs
)

Public function

EClippingFla...

 

operator^=

(
    EClippingFlags& Lhs,
    EClippingFlags Rhs
)

Public function

constexpr EC...

 

operator|

(
    EClippingFlags Lhs,
    EClippingFlags Rhs
)

Public function

EClippingFla...

 

operator|=

(
    EClippingFlags& Lhs,
    EClippingFlags Rhs
)

Public function

constexpr EC...

 

operator~

(
    EClippingFlags E
)

Public function

FSlateRect

 

TransformRect

(
    const TransformType& Transform,
    const FSlateRect& Rect
)

Transforms a rect by the given transform, ensuring the rect does not get inverted.

Public function

FSlateRotate...

 

TransformRect

(
    const TransformType& Transform,
    const FSlateRotatedRect& Rect
)

Transforms a rect by the given transform.

Variables

Name Description

Public variable

EFlowDirection

 

GSlateFlowDirection

Public variable

int32

 

GSlateFlowDirectionShouldFollowCultureByDefault