Navigation
API > API/Runtime > API/Runtime/SlateCore
Implements a widget that displays an image with a desired width and height.
| Name | SImage |
| Type | class |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Widgets/Images/SImage.h |
| Include Path | #include "Widgets/Images/SImage.h" |
Syntax
class SImage : public SLeafWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SLeafWidget → SImage
- FSlateControlledConstruction → SWidget → SLeafWidget → SImage
Derived Classes
SImage derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SImage() |
Constructor | Widgets/Images/SImage.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~SImage() |
Widgets/Images/SImage.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PrivateParentType | SLeafWidget | Widgets/Images/SImage.h | |
| PrivateThisType | SImage | Widgets/Images/SImage.h | |
| Super | SLeafWidget | Widgets/Images/SImage.h | |
| ThisClass | SImage | Widgets/Images/SImage.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ColorAndOpacityAttribute | TSlateAttribute< FSlateColor > | Color and opacity scale for this ImageAttribute | Widgets/Images/SImage.h | |
| DesiredSizeOverrideAttribute | TSlateAttribute< TOptional< FVector2D > > | When specified, ignore the content's desired size and report the.HeightOverride as the Box's desired height. | Widgets/Images/SImage.h | |
| ImageAttribute | TSlateAttribute< const FSlateBrush * > | The slate brush to draw for the ImageAttribute that we can invalidate. | Widgets/Images/SImage.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Construct this widget | Widgets/Images/SImage.h | |
void FlipForRightToLeftFlowDirection
(
bool InbFlipForRightToLeftFlowDirection |
Set FlipForRightToLeftFlowDirection | Widgets/Images/SImage.h | |
void InvalidateImage() |
Invalidate the Image | Widgets/Images/SImage.h | |
void SetColorAndOpacity
(
TAttribute< FSlateColor > InColorAndOpacity |
Set the ColorAndOpacity attribute | Widgets/Images/SImage.h | |
void SetColorAndOpacity
(
FLinearColor InColorAndOpacity |
See the ColorAndOpacity attribute | Widgets/Images/SImage.h | |
void SetDesiredSizeOverride
(
TAttribute< TOptional< FVector2D > > InDesiredSizeOverride |
Set SizeOverride attribute | Widgets/Images/SImage.h | |
void SetImage
(
TAttribute< const FSlateBrush* > InImage |
Set the Image attribute | Widgets/Images/SImage.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< FSlateAccessibleWidget > CreateAccessibleWidget() |
Widgets/Images/SImage.h | ||
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Overwritten from SWidget. | Widgets/Images/SImage.h |
Overridden from FSlateControlledConstruction
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FSlateWidgetClassData & GetWidgetClass() |
Widgets/Images/SImage.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSlateAttributeRef< FSlateColor > GetColorAndOpacityAttribute() |
Widgets/Images/SImage.h | ||
TSlateAttributeRef< TOptional< FVector2D > > GetDesiredSizeOverrideAttribute() |
Widgets/Images/SImage.h | ||
TSlateAttributeRef< const FSlateBrush * > GetImageAttribute() |
Widgets/Images/SImage.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
Overwritten from SWidget. | Widgets/Images/SImage.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FSlateWidgetClassData & GetPrivateWidgetClass() |
Widgets/Images/SImage.h | ||
static void PrivateRegisterAttributes
(
FSlateAttributeInitializer& |
Widgets/Images/SImage.h | ||
static const FSlateWidgetClassData & StaticWidgetClass() |
Widgets/Images/SImage.h |