Skip to content

Class: GPULayerCompositor

Defined in: src/GPULayerCompositor.ts:10

GPU-accelerated layer compositor using custom shaders Performs layer blending on the GPU for massive performance improvements

Constructors

Constructor

ts
new GPULayerCompositor(vertexCount, maxLayers?): GPULayerCompositor;

Defined in: src/GPULayerCompositor.ts:17

Parameters

vertexCount

number

maxLayers?

number = 8

Returns

GPULayerCompositor

Methods

updateLayers()

ts
updateLayers(layers): void;

Defined in: src/GPULayerCompositor.ts:328

Update layer data in GPU textures

Parameters

layers

Layer[]

Returns

void


getMaterial()

ts
getMaterial(): ShaderMaterial | null;

Defined in: src/GPULayerCompositor.ts:458

Get the shader material for use with Three.js mesh

Returns

ShaderMaterial | null


setBaseColor()

ts
setBaseColor(color): void;

Defined in: src/GPULayerCompositor.ts:465

Update base color

Parameters

color

ColorRepresentation

Returns

void


setClipPlanes()

ts
setClipPlanes(clipPlanes): void;

Defined in: src/GPULayerCompositor.ts:474

Update clip planes from a ClipPlaneSet

Parameters

clipPlanes

ClipPlaneSet

Returns

void


setClipPlane()

ts
setClipPlane(axis, plane): void;

Defined in: src/GPULayerCompositor.ts:501

Update a single clip plane

Parameters

axis

"x" | "y" | "z"

plane

ClipPlane

Returns

void


clearClipPlanes()

ts
clearClipPlanes(): void;

Defined in: src/GPULayerCompositor.ts:515

Clear all clip planes (disable them)

Returns

void


dispose()

ts
dispose(): void;

Defined in: src/GPULayerCompositor.ts:527

Dispose of GPU resources

Returns

void

Released under the MIT License.