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 > Images > SLayeredImage

Light Theme

Dark Theme

SLayeredImage

A slate widget to draw an arbitrary number of images over top of each other

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SLeafWidget

SImage

SLayeredImage

References

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

Syntax

class SLayeredImage : public SImage

Remarks

A slate widget to draw an arbitrary number of images over top of each other

Functions

	Name	Description
void	AddLayer ( TAttribute< const FSlateBrush*... )	Adds a new layer to the top of the Image given a brush and color. Use White as the default color.
void	AddLayer ( TAttribute< const FSlateBrush*..., TAttribute< FSlateColor > Color )	Adds a new layer to the top of the Image given a brush and color
void	Construct ( const FArguments& InArgs, const TArray< ImageLayer >& InLaye... )	Constructor that adds InLayers on top of the base image
void	Construct ( const FArguments& InArgs, TArray< ImageLayer >&& InLayers )	Constructor that adds InLayers on top of the base image
void	Construct ( const FArguments& InArgs, int32 NumLayers )	Constructor that adds NumLayers blank layers on top of the image for later use
void	Construct ( const FArguments& InArgs, const FSlateIcon& InIcon )	Constructor that sets the base image and any overlay layers defined in the Slate icon
void	Construct ( const FArguments& InArgs, TAttribute< const FSlateBrush*..., TAttribute< FSlateColor > Color )	Constructor that adds a single layer on top of the base image
int32	GetNumLayers()	Returns the total number of layers, including the base image.
bool	IsValidIndex ( int32 Index )	Determines whether a Layer exists at the given index
void	RemoveAllLayers()	Removes all layers
void	SetFromSlateIcon ( const FSlateIcon& InIcon )	Sets the base image and any overlay layers defined in the Slate icon. removes all layers
void	SetLayerBrush ( int32 Index, TAttribute< const FSlateBrush*... )	Sets the brush for a given layer, if it exists
void	SetLayerColor ( int32 Index, TAttribute< FSlateColor > Color )	Sets the color for a given layer, if it exists.

Overridden from SWidget

		Name	Description
	int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	Overwritten from SWidget.

Typedefs

Name	Description
BrushAttributeType
ColorAttributeType
ImageLayer
InnerImageLayerType

Deprecated Functions

		Name	Description
	const FSlate...	GetLayerBrush ( int32 Index )	GetLayerBrush is not accessible anymore since it's attribute value may not have been updated yet.
	FSlateColor	GetLayerColor ( int32 Index )	GetLayerColor is not accessible anymore since it's attribute value may not have been updated yet.