Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. SLayeredImage

SLayeredImage

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

API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/Widgets > API/Runtime/SlateCore/Widgets/Images

Inheritance Hierarchy

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

  Type Name Description
Public function void

AddLayer ( TAttribute< const FSlateBrush* > Brush
)

 Adds a new layer to the top of the Image given a brush and color. Use White as the default color.
Public function void

AddLayer ( TAttribute< const FSlateBrush* > Brush,
TAttribute< FSlateColor > Color
)

 Adds a new layer to the top of the Image given a brush and color
Public function void

Construct ( const FArguments& InArgs,
const TArray< ImageLayer >& InLayers
)

 Constructor that adds InLayers on top of the base image
Public function void

Construct ( const FArguments& InArgs,
TArray< ImageLayer >&& InLayers
)

 Constructor that adds InLayers on top of the base image
Public function void

Construct ( const FArguments& InArgs,
int32 NumLayers
)

 Constructor that adds NumLayers blank layers on top of the image for later use
Public function void

Construct ( const FArguments& InArgs,
const FSlateIcon& InIcon
)

 Constructor that sets the base image and any overlay layers defined in the Slate icon
Public function void

Construct ( const FArguments& InArgs,
TAttribute< const FSlateBrush* > Brush,
TAttribute< FSlateColor > Color
)

 Constructor that adds a single layer on top of the base image
Public function Const int32 Returns the total number of layers, including the base image.
Public function Const bool

IsValidIndex ( int32 Index
)

 Determines whether a Layer exists at the given index
Public function void Removes all layers
Public function void

SetFromSlateIcon ( const FSlateIcon& InIcon
)

 Sets the base image and any overlay layers defined in the Slate icon. Note: removes all layers
Public function void

SetLayerBrush ( int32 Index,
TAttribute< const FSlateBrush* > Brush
)

 Sets the brush for a given layer, if it exists
Public function void

SetLayerColor ( int32 Index,
TAttribute< FSlateColor > Color
)

 Sets the color for a given layer, if it exists.

Overridden from SWidget

  Type Name Description
Public function Virtual Const int32

OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
)

 Overwritten from SWidget.

Typedefs

Name Description
BrushAttributeType  
ColorAttributeType  
ImageLayer  
InnerImageLayerType  

Deprecated Functions

  Type Name Description
Public function Const const FSlateBrush *

GetLayerBrush ( int32 Index
)

 GetLayerBrush is not accessible anymore since it's attribute value may not have been updated yet.
Public function Const FSlateColor

GetLayerColor ( int32 Index
)

 GetLayerColor is not accessible anymore since it's attribute value may not have been updated yet.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page