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 > SlateCore > Widgets > SOverlay

Light Theme

Dark Theme

SOverlay

Implements an overlay widget.

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SPanel

SOverlay

SSynthTooltip

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Widgets/SOverlay.h
Include	#include "Widgets/SOverlay.h"

Syntax

class SOverlay : public SPanel

Remarks

Implements an overlay widget.

Overlay widgets allow for layering several widgets on top of each other. Each slot of an overlay represents a layer that can contain one widget. The slots will be rendered on top of each other in the order they are declared in code.

Usage: SNew(SOverlay)

SOverlay::Slot(SNew(SMyWidget1))
SOverlay::Slot(SNew(SMyWidget2))
SOverlay::Slot(SNew(SMyWidget3))

that SWidget3 will be drawn on top of SWidget2 and SWidget1.

Variables

		Name	Description
	TPanelChildren<...	Children	The SOverlay's slots; each slot contains a child widget.

Constructors

	Name	Description
	SOverlay()

Functions

	Name	Description
FOverlaySlot...	AddSlot ( int32 ZOrder )	Adds a slot at the specified location (ignores Z-order)
void	ClearChildren()	Removes all children from the overlay
void	Construct ( const FArguments& InArgs )	Construct this widget.
int32	GetNumWidgets()	Returns the number of child widgets
bool	RemoveSlot ( TSharedRef< SWidget > Widget )	Removes a widget from this overlay.
void	RemoveSlot ( int32 ZOrder )	Removes a slot at the specified location
FOverlaySlot...	Slot()

Overridden from SWidget

	Name	Description
FVector2D	ComputeDesiredSize ( float )	A Panel's desired size in the space required to arrange of its children on the screen while respecting all of the children's desired sizes and any layout-related options specified by the user.
FChildren &#...	GetChildren()	All widgets must provide a way to access their children in a layout-agnostic way.
void	OnArrangeChildren ( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildre... )	Panels arrange their children in a space described by the AllottedGeometry parameter.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.

Classes

	Name	Description
	FArguments
	FOverlaySlot	A slot that support alignment of content and padding and z-order

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

Take our survey

Dismiss