Compose Modifier

lightAnchor

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

LightAnchorSample

@Sampled
@Composable
fun LightAnchorSample() {
    // 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,
                        ),
                )
        )
    }
}
Jetpack Compose beyond MaterialFree components, screens and templates for apps that don’t look like Google’s. Copy them into your app, or let your coding agent add them.Browse for free

Content updated: