# DepthEffect

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


```
class DepthEffect
```

<br />

*** ** * ** ***

The depth effect establishes a sense of hierarchy by using shadows to occlude content underneath. It consists of two shadow layers, `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/DepthEffect#layer1()` and `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/DepthEffect#layer2()`. `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/DepthEffect#layer2()` is drawn on top of `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/DepthEffect#layer1()`:

```kotlin
 _________________
|    _________    |
|   | content |   |
|   |_________|   |
|   ___________   |
|  |  layer 2  |  |
|  |___________|  |
|  _____________  |
| |   layer 1   | |
| |_____________| |
|_________________|
```

`https://developer.android.com/reference/kotlin/androidx/xr/glimmer/GlimmerTheme#depthEffectLevels()` provides theme defined depth effect levels that should be used to add depth to surfaces.

Higher level components apply the depth effect automatically when needed. The depth effect can also be configured through `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/surface.composable#(androidx.compose.ui.Modifier).surface(kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.xr.glimmer.SurfaceDepthEffect,androidx.compose.foundation.interaction.InteractionSource)`. To manually render depth shadows for advanced use-cases, see the `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/DepthEffect#DepthEffect(androidx.compose.ui.graphics.shadow.Shadow,androidx.compose.ui.graphics.shadow.Shadow)(layer1: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/shadow/Shadow, layer2: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/shadow/Shadow)` |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/DepthEffect#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/DepthEffect#hashCode()()` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/shadow/Shadow` | `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/DepthEffect#layer1()` the 'base' `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/shadow/Shadow` layer, drawn first |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/shadow/Shadow` | `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/DepthEffect#layer2()` the second `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/shadow/Shadow` layer, drawn on top of `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/DepthEffect#layer1()` |

## Public constructors

### DepthEffect

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

```
DepthEffect(layer1: Shadow, layer2: Shadow)
```

## Public functions

### equals

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

### hashCode

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

## Public properties

### layer1

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

```
val layer1: Shadow
```

the 'base' `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/shadow/Shadow` layer, drawn first

### layer2

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

```
val layer2: Shadow
```

the second `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/shadow/Shadow` layer, drawn on top of `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/DepthEffect#layer1()`