unreal.BackgroundBlur

class unreal.BackgroundBlur(outer: Object | None = None, name: Name | str = 'None')

Bases: ContentWidget

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

C++ Source:

  • Module: UMG

  • File: BackgroundBlur.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accessible_behavior (SlateAccessibleBehavior): [Read-Write] Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.

  • accessible_summary_behavior (SlateAccessibleBehavior): [Read-Write] How to describe this widget when it’s being presented through a summary of a parent widget. If set to custom, additional customization options will appear.

  • accessible_summary_text (Text): [Read-Write] When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

  • accessible_text (Text): [Read-Write] When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

  • apply_alpha_to_blur (bool): [Read-Write] True to modulate the strength of the blur based on the widget alpha.

  • blur_radius (int32): [Read-Write] 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.

  • blur_strength (float): [Read-Write] How blurry the background is. Larger numbers mean more blurry but will result in larger runtime cost on the GPU.

  • can_children_be_accessible (bool): [Read-Write] Whether or not children of this widget can appear as distinct accessible widgets.

  • clipping (WidgetClipping): [Read-Write] Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.

    NOTE: Elements in different clipping spaces can not be batched together, and so there is a performance cost to clipping. Do not enable clipping unless a panel actually needs to prevent content from showing up outside its bounds.

  • corner_radius (Vector4): [Read-Write] 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.

  • cursor (MouseCursor): [Read-Write] The cursor to show when the mouse is over the widget

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Allows you to set a new flow direction

  • horizontal_alignment (HorizontalAlignment): [Read-Write] The alignment of the content horizontally.

  • is_enabled (bool): [Read-Write] Sets whether this widget can be modified interactively by the user

  • is_volatile (bool): [Read-Write] If true prevents the widget or its child’s geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.

  • low_quality_fallback_brush (SlateBrush): [Read-Write] An image to draw instead of applying a blur when low quality override mode is enabled. 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

  • navigation (WidgetNavigation): [Read-Write] The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.

  • override_accessible_defaults (bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write]

  • padding (Margin): [Read-Write] The padding area between the slot and the content it contains.

  • pixel_snapping (WidgetPixelSnapping): [Read-Write] If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation

  • render_opacity (float): [Read-Write] The opacity of the widget

  • render_transform (WidgetTransform): [Read-Write] The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.

  • render_transform_pivot (Vector2D): [Read-Write] The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.

  • slot (PanelSlot): [Read-Write] The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • tool_tip_text (Text): [Read-Write] Tooltip text to show when the user hovers over the widget with the mouse

  • tool_tip_widget (Widget): [Read-Only] Tooltip widget to show when the user hovers over the widget with the mouse

  • vertical_alignment (VerticalAlignment): [Read-Write] The alignment of the content vertically.

  • visibility (SlateVisibility): [Read-Write] The visibility of the widget

property apply_alpha_to_blur: bool

[Read-Write] True to modulate the strength of the blur based on the widget alpha.

Type:

(bool)

property blur_radius: int

[Read-Write] 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.

Type:

(int32)

property blur_strength: float

[Read-Write] How blurry the background is. Larger numbers mean more blurry but will result in larger runtime cost on the GPU.

Type:

(float)

property corner_radius: Vector4

[Read-Write] 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.

Type:

(Vector4)

property horizontal_alignment: HorizontalAlignment

[Read-Write] The alignment of the content horizontally.

Type:

(HorizontalAlignment)

property low_quality_fallback_brush: SlateBrush

[Read-Write] An image to draw instead of applying a blur when low quality override mode is enabled. 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

Type:

(SlateBrush)

property padding: Margin

[Read-Write] The padding area between the slot and the content it contains.

Type:

(Margin)

set_apply_alpha_to_blur(apply_alpha_to_blur) → None

Set Apply Alpha to Blur

Parameters:

apply_alpha_to_blur (bool) –

set_blur_radius(blur_radius) → None

Set Blur Radius

Parameters:

blur_radius (int32) –

set_blur_strength(strength) → None

Set Blur Strength

Parameters:

strength (float) –

set_corner_radius(corner_radius) → None

Set Corner Radius

Parameters:

corner_radius (Vector4) –

set_horizontal_alignment(horizontal_alignment) → None

Set Horizontal Alignment

Parameters:

horizontal_alignment (HorizontalAlignment) –

set_low_quality_fallback_brush(brush) → None

Set Low Quality Fallback Brush

Parameters:

brush (SlateBrush) –

set_padding(padding) → None

Set Padding

Parameters:

padding (Margin) –

set_vertical_alignment(vertical_alignment) → None

Set Vertical Alignment

Parameters:

vertical_alignment (VerticalAlignment) –

property vertical_alignment: VerticalAlignment

[Read-Write] The alignment of the content vertically.

Type:

(VerticalAlignment)