# ElevationOverlay

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

  ```
  interface ElevationOverlay
  ```

*** ** * ** ***

An ElevationOverlay is an overlay applied to the background color of `https://developer.android.com/reference/kotlin/androidx/compose/material/Surface.composable#Surface(androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.foundation.BorderStroke,androidx.compose.ui.unit.Dp,kotlin.Function0)` components, used to emphasize elevation in dark theme, where shadows are not as visible. An ElevationOverlay does not replace the shadows drawn by a `https://developer.android.com/reference/kotlin/androidx/compose/material/Surface.composable#Surface(androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.foundation.BorderStroke,androidx.compose.ui.unit.Dp,kotlin.Function0)`, but is used as an additional representation of elevation.

The default ElevationOverlay only applies in dark theme (!`https://developer.android.com/reference/kotlin/androidx/compose/material/Colors#isLight()`), in accordance with the Material specification for [Dark Theme](https://material.io/design/color/dark-theme.html#properties).

See `https://developer.android.com/reference/kotlin/androidx/compose/material/package-summary#LocalElevationOverlay()` to provide your own `https://developer.android.com/reference/kotlin/androidx/compose/material/ElevationOverlay`. You can provide `null` to have no ElevationOverlay applied.

## Summary

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material/ElevationOverlay#apply(androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp)(color: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, elevation: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp)` Returns the new background `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` to use, representing the original background `https://developer.android.com/reference/kotlin/androidx/compose/material/ElevationOverlay#apply(androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp)` with an overlay corresponding to `https://developer.android.com/reference/kotlin/androidx/compose/material/ElevationOverlay#apply(androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp)` applied. | Cmn |

## Public functions

### apply

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

```
@Composable
fun apply(color: Color, elevation: Dp): Color
```

Returns the new background `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` to use, representing the original background `https://developer.android.com/reference/kotlin/androidx/compose/material/ElevationOverlay#apply(androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp)` with an overlay corresponding to `https://developer.android.com/reference/kotlin/androidx/compose/material/ElevationOverlay#apply(androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp)` applied. Typically this should only be applied to `https://developer.android.com/reference/kotlin/androidx/compose/material/Colors#surface()`.