mapbox-maps-android/com.mapbox.maps.extension.compose.style.atmosphere.generated

Package-level declarations

Types

class AtmosphereState(initialProperties: Map<String, Value> = mapOf())

A global effect that fades layers and markers based on their distance to the camera. The fog can be used to approximate the effect of atmosphere on distant objects and enhance the depth perception of the map when used with terrain or 3D features. Note: fog is renamed to atmosphere in the Android and iOS SDKs and planned to be changed in GL-JS v.3.0.0.

Color

@Immutable

@MapboxExperimental

data class Color(val value: Value)

The color of the atmosphere region immediately below the horizon and within the range and above the horizon and within horizon-blend. Using opacity is recommended only for smoothly transitioning fog on/off as anything less than 100% opacity results in more tiles loaded and drawn.

HighColor

@Immutable

@MapboxExperimental

data class HighColor(val value: Value)

The color of the atmosphere region above the horizon, high-color extends further above the horizon than the color property and its spread can be controlled with horizon-blend. The opacity can be set to 0 to remove the high atmosphere color contribution.

HorizonBlend

@Immutable

@MapboxExperimental

data class HorizonBlend(val value: Value)

Horizon blend applies a smooth fade from the color of the atmosphere to the color of space. A value of zero leaves a sharp transition from atmosphere to space. Increasing the value blends the color of atmosphere into increasingly high angles of the sky.

Range

@Immutable

@MapboxExperimental

data class Range(val value: Value)

The start and end distance range in which fog fades from fully transparent to fully opaque. The distance to the point at the center of the map is defined as zero, so that negative range values are closer to the camera, and positive values are farther away.

SpaceColor

@Immutable

@MapboxExperimental

data class SpaceColor(val value: Value)

The color of the region above the horizon and after the end of the horizon-blend contribution. The opacity can be set to 0 to have a transparent background.

StarIntensity

@Immutable

@MapboxExperimental

data class StarIntensity(val value: Value)

A value controlling the star intensity where 0 will show no stars and 1 will show stars at their maximum intensity.

VerticalRange

@Immutable

@MapboxExperimental

data class VerticalRange(val value: Value)

An array of two number values, specifying the vertical range, measured in meters, over which the fog should gradually fade out. When both parameters are set to zero, the fog will be rendered without any vertical constraints.

Functions

rememberAtmosphereState

@Composable

@MapboxExperimental

inline fun rememberAtmosphereState(key: String? = null, crossinline init: AtmosphereState.() -> Unit = {}): AtmosphereState

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