1. Epic GamesDeveloper
  3. UImage

UImage

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

API > API/Runtime > API/Runtime/UMG

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

  • No Children
   
Name UImage
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/Image.h
Include Path #include "Components/Image.h"

Syntax

UCLASS (MinimalAPI)  
class UImage : public UWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UImage ( const FObjectInitializer& ObjectInitializer
)

   Components/Image.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bFlipForRightToLeftFlowDirection bool Flips the image if the localization's flow direction is RightToLeft Components/Image.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="ShouldFlipForRightToLeftFlowDirection"
  • Setter="SetFlipForRightToLeftFlowDirection"
  • Category="Localization"
Brush FSlateBrush Image to draw Components/Image.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetBrush"
  • FieldNotify
  • Category=Appearance
BrushDelegate FGetSlateBrush A bindable delegate for the Image. Components/Image.h  
ColorAndOpacity FLinearColor Color and opacity Components/Image.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetColorAndOpacity"
  • Category=Appearance
  • Meta=(sRGB="true")
ColorAndOpacityDelegate FGetLinearColor A bindable delegate for the ColorAndOpacity. Components/Image.h  
OnMouseButtonDownEvent FOnPointerEvent   Components/Image.h
  • EditAnywhere
  • Category=Events
  • Meta=(IsBindableEvent="True")

Functions

Public

Name Remarks Include Path Unreal Specifiers

const FSlateBrush & GetBrush()

   Components/Image.h  

const FLinearColor & GetColorAndOpacity()

   Components/Image.h  

UMaterialInstanceDynamic * GetDynamicMaterial()

   Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

virtual void SetBrush ( const FSlateBrush& InBrush
)

   Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

virtual void SetBrushFromAsset ( USlateBrushAsset* Asset
)

   Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

virtual void SetBrushFromAtlasInterface ( TScriptInterface< ISlateTextureAtlasInterface > AtlasRegion,
bool bMatchSize
)

 Sets the Brush to the specified Atlas Region. Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

virtual void SetBrushFromMaterial ( UMaterialInterface* Material
)

   Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

virtual void SetBrushFromSoftMaterial ( TSoftObjectPtr< UMaterialInterface > SoftMaterial
)

   Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

virtual void SetBrushFromSoftTexture ( TSoftObjectPtr< UTexture2D > SoftTexture,
bool bMatchSize
)

 Sets the Brush to the specified Soft Texture. Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

virtual void SetBrushFromTexture ( UTexture2D* Texture,
bool bMatchSize
)

 Sets the Brush to the specified Texture. Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

virtual void SetBrushFromTextureDynamic ( UTexture2DDynamic* Texture,
bool bMatchSize
)

 Sets the Brush to the specified Dynamic Texture. Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

void SetBrushResourceObject ( UObject* ResourceObject
)

   Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

void SetBrushSize ( FVector2D DesiredSize
)

   Components/Image.h  

void SetBrushTintColor ( FSlateColor TintColor
)

   Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

void SetColorAndOpacity ( FLinearColor InColorAndOpacity
)

   Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

void SetDesiredSizeOverride ( FVector2D DesiredSize
)

   Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

void SetFlipForRightToLeftFlowDirection ( bool InbFlipForRightToLeftFlowDirection
)

   Components/Image.h  

void SetOpacity ( float InOpacity
)

   Components/Image.h
  • BlueprintCallable
  • Category="Appearance"

bool ShouldFlipForRightToLeftFlowDirection()

   Components/Image.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/Image.h  

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/Image.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/Image.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void CancelImageStreaming()

 Called when we need to abort the texture being streamed in. Components/Image.h  

const FSlateBrush * ConvertImage ( TAttribute< FSlateBrush > InImageAsset
) const

 Translates the bound brush data and assigns it to the cached brush used by this widget. Components/Image.h  

FReply HandleMouseButtonDown ( const FGeometry& Geometry,
const FPointerEvent& MouseEvent
)

   Components/Image.h  

FSlateColor K2_Gate_ColorAndOpacity()

   Components/Image.h  

virtual void OnImageStreamingComplete ( TSoftObjectPtr< UObject > LoadedSoftObject
)

 Called when the image streaming completes. Components/Image.h  

virtual void OnImageStreamingStarted ( TSoftObjectPtr< UObject > SoftObject
)

 Called when the image streaming starts, after the other one was cancelled. Components/Image.h  

void RequestAsyncLoad ( TSoftObjectPtr< UObject > SoftObject,
TFunction< void()>&& Callback
)

 Called when we need to stream in content. Components/Image.h  

virtual void RequestAsyncLoad ( TSoftObjectPtr< UObject > SoftObject,
FStreamableDelegate DelegateToCall
)

   Components/Image.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< SWidget > GetAccessibleWidget()

 Gets the widget that accessibility properties should synchronize to. Components/Image.h  

virtual TSharedRef< SWidget > RebuildWidget()

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page