effect-motion
API ReferenceexportNamespacesStillsFunctions

contactSheet

function contactSheet<Resources>(frames, options?): Effect<{

Function: contactSheet()

function contactSheet<Resources>(frames, options?): Effect<{
  columns: number;
  height: number;
  png: Uint8Array<ArrayBufferLike>;
  rows: number;
  tileHeight: number;
  tileWidth: number;
  width: number;
}, ThreeException | EffectMotionError | RenderException, Resources>;

Defined in: packages/export/src/Stills.ts:116

Render the frames and tile them row-major into one PNG. Gaps take the first frame's background color. Fails as a defect on an empty list. Requires the frames' font/image loaders, like render.

ponytail: no text labels on tiles — callers print the tile → frame mapping. Burn labels in (via a Text entity overlay) if a sheet must stand alone.

Type Parameters

Type ParameterDefault type
Resourcesnever

Parameters

ParameterType
framesreadonly Frame<Resources>[]
optionsContactSheetOptions

Returns

Effect<{ columns: number; height: number; png: Uint8Array<ArrayBufferLike>; rows: number; tileHeight: number; tileWidth: number; width: number; }, ThreeException | EffectMotionError | RenderException, Resources>

On this page