mcut SDK

mcut SDK / compositor/src / RenderFrameOptions

Interface: RenderFrameOptions

Defined in: packages/compositor/src/types.ts:20

Properties

backgroundColor?

optional backgroundColor?: string;

Defined in: packages/compositor/src/types.ts:24

Canvas background. Default black.

createScratchContext?

optional createScratchContext?: (width, height) => Canvas2D | null;

Defined in: packages/compositor/src/types.ts:41

Scratch surface factory for motion-blur accumulation; the context is cleared before each use. Defaults to a cached OffscreenCanvas — environments without one (and tests) inject this. Return null to disable motion blur.

Parameters

width

number

height

number

Returns

Canvas2D | null

motionBlurSamples?

optional motionBlurSamples?: number;

Defined in: packages/compositor/src/types.ts:34

Sub-frame passes for per-element motion blur (see motion-blur.ts). Default 8; export passes 16.

skipElementIds?

optional skipElementIds?: ReadonlySet<string>;

Defined in: packages/compositor/src/types.ts:29

Elements to leave out of the frame — e.g. a text element while a DOM inline editor is overlaid on it (the editor IS its WYSIWYG render).

source?

optional source?: FrameSource;

Defined in: packages/compositor/src/types.ts:22

Pixel source for video/image assets. Omit to render only vector elements.