Class BackgroundBlurEffect

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll

Background blur effect of a View. Applications can apply BackgroundBlurEffect as the example below :

BackgroundBlurEffect effect = new BackgroundBlurEffect();
view.SetRenderEffect(effect);
public class BackgroundBlurEffect : RenderEffect, IDynamicResourceHandler, INameScope, System.IDisposable
Inheritance
object
BindableObject
Element
BaseHandle
RenderEffect
BackgroundBlurEffect
Implements
IDynamicResourceHandler
INameScope
System.IDisposable

Properties

View Source

BlurDownscaleFactor

The property downscales input texture's width and height to enhance performance. The value should be bigger than 0.0f and lower than 1.0f. Note that values near zero may ignore blur calculation.

Declaration
public float BlurDownscaleFactor { get; set; }
Property Value
Type Description
float
View Source

BlurOnce

The property determines whether to render the effect only once or at every frame update.

Declaration
public bool BlurOnce { get; set; }
Property Value
Type Description
bool
View Source

BlurRadius

The property is blur radius value. The unit is pixel, but the property is in float type since many other platforms use float for blur effect radius.

Declaration
public float BlurRadius { get; set; }
Property Value
Type Description
float
Remarks

The blurRadius parameter is adjusted due to downscaling and kernel compression, resulting in a smaller effective value. This means the blur intensity changes in discrete steps rather than continuously, with the step size determined by (2 / downscale factor). For example, with a default BlurDownscaleFactor of 0.25, the step size is 8. To ensure proper functionality, a minimum blurRadius value of 2 steps is required, with intensity updates occurring at every step size increment.

Methods

View Source

AddBlurOpacityAnimation(Animation, AlphaFunction, TimePeriod, float, float)

Adds blur opacity animation to the effect. Basically it is to animate blurring clear texture, but when starting value(fromValue) is bigger than the end value(toValue), it may show a reversed animation that instead clarifies blurred texture.

Declaration
public void AddBlurOpacityAnimation(Animation animation, AlphaFunction alphaFunction, TimePeriod timePeriod, float fromValue, float toValue)
Parameters
Type Name Description
Animation animation

Animation instance to add blur opacity animation.
AlphaFunction alphaFunction

The alpha function to apply. If none, it will use animation's default alpha function.
TimePeriod timePeriod

Duration of animation. If none, it will use the animation's duration.
float fromValue

Starting blur opacity value of the animation. The value resides in range of [0,1].
float toValue

End of blur opacity value of the animation. The value resides in range of [0,1].
View Source

AddBlurStrengthAnimation(Animation, AlphaFunction, TimePeriod, float, float)

Adds blur strength animation to the effect. Basically it is to animate blurring clear texture, but when starting value(fromValue) is bigger than the end value(toValue), it may show a reversed animation that instead clarifies blurred texture.

Declaration
public void AddBlurStrengthAnimation(Animation animation, AlphaFunction alphaFunction, TimePeriod timePeriod, float fromValue, float toValue)
Parameters
Type Name Description
Animation animation

Animation instance to add blur strength animation.
AlphaFunction alphaFunction

The alpha function to apply. If none, it will use animation's default alpha function.
TimePeriod timePeriod

Duration of animation. If none, it will use the animation's duration.
float fromValue

Starting blur strength value of the animation. The value resides in range of [0,1].
float toValue

End of blur strength value of the animation. The value resides in range of [0,1].
View Source

SetSourceView(View)

Set specific source view of background blur effects. If empty handle, works same as normal.

Declaration
public void SetSourceView(View sourceView)
Parameters
Type Name Description
View sourceView

The source actor of background blur effects.
Remarks

If given source view is not a parent of source control, it has no efforts. RenderEffect didn't hold source view reference.

View Source

SetStopperView(View)

Set specific stopper view of background blur effects. If empty handle, works same as normal.

Declaration
public void SetStopperView(View stopperView)
Parameters
Type Name Description
View stopperView

The stopper actor of background blur effects.
Remarks

RenderEffect didn't hold stopper view reference.

Events

View Source

Finished

Event when blur once finishes rendering. Does nothing when blur once is set to false(which redraws every frame).

Declaration
public event EventHandler Finished
Event Type
Type Description
EventHandler

Implements

System.IDisposable

Extension Methods