Navigation
Unreal Engine C++ API Reference > Runtime > UMG > Components
Inheritance Hierarchy
References
Module | UMG |
Header | /Engine/Source/Runtime/UMG/Public/Components/Image.h |
Include | #include "Components/Image.h" |
Syntax
class UImage : public UWidget
Remarks
The image widget allows you to display a Slate Brush, or texture or material in the UI.
- No Children
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
FGetSlateBrush | BrushDelegate | A bindable delegate for the Image. |
![]() |
FGetLinearColor | ColorAndOpacityDelegate | A bindable delegate for the ColorAndOpacity. |
![]() |
PRAGMA_DISABLE_DEPRECATION_WARNINGSFSlateColor | K2_Cache_ColorAndOpacity | |
![]() |
TSharedPtr< SImage > | MyImage | |
![]() |
FOnPointerEvent | OnMouseButtonDownEvent | |
![]() |
TSharedPtr< FStreamableHandle > | StreamingHandle | |
![]() |
FSoftObjectPath | StreamingObjectPath |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
UImage
(
const FObjectInitializer& ObjectInitializer |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | Called when we need to abort the texture being streamed in. | |
![]() ![]() |
const FSlateBrush * | ConvertImage
(
TAttribute< FSlateBrush > InImageAsset |
Translates the bound brush data and assigns it to the cached brush used by this widget. |
![]() ![]() |
const FSlateBrush & | GetBrush () |
|
![]() ![]() |
const FLinearColor & | ||
![]() |
UMaterialInstanceDynamic * | ||
![]() |
FReply | HandleMouseButtonDown
(
const FGeometry& Geometry, |
|
![]() |
FSlateColor | ||
![]() ![]() |
void | OnImageStreamingComplete
(
TSoftObjectPtr< UObject > LoadedSoftObject |
Called when the image streaming completes. |
![]() ![]() |
void | OnImageStreamingStarted
(
TSoftObjectPtr< UObject > SoftObject |
Called when the image streaming starts, after the other one was cancelled. |
![]() |
void | RequestAsyncLoad
(
TSoftObjectPtr< UObject > SoftObject, |
Called when we need to stream in content. |
![]() ![]() |
void | RequestAsyncLoad
(
TSoftObjectPtr< UObject > SoftObject, |
Called when we need to stream in content. |
![]() ![]() |
void | SetBrush
(
const FSlateBrush& InBrush |
|
![]() ![]() |
void | SetBrushFromAsset
(
USlateBrushAsset* Asset |
|
![]() ![]() |
void | SetBrushFromAtlasInterface
(
TScriptInterface< ISlateTextureAtlasInterface > AtlasRegion, |
Sets the Brush to the specified Atlas Region. |
![]() ![]() |
void | SetBrushFromMaterial
(
UMaterialInterface* Material |
|
![]() ![]() |
void | SetBrushFromSoftMaterial
(
TSoftObjectPtr< UMaterialInterface > SoftMaterial |
|
![]() ![]() |
void | SetBrushFromSoftTexture
(
TSoftObjectPtr< UTexture2D > SoftTexture, |
Sets the Brush to the specified Soft Texture. |
![]() ![]() |
void | SetBrushFromTexture
(
UTexture2D* Texture, |
Sets the Brush to the specified Texture. |
![]() ![]() |
void | SetBrushFromTextureDynamic
(
UTexture2DDynamic* Texture, |
Sets the Brush to the specified Dynamic Texture. |
![]() |
void | SetBrushResourceObject
(
UObject* ResourceObject |
|
![]() |
void | SetBrushTintColor
(
FSlateColor TintColor |
|
![]() |
void | SetColorAndOpacity
(
FLinearColor InColorAndOpacity |
|
![]() |
void | SetDesiredSizeOverride
(
FVector2D DesiredSize |
|
![]() |
void | SetFlipForRightToLeftFlowDirection
(
bool InbFlipForRightToLeftFlowDirection |
|
![]() |
void | SetOpacity
(
float InOpacity |
|
![]() ![]() |
bool |
Overridden from UWidget
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() |
TSharedPtr< SWidget > | Gets the widget that accessibility properties should synchronize to. | |
![]() ![]() |
const FText | Gets the palette category of the widget | |
![]() ![]() |
TSharedRef< SWidget > | Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. | |
![]() ![]() |
void | Applies all properties to the native widget if possible. |
Overridden from UVisual
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | ReleaseSlateResources
(
bool bReleaseChildren |
Deprecated Variables
Type | Name | Description | |
---|---|---|---|
![]() |
bool | bFlipForRightToLeftFlowDirection | Direct access to bFlipForRightToLeftFlowDirection is deprecated. Please use the getter or setter. |
![]() |
FSlateBrush | Brush | Direct access to Brush is deprecated. Please use the getter or setter. |
![]() |
FLinearColor | ColorAndOpacity | Direct access to ColorAndOpacity is deprecated. Please use the getter or setter. |
Deprecated Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | SetBrushSize
(
FVector2D DesiredSize |
Deprecated. Use SetDesiredSizeOverride instead. |