mapsglmaps/com.xweather.mapsgl.layers.spec/MaskLayerKind

MaskLayerKind

enum MaskLayerKind : Enum<MaskLayerKind>

Built-in GLES stencil mask kinds for weather / bitmap layers (JS mask: "land"|"water"|…).

Prefer LayerMaskSpec / StencilLayerMaskSpec on layer descriptors when clipping to arbitrary style layers. TRANSPORTATION and COUNTRY draw along line ribbons; LAND / WATER fill area geometry.

Entries

NONE

No built-in stencil mask; layer draws everywhere unless a custom stencil mask is also set.

LAND

Draw only on land (inverted water stencil from com.xweather.mapsgl.map.mapbox.GlStencilOsm).

WATER

Draw only on water (marine water stencil from com.xweather.mapsgl.map.mapbox.GlStencilOsm).

TRANSPORTATION

GLES stencil: all features in the MVT transportation source-layer from com.xweather.mapsgl.map.mapbox.GlStencilOsm (same tiles as marine land/water). Weather draws only along road geometry (line ribbon), similar to WATER.

COUNTRY

GLES stencil: country border geometry from com.xweather.mapsgl.map.mapbox.GlStencilOsm tiles — Mapbox Streets admin (admin_level 0) or MapsGL boundary (admin_level 2). Requires BitmapLayerDescriptor.maskCountryIso3166Alpha2 (e.g. "US", "ES"). Draw only along matched borders (line ribbon), same stencil test as WATER.

Properties

entries

val entries: EnumEntries<MaskLayerKind>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): MaskLayerKind

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<MaskLayerKind>

Returns an array containing the constants of this enum type, in the order they're declared.