CustomLayerHost(androidJvm)

Interface for hosting a custom map style layer.

interface CustomLayerHost(androidJvm)

Functions

contextLost
Link copied to clipboard

Called when the system has destroyed the underlying GL context. The `deinitialize` function will not be called in this case, however `initialize` will be called instead to prepare for a new render.

abstract fun contextLost()
deinitialize
Link copied to clipboard

Destroy any GL state needed by the custom layer, and deallocate context, if necessary. This method is called once, from the main thread, at a point when the GL context is active. Note that it may be called even when the `initialize` function has not been called.

abstract fun deinitialize()
initialize
Link copied to clipboard

Initialize any GL state needed by the custom layer. This method is called once, from the main thread, at a point when the GL context is active but before rendering for the first time. Resources that are acquired in this method must be released in the `deinitialize` function.

abstract fun initialize()
render
Link copied to clipboard

Render the layer. This method is called once per frame. The implementation should not make any assumptions about the GL state (other than that the correct context is active). It may make changes to the state, and is not required to reset values such as the depth mask, stencil mask, and corresponding test flags to their original values. Make sure that you are drawing your fragments with a z value of 1 to take advantage of the opaque fragment culling in case there are opaque layers above your custom layer.

abstract fun render(parameters: CustomLayerRenderParameters)

Inheritors

CustomLayerHostNative
Link copied to clipboard