Skip to main content
Version: 4.x

Type Alias: Overlay3DCollectionOptions

Overlay3DCollectionOptions: object

Constructor options for the Overlay3DCollection

Type declaration​

defaultOverlayColor?​

optional defaultOverlayColor: Color

The default color to apply to overlay icons without a color on their own

maxPointSize?​

optional maxPointSize: number

The maximum display size of each icon in pixels

overlayTexture?​

optional overlayTexture: Texture

The texture to display as icons in this collection

overlayTextureMask?​

optional overlayTextureMask: Texture

A texture mask for marking what pixels are transparent in the supplied overlayTexture

Defined in​

packages/3d-overlays/src/Overlay3DCollection.ts:17