mcut SDK

mcut SDK / compositor/src / WebGPUBackend

Class: WebGPUBackend

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:78

Implements

• RenderBackend

Properties

height

readonly height: number;

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:81

Implementation of

RenderBackend.height

kind

readonly kind: "webgpu" = 'webgpu';

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:79

Implementation of

RenderBackend.kind

width

readonly width: number;

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:80

Implementation of

RenderBackend.width

Methods

acquireRaster()

acquireRaster(): Canvas2D;

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:284

The frame-space canvas2d context for raster content. Acquiring it marks the raster surface dirty so the backend composites it in z-order; renderers that only need it for text measurement still go through here (text rasterizes anyway).

Returns

Canvas2D

Implementation of

RenderBackend.acquireRaster

beginFrame()

beginFrame(backgroundColor): void;

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:233

Parameters

backgroundColor

string

Returns

void

Implementation of

RenderBackend.beginFrame

dispose()

dispose(): void;

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:322

Free GPU resources. The backend is unusable afterwards.

Returns

void

drawImageQuad()

drawImageQuad(quad, chrome): void;

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:297

Composite a media quad with chrome — the GPU fast path. Backends without one (or layers a backend cannot run, e.g. raw css filters on WebGPU) draw it through the raster context instead.

Parameters

quad

ImageQuad

chrome

LayerChrome

Returns

void

Implementation of

RenderBackend.drawImageQuad

endFrame()

endFrame(): void;

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:251

Returns

void

Implementation of

RenderBackend.endFrame

popRasterScope()

popRasterScope(): void;

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:293

Returns

void

Implementation of

RenderBackend.popRasterScope

pushRasterScope()

pushRasterScope(): void;

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:289

While a raster scope is open, every draw — including image quads — lands on the raster context, so canvas2d state (clips, alpha, transforms) set by the caller applies. Transition mixes and motion-blur accumulation need this. Scopes nest.

Returns

void

Implementation of

RenderBackend.pushRasterScope

registerLut3D()

registerLut3D(
   lutId,
   size,
   data): void;

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:198

Register a 3D LUT for lut3d effects: data is size³ RGB triples (0..1, red fastest), flattened to a (size² × size) 2D texture.

Parameters

lutId

string

size

number

data

Float32Array

Returns

void

create()

static create(options): Promise<WebGPUBackend>;

Defined in: packages/compositor/src/webgpu/webgpu-backend.ts:114

Parameters

options

WebGPUBackendOptions

Returns

Promise<WebGPUBackend>