# 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)

*** ** * ** ***


```
public final class SurfaceEntity.EdgeFeatheringParams.RectangleFeather extends SurfaceEntity.EdgeFeatheringParams
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.xr.scenecore.SurfaceEntity.EdgeFeatheringParams](https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams) ||
|   | ↳ | [androidx.xr.scenecore.SurfaceEntity.EdgeFeatheringParams.RectangleFeather](https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams.RectangleFeather) |

*** ** * ** ***

## Summary

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

| ### Public methods |
|---|---|
| `final float` | `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams.RectangleFeather#getLeftRight()()` 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. |
| `final float` | `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams.RectangleFeather#getTopBottom()()` 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)

```
public RectangleFeather(
    @FloatRange(from = 0.0, to = 0.5) float leftRight,
    @FloatRange(from = 0.0, to = 0.5) float topBottom
)
```

## Public methods

### getLeftRight

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

```
public final float getLeftRight()
```

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.

### getTopBottom

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

```
public final float getTopBottom()
```

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/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.