SurfaceProps

The props of an environment's Surface component.

@internote/canvas-sdkInterface
On this page
import { SurfaceProps } from '@internote/canvas-sdk';

The surface is the one component the definition supplies for the canvas area itself. It is rendered inside a frame the host keeps stable across step changes, so hooks and local state survive a step.

#Fields

ctxRequired
Everything the environment knows: its compiled node, step, storage, parameters and animation runtime.
EnvironmentContext
revisionRequired
A counter the host bumps on every step change and animation frame, so a memoised surface re-renders as values move.
number

Declared in packages/canvas-sdk/src/environment/types.ts:139.

Last updated