Package-level declarations

Types

Link copied to clipboard

An indirect light affecting all objects in the map adding a constant amount of light on them. It has no explicit direction and cannot cast shadows.

Link copied to clipboard

Whether extruded geometries are lit relative to the map or viewport. Default value: "viewport".

Link copied to clipboard

A light that has a direction and is located at infinite distance, so its rays are parallel. It simulates the sun light and can cast shadows.

Link copied to clipboard

A global directional light source which is only applied on 3D and hillshade layers. Using this type disables other light sources.

Functions

Link copied to clipboard
inline fun rememberAmbientLightState(id: String = remember { generateRandomLightId("ambient") }, key: String? = null, crossinline init: AmbientLightState.() -> Unit = {}): AmbientLightState

Create and rememberSaveable a AmbientLightState using Saver. init will be called when the AmbientLightState is first created to configure its initial state.

Link copied to clipboard
inline fun rememberDirectionalLightState(id: String = remember { generateRandomLightId("directional") }, key: String? = null, crossinline init: DirectionalLightState.() -> Unit = {}): DirectionalLightState

Create and rememberSaveable a DirectionalLightState using Saver. init will be called when the DirectionalLightState is first created to configure its initial state.

Link copied to clipboard
inline fun rememberFlatLightState(id: String = remember { generateRandomLightId("flat") }, key: String? = null, crossinline init: FlatLightState.() -> Unit = {}): FlatLightState

Create and rememberSaveable a FlatLightState using Saver. init will be called when the FlatLightState is first created to configure its initial state.