Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > UMG > Components > UImage

Light Theme

Dark Theme

UImage

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UImage

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
bool	bFlipForRightToLeftFlowDirection	Flips the image if the localization's flow direction is RightToLeft
FSlateBrush	Brush	Image to draw
FGetSlateBrush	BrushDelegate	A bindable delegate for the Image.
FLinearColor	ColorAndOpacity	Color and opacity
FGetLinearColor	ColorAndOpacityDelegate	A bindable delegate for the ColorAndOpacity.
FSlateColor	K2_Cache_ColorAndOpacity
TSharedPtr< SIm...	MyImage
FOnPointerEvent	OnMouseButtonDownEvent
TSharedPtr< FSt...	StreamingHandle
FSoftObjectPath	StreamingObjectPath

Constructors

	Name	Description
	UImage ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	CancelImageStreaming()	Called when we need to abort the texture being streamed in.
const FSlate...	ConvertImage ( TAttribute< FSlateBrush > InImageAs... )	Translates the bound brush data and assigns it to the cached brush used by this widget.
UMaterialIns...	GetDynamicMaterial()
FReply	HandleMouseButtonDown ( const FGeometry& Geometry, const FPointerEvent& MouseEvent )
FSlateColor	K2_Gate_ColorAndOpacity()
void	OnImageStreamingComplete ( TSoftObjectPtr< UObject > LoadedSof... )	Called when the image streaming completes.
void	OnImageStreamingStarted ( TSoftObjectPtr< UObject > SoftObjec... )	Called when the image streaming starts, after the other one was cancelled.
void	RequestAsyncLoad ( TSoftObjectPtr< UObject > SoftObjec..., TFunction< void()>&& Callback )	Called when we need to stream in content.
void	RequestAsyncLoad ( TSoftObjectPtr< UObject > SoftObjec..., FStreamableDelegate DelegateToCall )	Called when we need to stream in content.
void	SetBrush ( const FSlateBrush& InBrush )
void	SetBrushFromAsset ( USlateBrushAsset* Asset )
void	SetBrushFromAtlasInterface ( TScriptInterface< ISlateTextureAtla..., bool bMatchSize )
void	SetBrushFromMaterial ( UMaterialInterface* Material )
void	SetBrushFromSoftMaterial ( TSoftObjectPtr< UMaterialInterface ... )
void	SetBrushFromSoftTexture ( TSoftObjectPtr< UTexture2D > SoftTe..., bool bMatchSize )
void	SetBrushFromTexture ( UTexture2D* Texture, bool bMatchSize )
void	SetBrushFromTextureDynamic ( UTexture2DDynamic* Texture, bool bMatchSize )
void	SetBrushResourceObject ( UObject* ResourceObject )
void	SetBrushSize ( FVector2D DesiredSize )
void	SetBrushTintColor ( FSlateColor TintColor )
void	SetColorAndOpacity ( FLinearColor InColorAndOpacity )
void	SetOpacity ( float InOpacity )

Overridden from UWidget

	Name	Description
TSharedPtr< ...	GetAccessibleWidget()	Gets the widget that accessibility properties should synchronize to.
const FText	GetPaletteCategory()	Gets the palette category of the widget
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

		Name	Description
	USlateBrushAsse...	Image_DEPRECATED	Image to draw

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss