# IlluminationScope

> The receiver of the block passed to [illuminate], used to configure the lighting drawn over the content.

## API Reference

> Source set: Common

```kotlin
public class IlluminationScope internal constructor()
```

The receiver of the block passed to [illuminate](https://composables.com/jetpack-compose/androidx.compose.ui/ui/modifiers/illuminate/api.md), used to configure the lighting drawn over the
content. Each run of the block starts with every property at its default.

Lighting is computed with local illumination, which shades each point of the surface using only
the light that reaches it directly from `lights`, the direction the surface faces at that point
according to `surfaceGeometrySpec`, and how `surfaceMaterial` reflects light. Nothing else on
screen is taken into account, so other composables neither cast shadows onto the surface nor
reflect light onto it.

## Properties

### lights

> Source set: Common

```kotlin
public var lights: List<Light> = emptyList()
```

The lights illuminating the surface, empty to draw only the content. A light positioned with
[LightPosition.Anchored](https://composables.com/jetpack-compose/androidx.compose.ui/ui/classes/LightPosition.Anchored/api.md) contributes nothing until its anchor has been placed.

### surfaceMaterial

> Source set: Common

```kotlin
public var surfaceMaterial: SurfaceMaterial = SurfaceMaterial.None
```

How the surface reflects `lights`. The default `SurfaceMaterial.None` reflects nothing, so no
light is drawn until at least one of its components is set.

### surfaceGeometrySpec

> Source set: Common

```kotlin
public var surfaceGeometrySpec: SurfaceGeometrySpec = DefaultSurfaceGeometrySpec
```

The virtual three-dimensional shape the surface is treated as having. It decides which way
each point of the surface faces, and so which parts catch `lights`. The default is a flat
rectangle with no thickness.

Shapes that lighting does not support throw an `IllegalArgumentException` when the surface is
drawn. See [SurfaceGeometrySpec](https://composables.com/jetpack-compose/androidx.compose.ui/ui/classes/SurfaceGeometrySpec/api.md) for the supported shapes.

## Members

### Companion

> Source set: Common

```kotlin
public companion object
```

## Properties

### MaxLightsAllowed

> Source set: Common

```kotlin
public val MaxLightsAllowed: Int
```

The most lights [illuminate](https://composables.com/jetpack-compose/androidx.compose.ui/ui/modifiers/illuminate/api.md) can apply to a surface, with either overload. Drawing a
surface lit by more lights throws an `IllegalArgumentException`.

## Functions

### isSupported

> Source set: Common

```kotlin
public fun isSupported(): Boolean
```

Capability query to determine if [illuminate](https://composables.com/jetpack-compose/androidx.compose.ui/ui/modifiers/illuminate/api.md) can draw lighting on the current platform.
When this returns `false`, only the content is drawn. On Android, lighting requires
API 33.
