Layer
object LayerMasks
Factory helpers mirroring the MapsGL JS LayerMaskSpecification.
Use on weather layer descriptors (com.xweather.mapsgl.layers.spec.SampleLayerDescriptor.layerMask, etc.) or raster descriptors (RasterLayerDescriptor.layerMask).
Functions
Link copied to clipboard
JS: mask: { type: 'land' } — temperatures (and other weather tiles) only over land.
Link copied to clipboard
fun landAndRoads(roadLayerId: String = "road-motorway", roadMaskId: String? = "road-motorway::mask", roadStrokeThickness: Double? = null, mode: StencilMaskCombineMode = StencilMaskCombineMode.ALL): LayerMaskSpec
JS docs “countries + motorways” example: built-in land ∩ visible motorway lines.
Link copied to clipboard
fun layerIds(vararg ids: String, mode: StencilMaskCombineMode = StencilMaskCombineMode.ALL, invert: Boolean = false): LayerMaskSpec
JS: mask: { layerIds: ['admin-mask'] } (shorthand for a single custom mask layer).
Link copied to clipboard
fun layers(vararg configs: LayerMaskLayerConfig, mode: StencilMaskCombineMode = StencilMaskCombineMode.ALL, invert: Boolean? = null): LayerMaskSpec
JS: mask: { layers: [{ id: 'countries' }, { id: 'road-motorway' }], mode: 'all' }.
Link copied to clipboard
JS: mask: { type: 'water' }