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 > Components > UBackgroundBlur

Light Theme

Dark Theme

UBackgroundBlur

A background blur is a container widget that can contain one child widget, providing an opportunity to surround it with adjustable padding and apply a post-process Gaussian blur to all content beneath the widget.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UContentWidget

UBackgroundBlur

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/BackgroundBlur.h
Include	#include "Components/BackgroundBlur.h"

Syntax

class UBackgroundBlur : public UContentWidget

Remarks

A background blur is a container widget that can contain one child widget, providing an opportunity to surround it with adjustable padding and apply a post-process Gaussian blur to all content beneath the widget.

Single Child
Blur Effect

Variables

	Name	Description
bool	bApplyAlphaToBlur	True to modulate the strength of the blur based on the widget alpha.
int32	BlurRadius	This is the number of pixels which will be weighted in each direction from any given pixel when computing the blur A larger value is more costly but allows for stronger blurs.
float	BlurStrength	How blurry the background is.
bool	bOverrideAutoRadiusCalculation	Whether or not the radius should be computed automatically or if it should use the radius
TEnumAsByte< EH...	HorizontalAlignment	The alignment of the content horizontally.
FSlateBrush	LowQualityFallbackBrush	An image to draw instead of applying a blur when low quality override mode is enabled.
TSharedPtr< cla...	MyBackgroundBlur
FMargin	Padding	The padding area between the slot and the content it contains.
TEnumAsByte< EV...	VerticalAlignment	The alignment of the content vertically.

Constructors

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

Functions

		Name	Description
	void	SetApplyAlphaToBlur ( bool bInApplyAlphaToBlur )
	void	SetBlurRadius ( int32 InBlurRadius )
	void	SetBlurStrength ( float InStrength )
	void	SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAl... )
	void	SetLowQualityFallbackBrush ( const FSlateBrush& InBrush )
	void	SetPadding ( FMargin InPadding )
	void	SetVerticalAlignment ( EVerticalAlignment InVerticalAlignm... )

Overridden from UPanelWidget

	Name	Description
UClass *	GetSlotClass()	UWidget interface
void	OnSlotAdded ( UPanelSlot* Slot )	UPanelWidget interface
void	OnSlotRemoved ( UPanelSlot* Slot )

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
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
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Begin UObject.
void	Serialize ( FArchive& Ar )	UObject interface

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss