{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

BlurEffect

public final class BlurEffect extends RenderEffect

java.lang.Object
   ↳ androidx.compose.ui.graphics.RenderEffect
     ↳ androidx.compose.ui.graphics.BlurEffect

RenderEffect that will blur the contents of an optional input RenderEffect. If no input RenderEffect is provided, the drawing commands on the GraphicsLayerScope this RenderEffect is configured on will be blurred.

Summary

Public constructors

BlurEffect(
    RenderEffect renderEffect,
    float radiusX,
    float radiusY,
    @NonNull TileMode edgeTreatment
)

Public methods

boolean
equals(Object other)
int
@NonNull String

Protected methods

@NonNull RenderEffect

Inherited methods

From androidx.compose.ui.graphics.RenderEffect
final @NonNull RenderEffect

Obtain a android.graphics.RenderEffect from the compose RenderEffect

boolean

Capability query to determine if the particular platform supports the RenderEffect.

Public constructors

BlurEffect

public BlurEffect(
    RenderEffect renderEffect,
    float radiusX,
    float radiusY,
    @NonNull TileMode edgeTreatment
)
Parameters
float radiusX

Blur radius in the horizontal direction

float radiusY

Blur radius in the vertical direction

@NonNull TileMode edgeTreatment

Strategy used to render pixels outside of bounds of the original input

Public methods

equals

public boolean equals(Object other)

hashCode

public int hashCode()

toString

public @NonNull String toString()

Protected methods

createRenderEffect

@RequiresApi
protected @NonNull RenderEffect createRenderEffect()