UImage

The image widget allows you to display a Slate Brush, or texture or material in the UI.

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public variable

bool

 

bFlipForRightToLeftFlowDirection

Flips the image if the localization's flow direction is RightToLeft

Public variable

FSlateBrush

 

Brush

Image to draw

Public variable

FGetSlateBrush

 

BrushDelegate

A bindable delegate for the Image.

Public variable

FLinearColor

 

ColorAndOpacity

Color and opacity

Public variable

FGetLinearColor

 

ColorAndOpacityDelegate

A bindable delegate for the ColorAndOpacity.

Protected variable

FSlateColor

 

K2_Cache_ColorAndOpacity

Protected variable

TSharedPtr< SIm...

 

MyImage

Public variable

FOnPointerEvent

 

OnMouseButtonDownEvent

Protected variable

TSharedPtr< FSt...

 

StreamingHandle

Protected variable

FSoftObjectPath

 

StreamingObjectPath

Constructors

Name Description

Public function

UImage

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function Virtual

void

 

CancelImageStreaming()

Called when we need to abort the texture being streamed in.

Protected function Const

const FSlate...

 

ConvertImage

(
    TAttribute< FSlateBrush > InImageAs...
)

Translates the bound brush data and assigns it to the cached brush used by this widget.

Public function

UMaterialIns...

 

GetDynamicMaterial()

Protected function

FReply

 

HandleMouseButtonDown

(
    const FGeometry& Geometry,
    const FPointerEvent& MouseEvent
)

Protected function

FSlateColor

 

K2_Gate_ColorAndOpacity()

Protected function Virtual

void

 

OnImageStreamingComplete

(
    TSoftObjectPtr< UObject > LoadedSof...
)

Called when the image streaming completes.

Protected function Virtual

void

 

OnImageStreamingStarted

(
    TSoftObjectPtr< UObject > SoftObjec...
)

Called when the image streaming starts, after the other one was cancelled.

Protected function

void

 

RequestAsyncLoad

(
    TSoftObjectPtr< UObject > SoftObjec...,
    TFunction< void()>&& Callback
)

Called when we need to stream in content.

Protected function Virtual

void

 

RequestAsyncLoad

(
    TSoftObjectPtr< UObject > SoftObjec...,
    FStreamableDelegate DelegateToCall
)

Called when we need to stream in content.

Public function Virtual

void

 

SetBrush

(
    const FSlateBrush& InBrush
)

Public function Virtual

void

 

SetBrushFromAsset

(
    USlateBrushAsset* Asset
)

Public function Virtual

void

 

SetBrushFromAtlasInterface

(
    TScriptInterface< ISlateTextureAtla...,
    bool bMatchSize
)

Sets the Brush to the specified Atlas Region.

Public function Virtual

void

 

SetBrushFromMaterial

(
    UMaterialInterface* Material
)

Public function Virtual

void

 

SetBrushFromSoftMaterial

(
    TSoftObjectPtr< UMaterialInterface ...
)

Public function Virtual

void

 

SetBrushFromSoftTexture

(
    TSoftObjectPtr< UTexture2D > SoftTe...,
    bool bMatchSize
)

Sets the Brush to the specified Soft Texture.

Public function Virtual

void

 

SetBrushFromTexture

(
    UTexture2D* Texture,
    bool bMatchSize
)

Sets the Brush to the specified Texture.

Public function Virtual

void

 

SetBrushFromTextureDynamic

(
    UTexture2DDynamic* Texture,
    bool bMatchSize
)

Sets the Brush to the specified Dynamic Texture.

Public function

void

 

SetBrushResourceObject

(
    UObject* ResourceObject
)

Public function

void

 

SetBrushTintColor

(
    FSlateColor TintColor
)

Public function

void

 

SetColorAndOpacity

(
    FLinearColor InColorAndOpacity
)

Public function

void

 

SetDesiredSizeOverride

(
    FVector2D DesiredSize
)

Public function

void

 

SetOpacity

(
    float InOpacity
)

Overridden from UWidget

Name Description

Protected function Virtual Const

TSharedPtr< ...

 

GetAccessibleWidget()

Gets the widget that accessibility properties should synchronize to.

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

Name Description

Public variable

TObjectPtr< USl...

 

Image_DEPRECATED

Image to draw

Deprecated Functions

Name Description

Public function

void

 

SetBrushSize

(
    FVector2D DesiredSize
)

  1. Use SetDesiredSizeOverride instead.