Navigation
API > API/Runtime > API/Runtime/Slate
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)
| Name | SBackgroundBlur |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Layout/SBackgroundBlur.h |
| Include Path | #include "Widgets/Layout/SBackgroundBlur.h" |
Syntax
class SBackgroundBlur : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SBackgroundBlur
- FSlateControlledConstruction → SWidget → SCompoundWidget → SBackgroundBlur
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SBackgroundBlur() |
Widgets/Layout/SBackgroundBlur.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~SBackgroundBlur() |
Widgets/Layout/SBackgroundBlur.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PrivateParentType | SCompoundWidget | Widgets/Layout/SBackgroundBlur.h | |
| PrivateThisType | SBackgroundBlur | Widgets/Layout/SBackgroundBlur.h | |
| Super | SCompoundWidget | Widgets/Layout/SBackgroundBlur.h | |
| ThisClass | SBackgroundBlur | Widgets/Layout/SBackgroundBlur.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BlurRadiusAttribute | TSlateAttribute< TOptional< int32 > > | Widgets/Layout/SBackgroundBlur.h | ||
| BlurStrengthAttribute | TSlateAttribute< float > | Widgets/Layout/SBackgroundBlur.h | ||
| CornerRadiusAttribute | TSlateAttribute< FVector4 > | Widgets/Layout/SBackgroundBlur.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Widgets/Layout/SBackgroundBlur.h | ||
bool IsUsingLowQualityFallbackBrush() |
Widgets/Layout/SBackgroundBlur.h | ||
void SetApplyAlphaToBlur
(
bool bInApplyAlphaToBlur |
Widgets/Layout/SBackgroundBlur.h | ||
void SetBlurRadius
(
TAttribute< TOptional< int32 > > InBlurRadius |
Widgets/Layout/SBackgroundBlur.h | ||
void SetBlurStrength
(
TAttribute< float > InStrength |
Widgets/Layout/SBackgroundBlur.h | ||
void SetContent
(
const TSharedRef< SWidget >& InContent |
Widgets/Layout/SBackgroundBlur.h | ||
void SetCornerRadius
(
TAttribute< FVector4 > InCornerRadius |
Widgets/Layout/SBackgroundBlur.h | ||
void SetHAlign
(
EHorizontalAlignment HAlign |
Widgets/Layout/SBackgroundBlur.h | ||
void SetLowQualityBackgroundBrush
(
const FSlateBrush* InBrush |
Widgets/Layout/SBackgroundBlur.h | ||
void SetPadding
(
TAttribute< FMargin > InPadding |
Widgets/Layout/SBackgroundBlur.h | ||
void SetVAlign
(
EVerticalAlignment VAlign |
Widgets/Layout/SBackgroundBlur.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Widgets/Layout/SBackgroundBlur.h |
Overridden from FSlateControlledConstruction
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FSlateWidgetClassData & GetWidgetClass() |
Widgets/Layout/SBackgroundBlur.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ComputeEffectiveKernelSize
(
float Strength, |
Widgets/Layout/SBackgroundBlur.h | ||
TSlateAttributeRef< TOptional< int32 > > GetBlurRadiusAttribute() |
Widgets/Layout/SBackgroundBlur.h | ||
TSlateAttributeRef< float > GetBlurStrengthAttribute() |
Widgets/Layout/SBackgroundBlur.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FSlateWidgetClassData & GetPrivateWidgetClass() |
Widgets/Layout/SBackgroundBlur.h | ||
static SLATE_API void PrivateRegisterAttributes
(
FSlateAttributeInitializer& |
Widgets/Layout/SBackgroundBlur.h | ||
static const FSlateWidgetClassData & StaticWidgetClass() |
Widgets/Layout/SBackgroundBlur.h |