Skip to main content

Interface: ZoomedSceneOptions

Defined in: src/core/ZoomedScene.ts:12

Options for configuring a ZoomedScene.

Extends​

Properties​

autoRender?​

optional autoRender: boolean

Defined in: src/core/Scene.ts:70

Enable auto-render on add/remove. Defaults to true.

Inherited from​

SceneOptions.autoRender

autoResize?​

optional autoResize: boolean

Defined in: src/core/Scene.ts:81

Automatically resize the canvas when its container (or the window, on mobile rotation) changes size. Only active when both width and height are omitted — passing either dimension is treated as a request for a pinned canvas size, so auto-resize stays off. Defaults to true.

Inherited from​

SceneOptions.autoResize

backgroundColor?​

optional backgroundColor: string

Defined in: src/core/Scene.ts:60

Background color as CSS color string. Defaults to Manim's dark gray (#1C1C1C).

Inherited from​

SceneOptions.backgroundColor

backgroundOpacity?​

optional backgroundOpacity: number

Defined in: src/core/Scene.ts:72

Background opacity (0 = fully transparent, 1 = fully opaque). Defaults to 1. Not supported when exporting to video or GIF formats.

Inherited from​

SceneOptions.backgroundOpacity

cameraFrameColor?​

optional cameraFrameColor: string

Defined in: src/core/ZoomedScene.ts:24

Color of the camera frame border. Defaults to '#FFFF00'.

cameraFrameHeight?​

optional cameraFrameHeight: number

Defined in: src/core/ZoomedScene.ts:16

Height of the zoom camera frame in world units. Defaults to 3.

cameraFrameStrokeWidth?​

optional cameraFrameStrokeWidth: number

Defined in: src/core/ZoomedScene.ts:28

Stroke width of camera frame. Defaults to 3.

cameraFrameWidth?​

optional cameraFrameWidth: number

Defined in: src/core/ZoomedScene.ts:14

Width of the zoom camera frame in world units. Defaults to 3.

displayCorner?​

optional displayCorner: [number, number, number]

Defined in: src/core/ZoomedScene.ts:34

Corner direction for zoomed display [x, y, z]. Defaults to UP+RIGHT [1,1,0].

displayCornerBuff?​

optional displayCornerBuff: number

Defined in: src/core/ZoomedScene.ts:36

Buffer from corner edges. Defaults to 0.5.

displayFrameColor?​

optional displayFrameColor: string

Defined in: src/core/ZoomedScene.ts:26

Color of the display frame border. Defaults to '#FFFF00'.

displayFrameStrokeWidth?​

optional displayFrameStrokeWidth: number

Defined in: src/core/ZoomedScene.ts:30

Stroke width of display frame. Defaults to 3.

displayHeight?​

optional displayHeight: number

Defined in: src/core/ZoomedScene.ts:22

Height of the zoomed display in world units. Defaults to 3.

displayWidth?​

optional displayWidth: number

Defined in: src/core/ZoomedScene.ts:20

Width of the zoomed display in world units. Defaults to 3.

frameHeight?​

optional frameHeight: number

Defined in: src/core/Scene.ts:64

Frame height in world units. Defaults to 8 (Manim standard).

Inherited from​

SceneOptions.frameHeight

frameWidth?​

optional frameWidth: number

Defined in: src/core/Scene.ts:62

Frame width in world units. Defaults to 14 (Manim standard).

Inherited from​

SceneOptions.frameWidth

frustumCulling?​

optional frustumCulling: boolean

Defined in: src/core/Scene.ts:68

Enable frustum culling optimization. Defaults to true.

Inherited from​

SceneOptions.frustumCulling

headless?​

optional headless: boolean

Defined in: src/core/Scene.ts:74

Enable headless mode (no WebGL renderer). Useful for testing scene logic without a DOM.

Inherited from​

SceneOptions.headless

height?​

optional height: number

Defined in: src/core/Scene.ts:58

Canvas height in pixels. Defaults to container height.

Inherited from​

SceneOptions.height

renderTargetSize?​

optional renderTargetSize: number

Defined in: src/core/ZoomedScene.ts:32

Size of render target in pixels. Defaults to 512.

targetFps?​

optional targetFps: number

Defined in: src/core/Scene.ts:66

Target frame rate in fps. Defaults to 60.

Inherited from​

SceneOptions.targetFps

width?​

optional width: number

Defined in: src/core/Scene.ts:56

Canvas width in pixels. Defaults to container width.

Inherited from​

SceneOptions.width

zoomFactor?​

optional zoomFactor: number

Defined in: src/core/ZoomedScene.ts:18

Default zoom factor (frame.width / display.width). Defaults to 0.3.