mcut SDK

mcut SDK / react/src / PlayerCanvasProps

Interface: PlayerCanvasProps

Defined in: packages/react/src/player-canvas.tsx:52

Properties

background?

optional background?: string;

Defined in: packages/react/src/player-canvas.tsx:57

Project background color. Default black.

className?

optional className?: string;

Defined in: packages/react/src/player-canvas.tsx:53

hiddenElementIds?

optional hiddenElementIds?: ReadonlySet<string>;

Defined in: packages/react/src/player-canvas.tsx:62

Elements left out of the render — e.g. a text element while a DOM inline editor overlays it (renderFrame's skipElementIds).

interactive?

optional interactive?: boolean;

Defined in: packages/react/src/player-canvas.tsx:55

Enable canvas selection/move/resize/rotate. Default true.

onElementDoubleClick?

optional onElementDoubleClick?: (elementId) => void;

Defined in: packages/react/src/player-canvas.tsx:64

Double-click on an element (topmost hit). Hosts use it to open editors.

Parameters

elementId

`e-${string}`

Returns

void

quality?

optional quality?: PreviewQuality;

Defined in: packages/react/src/player-canvas.tsx:71

Preview raster resolution; 'auto' (default) matches the displayed size. A 4K project in an ~800px pane rasters ~20× fewer pixels per frame than 'full', which is usually the difference between smooth and dropped playback on big projects.

renderer?

optional renderer?: "canvas2d" | "webgpu";

Defined in: packages/react/src/player-canvas.tsx:77

Compositor backend. 'webgpu' renders through the WebGPU pass pipeline (requires navigator.gpu; falls back to canvas2d when unavailable or when device initialization fails). Default 'webgpu'.