Interface: Markers3D

Experimental

3D sprite markers: a MarkerSet with 3D blending and optional depth sorting.

Implements

• Primitive<MarkerData>
• PickablePrimitive

Properties

Property	Modifier	Type	Default value	Description
markers	readonly	MarkerSet	undefined	Experimental The underlying marker set (its object is object).
object	readonly	Mesh	undefined	Experimental Root object to add to a viewport's scene.
pickKind	readonly	PickElementKind	'point'	Experimental What a pick id offset counts (e.g. 'point' for markers).

Accessors

count

Get Signature

get count(): number;

Experimental

Number of drawn markers.

Returns

number

---

opaque

Get Signature

get opaque(): boolean;

Experimental

Whether the markers are drawn opaque (depth-writing, see blend3d.ts).

Returns

boolean

---

pickCount

Get Signature

get pickCount(): number;

Experimental

Number of pick ids (one per marker; ids are data indices).

Returns

number

Implementation of

PickablePrimitive.pickCount;

---

ready

Get Signature

get ready(): Promise<void>;

Experimental

Resolves once custom symbols and images are ready (see MarkerSet.ready).

Returns

Promise<void>

Methods

createPickMaterial()

createPickMaterial(): PickMaterialHandle;

Experimental

The marker set's pick material (E2.13); while depth-sorted it writes each instance's data index (aSourceIndex) instead of its instance index.

Returns

PickMaterialHandle

Implementation of

PickablePrimitive.createPickMaterial;

---

dispose()

dispose(): void;

Experimental

Release GPU resources. The primitive must not be used afterwards.

Returns

void

Implementation of

Primitive.dispose;

---

setTransform()

setTransform(transform): void;

Experimental

Set the data → world transform (cheap: uniforms only, no buffer uploads).

Parameters

Parameter	Type
transform	DataTransform

Returns

void

Implementation of

Primitive.setTransform;

---

setViewport()

setViewport(size): void;

Experimental

Update viewport-dependent uniforms (resolution, pixel ratio).

Parameters

Parameter	Type
size	ViewportSize

Returns

void

Implementation of

Primitive.setViewport;

---

sourceIndex()

sourceIndex(slot): number;

Experimental

Data index drawn in instance slot slot (differs from slot only while depth-sorted).

Parameters

Parameter	Type
slot	number

Returns

number

---

update()

update(data): void;

Experimental

Replace or patch the primitive's data. Omitted fields keep their previous values.

Parameters

Parameter	Type
data	Partial<MarkerData>

Returns

void

Implementation of

Primitive.update;