Class BackgroundBlur

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.

Inheritance
System.Object
UObject
Visual
Widget
PanelWidget
ContentWidget
BackgroundBlur
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.UMG
Assembly: UE4DotNet.dll
Syntax
public class BackgroundBlur : ContentWidget
Remarks
  • Single Child
  • Blur Effect

Properties

| Improve this Doc View Source

bApplyAlphaToBlur

Declaration
public bool bApplyAlphaToBlur { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

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.

Declaration
public int BlurRadius { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

BlurStrength

How blurry the background is. Larger numbers mean more blurry but will result in larger runtime cost on the gpu.

Declaration
public float BlurStrength { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

bOverrideAutoRadiusCalculation

Declaration
public bool bOverrideAutoRadiusCalculation { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static BackgroundBlur DefaultObject { get; }
Property Value
Type Description
BackgroundBlur
| Improve this Doc View Source

HorizontalAlignment

The alignment of the content horizontally.

Declaration
public byte HorizontalAlignment { get; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

LowQualityFallbackBrush

An image to draw instead of applying a blur when low quality override mode is enabled.

Declaration
public SlateBrush LowQualityFallbackBrush { get; }
Property Value
Type Description
SlateBrush
Remarks

You can enable low quality mode for background blurs by setting the cvar Slate.ForceBackgroundBlurLowQualityOverride to 1. This is usually done in the project's scalability settings

| Improve this Doc View Source

Padding

The padding area between the slot and the content it contains.

Declaration
public Margin Padding { get; }
Property Value
Type Description
Margin
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

VerticalAlignment

The alignment of the content vertically.

Declaration
public byte VerticalAlignment { get; }
Property Value
Type Description
System.Byte

Methods

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static BackgroundBlur New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
BackgroundBlur
| Improve this Doc View Source

SetApplyAlphaToBlur(Boolean)

Set Apply Alpha to Blur

Declaration
public void SetApplyAlphaToBlur(bool bInApplyAlphaToBlur)
Parameters
Type Name Description
System.Boolean bInApplyAlphaToBlur
| Improve this Doc View Source

SetBlurRadius(Int32)

Set Blur Radius

Declaration
public void SetBlurRadius(int InBlurRadius)
Parameters
Type Name Description
System.Int32 InBlurRadius
| Improve this Doc View Source

SetBlurStrength(Single)

Set Blur Strength

Declaration
public void SetBlurStrength(float InStrength)
Parameters
Type Name Description
System.Single InStrength
| Improve this Doc View Source

SetHorizontalAlignment(Byte)

Set Horizontal Alignment

Declaration
public void SetHorizontalAlignment(byte InHorizontalAlignment)
Parameters
Type Name Description
System.Byte InHorizontalAlignment
| Improve this Doc View Source

SetLowQualityFallbackBrush(SlateBrush)

Set Low Quality Fallback Brush

Declaration
public void SetLowQualityFallbackBrush(SlateBrush InBrush)
Parameters
Type Name Description
SlateBrush InBrush
| Improve this Doc View Source

SetPadding(Margin)

Set Padding

Declaration
public void SetPadding(Margin InPadding)
Parameters
Type Name Description
Margin InPadding
| Improve this Doc View Source

SetVerticalAlignment(Byte)

Set Vertical Alignment

Declaration
public void SetVerticalAlignment(byte InVerticalAlignment)
Parameters
Type Name Description
System.Byte InVerticalAlignment

Operators

| Improve this Doc View Source

Implicit(IntPtr to BackgroundBlur)

Convert from IntPtr to UObject

Declaration
public static implicit operator BackgroundBlur(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
BackgroundBlur