Skip to content

Interface: Primitive<TData> ​

Experimental

A GPU drawing building block. Implementations must:

  • render all items with a constant number of draw calls (independent of item count),
  • upload only the buffers affected by an update when possible (plan §E16.3),
  • release every acquired resource in dispose.

Type Parameters ​

Type Parameter
TData

Properties ​

PropertyModifierTypeDescription
objectreadonlyObject3DExperimental Root object to add to a viewport's scene.

Methods ​

dispose() ​

ts
dispose(): void;

Experimental

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

Returns ​

void


setTransform() ​

ts
setTransform(transform): void;

Experimental

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

Parameters ​

ParameterType
transformDataTransform

Returns ​

void


setViewport() ​

ts
setViewport(size): void;

Experimental

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

Parameters ​

ParameterType
sizeViewportSize

Returns ​

void


update() ​

ts
update(data): void;

Experimental

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

Parameters ​

ParameterType
dataPartial<TData>

Returns ​

void

Released under the MIT License.