# BlurEffect

Artifact: [androidx.compose.ui:ui-graphics](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/graphics/+class:androidx.compose.ui.graphics.BlurEffect) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.1.0) Common/AllAndroid/JVM
- Cmn

  ```
  class BlurEffect : RenderEffect
  ```

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.compose.ui.graphics.RenderEffect](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect) ||
|   | ↳ | [androidx.compose.ui.graphics.BlurEffect](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/BlurEffect) |

*** ** * ** ***

`https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect` that will blur the contents of an optional input `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect`. If no input `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect` is provided, the drawing commands on the `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/GraphicsLayerScope` this `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect` is configured on will be blurred.

## Summary

| ### Public constructors |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/BlurEffect#BlurEffect(androidx.compose.ui.graphics.RenderEffect,kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.TileMode)( renderEffect: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect?, radiusX: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, radiusY: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, edgeTreatment: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/TileMode )` | Cmn android |

| ### Public functions |
|---|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/BlurEffect#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` | android |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/BlurEffect#hashCode()()` | android |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/BlurEffect#toString()()` | android |

| ### Protected functions |
|---|---|---|
| `open https://developer.android.com/reference/android/graphics/RenderEffect.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 31) https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/BlurEffect#createRenderEffect()()` | android |

| ### Inherited functions |
|---|
| From [androidx.compose.ui.graphics.RenderEffect](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect) |---|---|---| | `https://developer.android.com/reference/android/graphics/RenderEffect.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 31) https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect#asAndroidRenderEffect()()` Obtain a `https://developer.android.com/reference/android/graphics/RenderEffect.html` from the compose `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect` | android | | `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect#isSupported()()` Capability query to determine if the particular platform supports the `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect`. | Cmn android | |

## Public constructors

### BlurEffect

Cmn android Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.9.0)

```
BlurEffect(
    renderEffect: RenderEffect?,
    radiusX: Float,
    radiusY: Float = radiusX,
    edgeTreatment: TileMode = TileMode.Clamp
)
```

| Parameters |
|---|---|
| `renderEffect: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect?` | Optional input `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/RenderEffect` to be blurred |
| `radiusX: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | Blur radius in the horizontal direction |
| `radiusY: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = radiusX` | Blur radius in the vertical direction |
| `edgeTreatment: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/TileMode = TileMode.Clamp` | Strategy used to render pixels outside of bounds of the original input |

## Public functions

### equals

android

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

android

```
open fun hashCode(): Int
```

### toString

android

```
open fun toString(): String
```

## Protected functions

### createRenderEffect

android

```
@RequiresApi(value = 31)
protected open fun createRenderEffect(): RenderEffect
```