RenderOptions

@Immutable
actual data class RenderOptions(source)

Represents configuration options for rendering behavior in a map view. This includes options such as the type of rendered surface, debug settings, and performance-specific parameters.

Parameters

renderMode

Determines the type of graphical surface to use for rendering. Options include RenderMode.SurfaceView for higher performance or RenderMode.TextureView for improved compatibility with certain transformations, at a significant performance cost.

foregroundLoadColor

Sets the color displayed in the foreground while the map is initializing.

isDebugEnabled

Sets whether debug overlays are shown.

maximumFps

Specifies the maximum frame rate for rendering the map view. The value is limited by the device's hardware capabilities.

@Immutable
expect class RenderOptions(source)

Configures platform-specific map rendering options.

The companion object provides some presets available from common code, but fine-grained customization on multiple platforms requires configuring these options in expect/actual code.

@Immutable
actual data class RenderOptions(source)
@Immutable
actual data class RenderOptions(source)

Parameters

maximumFps

The maximum frame rate at which the map view is rendered. It can't exceed the ability of device hardware.

debugSettings

Options for enabling debugging features.

@Immutable
actual data class RenderOptions(source)

Parameters

debugSettings

Options for enabling debugging features.

Constructors

Link copied to clipboard
constructor(renderMode: RenderOptions.RenderMode = RenderMode.SurfaceView, foregroundLoadColor: Color = Color.Transparent, isDebugEnabled: Boolean = false, maximumFps: Int? = null)
constructor(debugOptions: MapDebugOptions = MapDebugOptions(), maximumFps: Int? = null)
constructor(maximumFps: Int? = null, debugSettings: RenderOptions.DebugSettings = DebugSettings())
constructor(debugSettings: RenderOptions.DebugSettings = DebugSettings())

Types

Link copied to clipboard
actual object Companion
expect object Companion
actual object Companion
actual object Companion
actual object Companion
DebugSettings
Link copied to clipboard
@Immutable
data class DebugSettings(val isTileBoundariesEnabled: Boolean = false, val isTileInfoEnabled: Boolean = false, val isTimestampsEnabled: Boolean = false, val isCollisionBoxesEnabled: Boolean = false, val isOverdrawVisualizationEnabled: Boolean = false)
@Immutable
data class DebugSettings(val showCollisionBoxes: Boolean = false, val showTileBoundaries: Boolean = false, val showPadding: Boolean = false, val showOverdrawInspector: Boolean = false)
Link copied to clipboard

Properties

Link copied to clipboard
val debugOptions: MapDebugOptions
debugSettings
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val isDebugEnabled: Boolean = false
maximumFps
Link copied to clipboard
val maximumFps: Int? = null
val maximumFps: Int? = null
val maximumFps: Int? = null
Link copied to clipboard