# SurfaceEntity.EdgeFeatheringParams.RectangleFeather

Artifact: [androidx.xr.scenecore:scenecore](https://developer.android.com/jetpack/androidx/releases/xr-scenecore) [View Source](https://cs.android.com/search?q=file:androidx/xr/scenecore/SurfaceEntity.kt+class:androidx.xr.scenecore.SurfaceEntity.EdgeFeatheringParams.RectangleFeather) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

*** ** * ** ***


```
class SurfaceEntity.EdgeFeatheringParams.RectangleFeather : SurfaceEntity.EdgeFeatheringParams
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.xr.scenecore.SurfaceEntity.EdgeFeatheringParams](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams) ||
|   | ↳ | [androidx.xr.scenecore.SurfaceEntity.EdgeFeatheringParams.RectangleFeather](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams.RectangleFeather) |

*** ** * ** ***

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams.RectangleFeather#RectangleFeather(kotlin.Float,kotlin.Float)( leftRight: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0, to = 0.5) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, topBottom: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0, to = 0.5) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html )` |

| ### Public properties |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0, to = 0.5) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams.RectangleFeather#leftRight()` a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` which controls the shape-relative radius of the edge fadeout on the left and right edges of the SurfaceEntity canvas. |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0, to = 0.5) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams.RectangleFeather#topBottom()` a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` which controls the shape-relative radius of the edge fadeout on the top and bottom edges of the SurfaceEntity canvas. |

## Public constructors

### RectangleFeather

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
RectangleFeather(
    leftRight: @FloatRange(from = 0.0, to = 0.5) Float = 0.0f,
    topBottom: @FloatRange(from = 0.0, to = 0.5) Float = 0.0f
)
```

## Public properties

### leftRight

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
val leftRight: @FloatRange(from = 0.0, to = 0.5) Float
```

a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` which controls the shape-relative radius of the edge fadeout on the left and right edges of the SurfaceEntity canvas.

### topBottom

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
val topBottom: @FloatRange(from = 0.0, to = 0.5) Float
```

a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` which controls the shape-relative radius of the edge fadeout on the top and bottom edges of the SurfaceEntity canvas.

A radius of 0.05 represents 5% of the width of the visible canvas surface. Please note that this is scaled by the aspect ratio of Quad-shaped canvases.

Applications are encouraged to use `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams.NoFeathering` on Spherical canvases. The behavior is only defined for values between 0.0f - 0.5f. Default values are 0.0f.