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 > API/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
Public variable FGetSlateBrush BrushDelegate A bindable delegate for the Image.
Public variable FGetLinearColor ColorAndOpacityDelegate A bindable delegate for the ColorAndOpacity.
Protected variable PRAGMA_DISABLE_DEPRECATION_WARNINGSFSlateColor K2_Cache_ColorAndOpacity  
Protected variable TSharedPtr< SImage > MyImage  
Public variable FOnPointerEvent OnMouseButtonDownEvent  
Protected variable TSharedPtr< FStreamableHandle > StreamingHandle  
Protected variable FSoftObjectPath StreamingObjectPath  

Constructors

  Type Name Description
Public function  

UImage ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Virtual void Called when we need to abort the texture being streamed in.
Protected function Const const FSlateBrush *

ConvertImage ( TAttribute< FSlateBrush > InImageAsset
)

 Translates the bound brush data and assigns it to the cached brush used by this widget.
Public function Const const FSlateBrush &  
Public function Const const FLinearColor &  
Public function UMaterialInstanceDynamic *  
Protected function FReply

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

  
Protected function FSlateColor  
Protected function Virtual void Called when the image streaming completes.
Protected function Virtual void Called when the image streaming starts, after the other one was cancelled.
Protected function void

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

 Called when we need to stream in content.
Protected function Virtual void

RequestAsyncLoad ( TSoftObjectPtr< UObject > SoftObject,
FStreamableDelegate DelegateToCall
)

 Called when we need to stream in content.
Public function Virtual void

SetBrush ( const FSlateBrush& InBrush
)

  
Public function Virtual void  
Public function Virtual void Sets the Brush to the specified Atlas Region.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

SetBrushFromSoftTexture ( TSoftObjectPtr< UTexture2D > SoftTexture,
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  
Public function void

SetColorAndOpacity ( FLinearColor InColorAndOpacity
)

  
Public function void

SetDesiredSizeOverride ( FVector2D DesiredSize
)

  
Public function void

SetFlipForRightToLeftFlowDirection ( bool InbFlipForRightToLeftFlowDirection
)

  
Public function void

SetOpacity ( float InOpacity
)

  
Public function Const bool  

Overridden from UWidget

  Type Name Description
Protected function Virtual Const TSharedPtr< SWidget > Gets the widget that accessibility properties should synchronize to.
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Deprecated Variables

  Type Name Description
Public variable bool bFlipForRightToLeftFlowDirection Direct access to bFlipForRightToLeftFlowDirection is deprecated. Please use the getter or setter.
Public variable FSlateBrush Brush Direct access to Brush is deprecated. Please use the getter or setter.
Public variable FLinearColor ColorAndOpacity Direct access to ColorAndOpacity is deprecated. Please use the getter or setter.

Deprecated Functions

  Type Name Description
Public function void

SetBrushSize ( FVector2D DesiredSize
)

 Deprecated. Use SetDesiredSizeOverride instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page