# BlurredEdgeTreatment

Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/draw/Blur.kt+class:androidx.compose.ui.draw.BlurredEdgeTreatment) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.1.0) Common/All
- Cmn

  ```
  value class BlurredEdgeTreatment
  ```

*** ** * ** ***

Determines the strategy used to render pixels in the blurred result that may extend beyond the bounds of the original input.

`https://developer.android.com/reference/kotlin/androidx/compose/ui/draw/BlurredEdgeTreatment` will clip the blur result to the boundaries of the original content and optionally specified `https://developer.android.com/reference/kotlin/androidx/compose/ui/draw/BlurredEdgeTreatment#shape()`.

Sampling of pixels outside of content bounds will have the same value as the pixels at the closest edge. This is recommended for blurring content that does not contain transparent pixels and ensuring the blurred result does not extend beyond the original bounds (ex. blurring an image)

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/TileMode#Clamp()` | Alternatively using `https://developer.android.com/reference/kotlin/androidx/compose/ui/draw/BlurredEdgeTreatment#Unbounded()` will not clip the blur result to the boundaries of the original content. Sampling of pixels outside of the content bounds will sample transparent black instead. This is recommended for blurring content that is intended to render outside of the original bounds and may contain transparent pixels in the original bounds (ex. blurring an arbitrary shape or text) |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/TileMode#Decal()` |   |

## Summary

| ### Public companion properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/draw/BlurredEdgeTreatment` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/draw/BlurredEdgeTreatment#Rectangle()` Bounded `https://developer.android.com/reference/kotlin/androidx/compose/ui/draw/BlurredEdgeTreatment` that clips content bounds to a rectangular shape | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/draw/BlurredEdgeTreatment` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/draw/BlurredEdgeTreatment#Unbounded()` Do not clip the blur result to the boundaries of the original content. | Cmn |

| ### Public constructors |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/draw/BlurredEdgeTreatment#BlurredEdgeTreatment(androidx.compose.ui.graphics.Shape)(shape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape?)` | Cmn |

| ### Public properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape?` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/draw/BlurredEdgeTreatment#shape()` | Cmn |

## Public companion properties

### Rectangle

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

```
val Rectangle: BlurredEdgeTreatment
```

Bounded `https://developer.android.com/reference/kotlin/androidx/compose/ui/draw/BlurredEdgeTreatment` that clips content bounds to a rectangular shape

### Unbounded

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

```
val Unbounded: BlurredEdgeTreatment
```

Do not clip the blur result to the boundaries of the original content. Sampling of pixels outside of the content bounds will sample transparent black instead. This is recommended for blurring content that is intended to render outside of the original bounds and may contain transparent pixels in the original bounds (ex. blurring an arbitrary shape or text)

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/TileMode#Decal()` |   |

## Public constructors

### BlurredEdgeTreatment

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

```
BlurredEdgeTreatment(shape: Shape?)
```

## Public properties

### shape

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

```
val shape: Shape?
```