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

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
   
Name UBackgroundBlur
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/BackgroundBlur.h
Include Path #include "Components/BackgroundBlur.h"

Syntax

UCLASS (MinimalAPI)  
class UBackgroundBlur : public UContentWidget

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UBackgroundBlur ( const FObjectInitializer& ObjectInitializer
)

   Components/BackgroundBlur.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bApplyAlphaToBlur bool True to modulate the strength of the blur based on the widget alpha. Components/BackgroundBlur.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter=GetApplyAlphaToBlur
  • Setter=SetApplyAlphaToBlur
  • BlueprintSetter=SetApplyAlphaToBlur
  • Category=Content
BlurRadius int32 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. Components/BackgroundBlur.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter=SetBlurRadius
  • Category=Appearance
  • Meta=(ClampMin=0, ClampMax=255, EditCondition="bOverrideAutoRadiusCalculation")
BlurStrength float How blurry the background is. Components/BackgroundBlur.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter=SetBlurStrength
  • Category=Appearance
  • Meta=(ClampMin=0, ClampMax=100)
bOverrideAutoRadiusCalculation bool When OverrideAutoRadiusCalculation is set to true, BlurRadius is used for the radius of the blur. Components/BackgroundBlur.h
  • Getter=GetOverrideAutoRadiusCalculation
  • Setter=SetOverrideAutoRadiusCalculation
CornerRadius FVector4 Radius in Slate Units applied to the blur widget at each corner. Components/BackgroundBlur.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter=SetCornerRadius
  • Category=Appearance
HorizontalAlignment TEnumAsByte< EHorizontalAlignment > The alignment of the content horizontally. Components/BackgroundBlur.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter=SetHorizontalAlignment
  • Category=Content
LowQualityFallbackBrush FSlateBrush An image to draw instead of applying a blur when low quality override mode is enabled. Components/BackgroundBlur.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter=SetLowQualityFallbackBrush
  • Category=Appearance
Padding FMargin The padding area between the slot and the content it contains. Components/BackgroundBlur.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter=SetPadding
  • Category=Content
VerticalAlignment TEnumAsByte< EVerticalAlignment > The alignment of the content vertically. Components/BackgroundBlur.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter=SetVerticalAlignment
  • Category=Content

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetApplyAlphaToBlur()

   Components/BackgroundBlur.h  

int32 GetBlurRadius()

   Components/BackgroundBlur.h  

float GetBlurStrength()

   Components/BackgroundBlur.h  

FVector4 GetCornerRadius()

   Components/BackgroundBlur.h  

EHorizontalAlignment GetHorizontalAlignment()

   Components/BackgroundBlur.h  

FSlateBrush GetLowQualityFallbackBrush()

   Components/BackgroundBlur.h  

bool GetOverrideAutoRadiusCalculation()

   Components/BackgroundBlur.h  

FMargin GetPadding()

   Components/BackgroundBlur.h  

EVerticalAlignment GetVerticalAlignment()

   Components/BackgroundBlur.h  

void SetApplyAlphaToBlur ( bool bInApplyAlphaToBlur
)

   Components/BackgroundBlur.h
  • BlueprintCallable
  • Category="Appearance"

void SetBlurRadius ( int32 InBlurRadius
)

   Components/BackgroundBlur.h
  • BlueprintCallable
  • Category="Appearance"

virtual void SetBlurStrength ( float InStrength
)

   Components/BackgroundBlur.h
  • BlueprintCallable
  • Category="Appearance"

virtual void SetCornerRadius ( FVector4 InCornerRadius
)

   Components/BackgroundBlur.h
  • BlueprintCallable
  • Category="Appearance"

void SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment
)

   Components/BackgroundBlur.h
  • BlueprintCallable
  • Category="Appearance"

void SetLowQualityFallbackBrush ( const FSlateBrush& InBrush
)

   Components/BackgroundBlur.h
  • BlueprintCallable
  • Category="Appearance"

void SetOverrideAutoRadiusCalculation ( bool InOverrideAutoRadiusCalculation
)

   Components/BackgroundBlur.h  

void SetPadding ( FMargin InPadding
)

   Components/BackgroundBlur.h
  • BlueprintCallable
  • Category="Appearance"

void SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment
)

   Components/BackgroundBlur.h
  • BlueprintCallable
  • Category="Appearance"

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/BackgroundBlur.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/BackgroundBlur.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/BackgroundBlur.h  

virtual void PostLoad()

 Begin UObject. Components/BackgroundBlur.h  

virtual void Serialize ( FArchive& Ar
)

 UObject interface Components/BackgroundBlur.h  

Protected

Overridden from UPanelWidget

Name Remarks Include Path Unreal Specifiers

virtual UClass * GetSlotClass()

 UWidget interface Components/BackgroundBlur.h  

virtual void OnSlotAdded ( UPanelSlot* Slot
)

 UPanelWidget interface Components/BackgroundBlur.h  

virtual void OnSlotRemoved ( UPanelSlot* Slot
)

   Components/BackgroundBlur.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildWidget()

 Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. Components/BackgroundBlur.h  

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/BackgroundBlur.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page