UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FWebImageCache Class Reference

#include <WebImageCache.h>

Public Member Functions

IMAGEDOWNLOAD_API FWebImageCache ()
 
IMAGEDOWNLOAD_API void PreUnload ()
 
IMAGEDOWNLOAD_API void Empty ()
 
IMAGEDOWNLOAD_API TSharedRef< const FWebImageDownload (const FString &Url, const TOptional< FString > &DefaultImageUrl=TOptional< FString >())
 
void SetDefaultStandInBrush (TAttribute< const FSlateBrush * > StandInBrushIn)
 
IMAGEDOWNLOAD_API void RelinquishUnusedImages ()
 

Detailed Description

This class is designed to facilitate caching of web images and setting a global stand-in so we don't re-download the same image every time the UI shows it again.

See WebImage.h for example usage.

Constructor & Destructor Documentation

◆ FWebImageCache()

FWebImageCache::FWebImageCache ( )

Member Function Documentation

◆ Download()

TSharedRef< const FWebImage > FWebImageCache::Download ( const FString &  Url,
const TOptional< FString > &  DefaultImageUrl = TOptional<FString>() 
)

Find or create a WebImage object for this URL (you probably just want to call ->Attr() on this)

◆ Empty()

void FWebImageCache::Empty ( )

Removes all cached images

◆ PreUnload()

void FWebImageCache::PreUnload ( )

Signifies the module is being unloaded and to perform any actions that depend on other modules which may be unloaded as well

◆ RelinquishUnusedImages()

void FWebImageCache::RelinquishUnusedImages ( )

◆ SetDefaultStandInBrush()

void FWebImageCache::SetDefaultStandInBrush ( TAttribute< const FSlateBrush * >  StandInBrushIn)
inline

Set the brush that will be returned until the download completes (only affects future downloads).


The documentation for this class was generated from the following files: