Base class for all image overlays. Provides the interface that ImageOverlayPlugin uses to
fetch, lock, and release overlay textures.
On this page
Properties
Download queue managing the overlay's concurrent image downloads per server origin.
Methods
new ImageOverlay(
options?: {
// Opacity of the overlay layer (0–1).
opacity: number = 1,
// Tint color multiplied with the overlay texture.
color: number | Color = 0xffffff,
// World-space transform defining the plane for planar projection. If null, cartographic (lat/lon) projection is used instead.
frame: Matrix4 = null,
// Optional function `(url) => url` called before every fetch to allow URL rewriting or token injection.
preprocessURL: function = null,
// If true, the overlay alpha channel masks the underlying tile surface rather than blending on top of it.
alphaMask: boolean = false,
// If true, inverts the alpha channel before applying the mask or blend.
alphaInvert: boolean = false
}
)