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

Light Theme

Dark Theme

UCommonLazyImage

A special Image widget that can show unloaded images and takes care of the loading for you!

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UImage

UCommonLazyImage

References

Module	CommonUI
Header	/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonLazyImage.h
Include	#include "CommonLazyImage.h"

Syntax

UCLASS()
class UCommonLazyImage : public UImage

Remarks

A special Image widget that can show unloaded images and takes care of the loading for you!

UCommonLazyImage is another wrapper for SLoadGuard, but it only handles image loading and a throbber during loading.

If this class changes to show any text, by default it will have CoreStyle styling

Constructors

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

Functions

	Name	Description
bool	IsLoading()
FOnLoadGuard...	OnLoadingStateChanged()
TSharedRef< ...	RebuildImageWidget()
void	SetBrushFromLazyDisplayAsset ( const TSoftObjectPtr< UObject >& L..., bool bMatchTextureSize )	Set the brush from a string asset ref only - expects the referenced asset to be a texture or material.
void	SetBrushFromLazyMaterial ( const TSoftObjectPtr< UMaterialInte... )	Set the brush from a lazy material asset pointer - will load the material as needed.
void	SetBrushFromLazyTexture ( const TSoftObjectPtr< UTexture2D > ..., bool bMatchSize )	Set the brush from a lazy texture asset pointer - will load the texture as needed.
void	SetIsLoading ( bool bIsLoading )
void	SetMaterialTextureParamName ( FName TextureParamName )	Establishes the name of the texture parameter on the currently applied brush material to which textures should be applied.

Overridden from UImage

	Name	Description
void	CancelImageStreaming()	Called when we need to abort the texture being streamed in.
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	SetBrush ( const FSlateBrush& InBrush )
void	SetBrushFromAsset ( USlateBrushAsset* Asset )
void	SetBrushFromMaterial ( UMaterialInterface* Material )
void	SetBrushFromTexture ( UTexture2D* Texture, bool bMatchSize )	Sets the Brush to the specified Texture.
void	SetBrushFromTextureDynamic ( UTexture2DDynamic* Texture, bool bMatchSize )	Sets the Brush to the specified Dynamic Texture.

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
void	OnWidgetRebuilt()	Function called after the underlying SWidget is constructed.
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
	bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.