SBackgroundBlur | Unreal Engine 5.2 Documentation

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Layout

Inheritance Hierarchy

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.

Note: 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

	Type	Name	Description
	bool	bApplyAlphaToBlur
	TSlateDeprecatedTAttribute< TOptional< int32 > >	BlurRadius
	TSlateDeprecatedTAttribute< float >	BlurStrength
	const FSlateBrush *	LowQualityFallbackBrush

Constructors

	Type	Name	Description
		SBackgroundBlur ()

Functions

	Type	Name	Description
	void	ComputeEffectiveKernelSize ( float Strength, int32& OutKernelSize, int32& OutDownsampleAmount )
	void	Construct ( const FArguments& InArgs )
	TSlateAttributeRef< TOptional< int32 > >	GetBlurRadiusAttribute ()
	TSlateAttributeRef< float >	GetBlurStrengthAttribute ()
	bool	IsUsingLowQualityFallbackBrush ()
	void	SetApplyAlphaToBlur ( bool bInApplyAlphaToBlur )
	void	SetBlurRadius ( TAttribute< TOptional< int32 >> InBlurRadius )
	void	SetBlurStrength ( TAttribute< float > InStrength )
	void	SetContent ( const TSharedRef< SWidget >& InContent )
	void	SetCornerRadius ( TAttribute< FVector4 > InCornerRadius )
	void	SetHAlign ( EHorizontalAlignment HAlign )
	void	SetLowQualityBackgroundBrush ( const FSlateBrush* InBrush )
	void	SetPadding ( TAttribute< FMargin > InPadding )
	void	SetVAlign ( EVerticalAlignment VAlign )
	const FSlateWidgetClassData &	StaticWidgetClass ()

Overridden from SWidget

	Type	Name	Description
	int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, 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.