unreal.BackgroundBlur

class unreal.BackgroundBlur(outer: Optional[Object] = None, name: Union[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] Accessible Behavior: 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] Accessible Summary Behavior: 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] Accessible Summary Text: When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

  • accessible_text (Text): [Read-Write] Accessible Text: 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] Apply Alpha to Blur

  • blur_radius (int32): [Read-Write] Blur Radius

  • blur_strength (float): [Read-Write] Blur Strength

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

  • clipping (WidgetClipping): [Read-Write] Clipping

  • corner_radius (Vector4): [Read-Write] Corner Radius

  • cursor (MouseCursor): [Read-Write] Cursor

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference

  • horizontal_alignment (HorizontalAlignment): [Read-Write] Horizontal Alignment

  • is_enabled (bool): [Read-Write] Is Enabled

  • is_volatile (bool): [Read-Write] Is Volatile: 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] Low Quality Fallback Brush

  • navigation (WidgetNavigation): [Read-Write] Navigation: 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 Accessible Defaults: Override all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write] Override Cursor

  • padding (Margin): [Read-Write] Padding

  • render_opacity (float): [Read-Write] Render Opacity

  • render_transform (WidgetTransform): [Read-Write] Render Transform

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot

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

  • tool_tip_text (Text): [Read-Write] Tool Tip Text

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget

  • vertical_alignment (VerticalAlignment): [Read-Write] Vertical Alignment

  • visibility (SlateVisibility): [Read-Write] Visibility

property apply_alpha_to_blur: bool

[Read-Write] Apply Alpha to Blur

Type:

(bool)

property blur_radius: int

[Read-Write] Blur Radius

Type:

(int32)

property blur_strength: float

[Read-Write] Blur Strength

Type:

(float)

property corner_radius: Vector4

[Read-Write] Corner Radius

Type:

(Vector4)

property horizontal_alignment: HorizontalAlignment

[Read-Write] Horizontal Alignment

Type:

(HorizontalAlignment)

property low_quality_fallback_brush: SlateBrush

[Read-Write] Low Quality Fallback Brush

Type:

(SlateBrush)

property padding: Margin

[Read-Write] Padding

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] Vertical Alignment

Type:

(VerticalAlignment)