1. Epic GamesDeveloper
  3. SImage

SImage

Implements a widget that displays an image with a desired width and height.

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/SImage.h
Include #include "Widgets/Images/SImage.h"

Syntax

class SImage : public SLeafWidget

Remarks

Implements a widget that displays an image with a desired width and height.

Variables

  Type Name Description
Protected variable bool bFlipForRightToLeftFlowDirection Flips the image if the localization's flow direction is RightToLeft

Constructors

  Type Name Description
Public function  

SImage ()

 Constructor

Functions

  Type Name Description
Public function void

Construct ( const FArguments& InArgs
)

 Construct this widget
Public function void

FlipForRightToLeftFlowDirection ( bool InbFlipForRightToLeftFlowDirection
)

 Set FlipForRightToLeftFlowDirection
Protected function Const TSlateAttributeRef< FSlateColor >  
Protected function Const TSlateAttributeRef< TOptional< FVector2D > >  
Protected function Const TSlateAttributeRef< const FSlateBrush * >  
Public function void Invalidate the Image
Public function void

SetColorAndOpacity ( TAttribute< FSlateColor > InColorAndOpacity
)

 Set the ColorAndOpacity attribute
Public function void

SetColorAndOpacity ( FLinearColor InColorAndOpacity
)

 See the ColorAndOpacity attribute
Public function void

SetDesiredSizeOverride ( TAttribute< TOptional< FVector2D >> InDesiredSizeOverride
)

 Set SizeOverride attribute
Public function void

SetImage ( TAttribute< const FSlateBrush* > InImage
)

 Set the Image attribute
Public function Static const FSlateWidgetClassData &  

Overridden from SWidget

  Type Name Description
Protected function Virtual Const FVector2D

ComputeDesiredSize ( float
)

 Overwritten from SWidget.
Public function Virtual TSharedRef< FSlateAccessibleWidget >  
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.

Overridden from FSlateControlledConstruction

  Type Name Description
Public function Virtual Const const FSlateWidgetClassData &  

Classes

  Type Name Description
Public struct FArguments    

Typedefs

Name Description
PrivateParentType  
PrivateThisType  
Super  
ThisClass  

Deprecated Variables

  Type Name Description
Protected variable TSlateDeprecatedTAttribute< FSlateColor > ColorAndOpacity Direct access to ColorAndOpacity is now deprecated. Use the setter or getter.
Protected variable TSlateDeprecatedTAttribute< TOptional< FVector2D > > DesiredSizeOverride Direct access to DesiredSizeOverride is now deprecated. Use the setter or getter.
Protected variable FInvalidatableBrushAttribute Image Direct access to Image is now deprecated. Use the setter or getter.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page