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 > Blueprint > FUserWidgetPool

Light Theme

Dark Theme

FUserWidgetPool

Pools [UUserWidget](API\Runtime\UMG\Blueprint\UUserWidget) instances to minimize [UObject](API\Runtime\CoreUObject\UObject\UObject) and [SWidget](API\Runtime\SlateCore\Widgets\SWidget) allocations for UMG elements with dynamic entries.

Windows

MacOS

Linux

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Blueprint/UserWidgetPool.h
Include	#include "Blueprint/UserWidgetPool.h"

Syntax

struct FUserWidgetPool

Remarks

Pools UUserWidget instances to minimize UObject and SWidget allocations for UMG elements with dynamic entries.

Note that if underlying Slate instances are released when a UserWidget instance becomes inactive, NativeConstruct & NativeDestruct will be called when UUserWidget instances are made active or inactive, respectively, provided the widget isn't actively referenced in the Slate hierarchy (i.e. if the shared reference count on the widget goes from/to 0).

WARNING: Be sure to release the pool's Slate widgets within the owning widget's ReleaseSlateResources call to prevent leaking due to circular references Otherwise the cached references to SObjectWidgets will keep the UUserWidgets - and all that they reference - alive

Constructors

	Name	Description
	FUserWidgetPool()
	FUserWidgetPool ( UWidget& InOwningWidget )

Destructors

	Name	Description
	~FUserWidgetPool()

Functions

	Name	Description
void	AddReferencedObjects ( FReferenceCollector& Collector )	Report any references to UObjects to the reference collector (only necessary if this is not already a UPROPERTY)
const TArray...	GetActiveWidgets()
UserWidgetT ...	GetOrCreateInstance ( TSubclassOf< UserWidgetT > WidgetCl..., WidgetConstructFunc ConstructWidget... )	Gets an instance of the widget this factory is for with a custom underlying SObjectWidget type
UserWidgetT ...	GetOrCreateInstance ( TSubclassOf< UserWidgetT > WidgetCl... )	Gets an instance of a widget of the given class.
bool	IsInitialized()
void	RebuildWidgets()	Triggers RebuildWidget on all currently active UserWidget instances
void	Release ( TArray< UUserWidget* > Widgets, bool bReleaseSlate )	Return a widget object to the pool, allowing it to be reused in the future
void	Release ( UUserWidget* Widget, bool bReleaseSlate )	Return a widget object to the pool, allowing it to be reused in the future
void	ReleaseAll ( bool bReleaseSlate )	Returns all active widget objects to the inactive pool and optionally destroys all cached underlying slate widgets.
void	ReleaseAllSlateResources()	Reset of all cached underlying Slate widgets, but not the active UUserWidget objects
void	ReleaseInactiveSlateResources()	Reset of all cached underlying Slate widgets, only for inactive widgets in the pool.
void	ResetPool()	Full reset of all created widget objects (and any cached underlying slate)
void	SetWorld ( UWorld* OwningWorld )	In the case that you don't have an owner widget, you should set a world to your pool, or it won't be able to construct widgets.

Typedefs

Name	Description
WidgetConstructFunc

Deprecated Functions

		Name	Description
	void	ReleaseSlateResources()	Use ReleaseAllSlateResources instead.