1. Epic GamesDeveloper
  3. UBackgroundBlur

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.

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

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

Syntax

UCLASS (MinimalAPI)  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter bool bApplyAlphaToBlur True to modulate the strength of the blur based on the widget alpha.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite blueprintsetter, getter, setter 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.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter float BlurStrength How blurry the background is.
Public variable UProperty getter, setter bool bOverrideAutoRadiusCalculation When OverrideAutoRadiusCalculation is set to true, BlurRadius is used for the radius of the blur.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite blueprintsetter, getter, setter FVector4 CornerRadius 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.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EHorizontalAlignment > HorizontalAlignment The alignment of the content horizontally.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FSlateBrush LowQualityFallbackBrush An image to draw instead of applying a blur when low quality override mode is enabled.
Protected variable TSharedPtr< class SBackgroundBlur > MyBackgroundBlur  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FMargin Padding The padding area between the slot and the content it contains.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EVerticalAlignment > VerticalAlignment The alignment of the content vertically.

Constructors

  Type Name Description
Public function  

UBackgroundBlur ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const bool  
Public function Const int32  
Public function Const float  
Public function Const FVector4  
Public function Const EHorizontalAlignment  
Public function Const FSlateBrush  
Public function Const bool  
Public function Const FMargin  
Public function Const EVerticalAlignment  
Public function Virtual void

Serialize ( FArchive& Ar
)

 UObject interface
Public function UFunction BlueprintCallable, Category void

SetApplyAlphaToBlur ( bool bInApplyAlphaToBlur
)

  
Public function UFunction BlueprintCallable, Category void

SetBlurRadius ( int32 InBlurRadius
)

  
Public function Virtual UFunction BlueprintCallable, Category void

SetBlurStrength ( float InStrength
)

  
Public function Virtual UFunction BlueprintCallable, Category void

SetCornerRadius ( FVector4 InCornerRadius
)

  
Public function UFunction BlueprintCallable, Category void

SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment
)

  
Public function UFunction BlueprintCallable, Category void

SetLowQualityFallbackBrush ( const FSlateBrush& InBrush
)

  
Public function void

SetOverrideAutoRadiusCalculation ( bool InOverrideAutoRadiusCalculation
)

  
Public function UFunction BlueprintCallable, Category void

SetPadding ( FMargin InPadding
)

  
Public function UFunction BlueprintCallable, Category void

SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment
)

  

Overridden from UPanelWidget

  Type Name Description
Protected function Virtual Const UClass * UWidget interface
Protected function Virtual void UPanelWidget interface
Protected function Virtual void  
Public function Virtual void Begin UObject.

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Protected function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page