Class: HeatmapPrimitive

Experimental

One z grid, one draw call. See the module header for the texture layout and shading rules.

Implements

• Primitive<HeatmapData>

Constructors

Constructor

new HeatmapPrimitive(context, data): HeatmapPrimitive;

Experimental

Parameters

Parameter	Type
context	PrimitiveContext
data	HeatmapInput

Returns

HeatmapPrimitive

Properties

Property	Modifier	Type	Description
object	readonly	Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, ShaderMaterial>	Experimental Root object to add to a viewport's scene.
uniforms	readonly	HeatmapUniforms	Experimental

Accessors

current

Get Signature

get current(): Readonly<HeatmapData>;

Experimental

The current data (with defaults applied).

Returns

Readonly<HeatmapData>

Methods

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

Uniforms only: textures are never touched.

Parameters

Parameter	Type
transform	DataTransform

Returns

void

Implementation of

Primitive.setTransform

---

setViewport()

setViewport(size): void;

Experimental

The viewport size (render targets; the canvas is synced before each draw).

Parameters

Parameter	Type
size	ViewportSize

Returns

void

Implementation of

Primitive.setViewport

---

update()

update(patch): void;

Experimental

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

Parameters

Parameter	Type
patch	Partial<HeatmapData>

Returns

void

Implementation of

Primitive.update