Class Viewport

A live WebGPU view of a document, presenting the engine's render directly to a host <canvas> through the swapchain — never a pixel readback. Create one with EngineModule.createViewport; drive it with Viewport.start. The facade's mutators request a frame after each edit, so an attached viewport repaints on its own.

Index

Properties

Accessors

width height devicePixelRatio zoom

Methods

start stop requestFrame resize getPresentedTexture detach

Properties

`Readonly`canvas

canvas: HTMLCanvasElement | OffscreenCanvas

The canvas this viewport presents to.

Accessors

width

get width(): number
The current backing width in device pixels.

Returns number
- Defined in src/core/viewport.ts:69

height

get height(): number
The current backing height in device pixels.

Returns number
- Defined in src/core/viewport.ts:73

devicePixelRatio

get devicePixelRatio(): number
Returns number
- Defined in src/core/viewport.ts:77
set devicePixelRatio(value: number): void
Parameters
- value: number
Returns void
- Defined in src/core/viewport.ts:80

zoom

get zoom(): number
Returns number
- Defined in src/core/viewport.ts:85
set zoom(value: number): void
Parameters
- value: number
Returns void
- Defined in src/core/viewport.ts:88

Methods

start

start(): this
Begin presenting. In onDemand mode this paints once; edits repaint thereafter.

Returns this
- Defined in src/core/viewport.ts:94

stop

stop(): this
Pause presenting. The surface and device are kept; Viewport.start resumes.

Returns this
- Defined in src/core/viewport.ts:101

requestFrame

requestFrame(): this
Schedule a single frame (the damage signal). No-op while stopped.

Returns this
- Defined in src/core/viewport.ts:111

resize

resize(cssWidth: number, cssHeight: number): this
Set the CSS size explicitly; unnecessary when autoResize is on.
Parameters
- cssWidth: number
- cssHeight: number
Returns this
- Defined in src/core/viewport.ts:117

getPresentedTexture

getPresentedTexture(): GPUTexture | null
The texture the engine last presented, for hosts that compose it into their own pipeline. Returns null in this build — the engine presents directly to the swapchain.

Returns GPUTexture | null
- Defined in src/core/viewport.ts:126

detach

detach(): void
Release this viewport's surface and swapchain (keeping the device) and stop the loop.

Returns void
- Defined in src/core/viewport.ts:131