Class Viewport

What the editor needs from a viewport (lets tests use a fake).

Implements

ViewportLike

Index

Properties

attempts canvas container info lastStats

Accessors

backend camera grid isDisposed size

Properties

attempts

attempts: BackendAttempt[] = []

canvas

canvas: HTMLCanvasElement

`Readonly`container

container: HTMLElement

info

info: RendererInfo | null = null

lastStats

lastStats: FrameStats | null = null

Accessors

backend

get backend(): Backend | null
Returns Backend | null
- Defined in packages/sdk/src/viewport.ts:521

camera

get camera(): Camera
Returns Camera
Implementation of ViewportLike.camera
- Defined in packages/sdk/src/viewport.ts:513

grid

get grid(): GridSettings
Returns GridSettings
Implementation of ViewportLike.grid
- Defined in packages/sdk/src/viewport.ts:517

isDisposed

get isDisposed(): boolean
Returns boolean
- Defined in packages/sdk/src/viewport.ts:737

size

get size(): ViewSize
Returns ViewSize
Implementation of ViewportLike.size
- Defined in packages/sdk/src/viewport.ts:509

Methods

dispose

dispose(): void
Remove the canvas and release GPU resources and listeners.

Returns void
- Defined in packages/sdk/src/viewport.ts:720

exportPng

exportPng(opts?: { grid?: boolean }): Promise<Blob>
Export the current view as PNG (device-pixel resolution). The frame is rendered and read back in the same task, so it does not depend on the compositor. Hide the grid with grid: false.
Parameters
- opts: { grid?: boolean } = {}
Returns Promise<Blob>
- Defined in packages/sdk/src/viewport.ts:699

fit

fit(bounds?: Aabb | null, margin?: number): Promise<void>
Fit bounds (default: the whole scene).
Parameters
- Optionalbounds: Aabb | null
- margin: number = 32
Returns Promise<void>
Implementation of ViewportLike.fit
- Defined in packages/sdk/src/viewport.ts:555

frame

frame(): FrameStats | null
Draw now (normally driven by requestRender).

Returns FrameStats | null
- Defined in packages/sdk/src/viewport.ts:612

gpuIdle

gpuIdle(timeoutMs?: number): Promise<void>
Resolve once the GPU has finished every frame submitted so far (frame-time measurements: input → GPU done). Rendering never needs it. Resolves early if the renderer is lost, replaced or disposed, or after timeoutMs.
Parameters
- timeoutMs: number = 2000
Returns Promise<void>
- Defined in packages/sdk/src/viewport.ts:683

memoryStats

memoryStats(): { gpuBytes: number; wasmBytes: number }
Renderer memory: WebAssembly linear memory (high-water mark, shared by all viewports of the page) and GPU buffers/textures of this viewport (last frame).

Returns { gpuBytes: number; wasmBytes: number }
- Defined in packages/sdk/src/viewport.ts:674

on

on<K extends keyof ViewportEvents>(
name: K,
cb: (v: ViewportEvents[K]) => void,
): () => void
Type Parameters
- K extends keyof ViewportEvents
Parameters
- name: K
- cb: (v: ViewportEvents[K]) => void
Returns () => void
- Defined in packages/sdk/src/viewport.ts:268

panBy

panBy(dx: number, dy: number): void
Parameters
- dx: number
- dy: number
Returns void
- Defined in packages/sdk/src/viewport.ts:532

requestRender

requestRender(): void
Returns void
Implementation of ViewportLike.requestRender
- Defined in packages/sdk/src/viewport.ts:601

sceneBounds

sceneBounds(): Aabb | null
Scene bounds known to the renderer, or null when empty.

Returns Aabb | null
- Defined in packages/sdk/src/viewport.ts:549

screenToWorld

screenToWorld(x: number, y: number): Point
Parameters
- x: number
- y: number
Returns Point
Implementation of ViewportLike.screenToWorld
- Defined in packages/sdk/src/viewport.ts:540

setCamera

setCamera(c: Camera): void
Parameters
- c: Camera
Returns void
Implementation of ViewportLike.setCamera
- Defined in packages/sdk/src/viewport.ts:525

setGrid

setGrid(g: Partial<GridSettings>): void
Parameters
- g: Partial<GridSettings>
Returns void
Implementation of ViewportLike.setGrid
- Defined in packages/sdk/src/viewport.ts:568

setHover

setHover(id: number | null): void
Parameters
- id: number | null
Returns void
Implementation of ViewportLike.setHover
- Defined in packages/sdk/src/viewport.ts:592

setOverlay

setOverlay(o: OverlayState): void
Parameters
- o: OverlayState
Returns void
Implementation of ViewportLike.setOverlay
- Defined in packages/sdk/src/viewport.ts:574

setTheme

setTheme(t: ThemeInput): void
Parameters
- t: ThemeInput
Returns void
- Defined in packages/sdk/src/viewport.ts:562

simulateContextLoss

simulateContextLoss(): void
Simulate GPU device/context loss (tests).

Returns void
- Defined in packages/sdk/src/viewport.ts:493

whenStable

whenStable(quietMs?: number, timeoutMs?: number): Promise<void>
Resolve once rendering has been running on the same backend, without a device loss, for quietMs — e.g. before taking a screenshot or thumbnail right after start-up, when a backend that loses its device immediately is replaced. Rejects after timeoutMs.
Parameters
- quietMs: number = 500
- timeoutMs: number = 15_000
Returns Promise<void>
- Defined in packages/sdk/src/viewport.ts:657

worldToScreen

worldToScreen(p: Point): Point
Parameters
- p: Point
Returns Point
Implementation of ViewportLike.worldToScreen
- Defined in packages/sdk/src/viewport.ts:544

zoomAt

zoomAt(x: number, y: number, factor: number): void
Parameters
- x: number
- y: number
- factor: number
Returns void
- Defined in packages/sdk/src/viewport.ts:536

`Static`create

create(
    container: HTMLElement,
    engine: DotloomEngine,
    opts?: ViewportOptions,
): Promise<Viewport>
Create a viewport inside container (which must have a size).
Parameters
- container: HTMLElement
- engine: DotloomEngine
- opts: ViewportOptions = {}
Returns Promise<Viewport>
- Defined in packages/sdk/src/viewport.ts:230