Interface: RenderRootOptions
Experimental
Properties
| Property | Type | Description |
|---|---|---|
antialias? | boolean | Experimental MSAA for geometry edges. Default true. |
background? | RGBA | null | Experimental Canvas clear color (sRGB 0–1). null = transparent. Default opaque white. |
createRenderer? | (parameters) => WebGLRenderer | Experimental Injectable renderer factory (tests, or custom renderer setup). |
height? | number | Experimental |
maxPixelRatio? | number | Experimental Upper limit of the automatic pixel ratio. Default 2. |
overlay? | boolean | Experimental Create the figure-level overlay viewport. Default true. |
pixelRatio? | number | Experimental Device pixel ratio. Default min(devicePixelRatio, maxPixelRatio), re-evaluated when the DPR changes. |
powerPreference? | WebGLPowerPreference | Experimental |
preserveDrawingBuffer? | boolean | Experimental Needed for toDataURL after the frame on a root with its own context. Default false. A shared root's canvas always keeps its pixels. |
responsive? | boolean | Experimental Resize with the container via ResizeObserver. Default true. |
scheduler? | FrameScheduler | Experimental Injectable frame scheduler (tests). Default: requestAnimationFrame. |
shared? | boolean | "auto" | Experimental Draw through a renderer shared with other roots instead of taking a WebGL context (ADR-023). 'auto' shares once MAX_DEDICATED_CONTEXTS roots own a context, and never with a custom createRenderer. Default false. |
width? | number | Experimental Fixed CSS size when not responsive (defaults to the container's size at creation). |