lightAnchor

Functions summary

Modifier

Reports this composable's position to state, so that lights positioned with LightPosition.Anchored against the same state follow this composable.

Cmn

Functions

Modifier.lightAnchor

fun Modifier.lightAnchor(state: LightAnchorState): Modifier

Reports this composable's position to state, so that lights positioned with LightPosition.Anchored against the same state follow this composable.

Create state with remember and pass the same instance to this modifier and to every LightPosition.Anchored that should track it.

A given LightAnchorState tracks one composable at a time. If this modifier is applied to more than one composable simultaneously, the state reports whichever was placed most recently, which is rarely what was intended. When the anchored composable leaves the composition the state is cleared and the lights using it stop contributing.

import androidx.compose.animation.core.animateDpAsState
import androidx.compose.foundation.background
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.offset
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.lighting.LightAnchorState
import androidx.compose.ui.lighting.LightPosition
import androidx.compose.ui.lighting.PointLight
import androidx.compose.ui.lighting.SurfaceGeometrySpec
import androidx.compose.ui.lighting.SurfaceMaterial
import androidx.compose.ui.lighting.illuminate
import androidx.compose.ui.lighting.lightAnchor
import androidx.compose.ui.unit.IntOffset
import androidx.compose.ui.unit.dp

// A single anchor, shared by the composable that defines the light's position and by the
// light itself.
val anchor = remember { LightAnchorState() }

var moved by remember { mutableStateOf(false) }
val lightX by animateDpAsState(if (moved) 200.dp else 24.dp, label = "lightX")

// Since our light color is white, we set a darker background so that its visible.
val surfaceColor = remember { Color.Black }
val surfaceShape = remember { RoundedCornerShape(24.dp) }

Box(Modifier.size(240.dp).clickable { moved = !moved }) {
    // The light using this anchor will now follow this composable
    Box(
        Modifier.offset { IntOffset(x = lightX.roundToPx(), y = 24.dp.roundToPx()) }
            .size(16.dp)
            .lightAnchor(anchor)
    )

    Box(
        Modifier.align(Alignment.Center)
            .size(160.dp)
            .background(surfaceColor)
            .illuminate(
                lights =
                    listOf(
                        PointLight(
                            color = Color.White,
                            position = LightPosition.Anchored(anchor),
                            elevation = 48.dp,
                            falloffRadius = 320.dp,
                            intensity = 1f,
                        )
                    ),
                surfaceMaterial =
                    SurfaceMaterial.diffuse(Color.White).specular(Color.White, shininess = 32f),
                surfaceGeometrySpec =
                    SurfaceGeometrySpec.convex(
                        shape = surfaceShape,
                        thickness = 1.dp,
                        bevelWidth = 12.dp,
                    ),
            )
    )
}
Parameters
state: LightAnchorState

the anchor to publish this composable's position to.