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 > Slate > Widgets > Layout > SBackgroundBlur

Light Theme

Dark Theme

SBackgroundBlur

A BackgroundBlur is similar to a Border in that it can be used to contain other widgets.

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SBackgroundBlur

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Layout/SBackgroundBlur.h
Include	#include "Widgets/Layout/SBackgroundBlur.h"

Syntax

class SBackgroundBlur : public SCompoundWidget

Remarks

A BackgroundBlur is similar to a Border in that it can be used to contain other widgets. However, instead of surrounding the content with an image, it applies a post-process blur to everything (both actors and widgets) that is underneath it.

For low-spec machines where the blur effect is too computationally expensive, a user-specified fallback image is used instead (effectively turning this into a Border)

Variables

		Name	Description
	bool	bApplyAlphaToBlur
	TAttribute< TOp...	BlurRadius
	TAttribute< flo...	BlurStrength
	const FSlateBru...	LowQualityFallbackBrush

Functions

		Name	Description
	void	ComputeEffectiveKernelSize ( float Strength, int32& OutKernelSize, int32& OutDownsampleAmount )
	void	Construct ( const FArguments& InArgs )
	bool	IsUsingLowQualityFallbackBrush()
	void	SetApplyAlphaToBlur ( bool bInApplyAlphaToBlur )
	void	SetBlurRadius ( const TAttribute< TOptional< int32 ... )
	void	SetBlurStrength ( const TAttribute< float >& InStren... )
	void	SetContent ( const TSharedRef< SWidget >& InCon... )
	void	SetHAlign ( EHorizontalAlignment HAlign )
	void	SetLowQualityBackgroundBrush ( const FSlateBrush* InBrush )
	void	SetPadding ( const TAttribute< FMargin >& InPad... )
	void	SetVAlign ( EVerticalAlignment VAlign )

Overridden from SWidget

		Name	Description
	int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.

Classes

	Name	Description
	FArguments

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

Take our survey

Dismiss