@wonderyard/vivarium 1.3.0 → 1.4.0

package/dist/webgpu/setup.d.ts

@@ -71,13 +71,24 @@ export declare const mainCompute: import('typegpu').TgpuComputeFn<{
  * @param options.canvas - The HTML canvas element. Its `width` and `height` define the grid dimensions.
  * @param options.automaton - The compiled automaton produced by {@link VivariumBlueprint.create | vivarium().create()}.
  * @param options.initialGrid - An optional 2d array of element indices to use instead of random initialization. Alternatively, you can pass a flat (1d) array with one index per cell, row-major order.
- * @returns An object with an `evolve` function that advances the simulation by one step, a `readGrid` function that reads the current grid state, a `writeCell` function that updates a single cell by flat index, a `writeCellAt` function that updates a single cell by grid coordinates, a `writeGrid` function that overwrites the entire grid, a `setAutomaton` function to update the automaton, and the underlying `tgpuRoot`.
+ * @returns An object with:
+ * - `update` — advances the simulation by one step (synchronous, GPU only).
+ * - `draw` — reads the latest GPU state and renders it to the canvas (async).
+ * - `evolve` — convenience shorthand for `update()` + `await draw()`.
+ * - `readGrid` — reads the current grid state.
+ * - `writeCell` — updates a single cell by flat index.
+ * - `writeCellAt` — updates a single cell by grid coordinates.
+ * - `writeGrid` — overwrites the entire grid.
+ * - `setAutomaton` — replaces the automaton rules.
+ * - `tgpuRoot` — the underlying TypeGPU root.
  */
 export declare const setup: ({ canvas, automaton, initialGrid, }: {
     canvas: HTMLCanvasElement;
     automaton: Automaton;
     initialGrid?: number[] | number[][];
 }) => {
+    update: () => void;
+    draw: () => Promise<void>;
     evolve: () => Promise<void>;
     readGrid: () => Promise<number[]>;
     writeCell: (index: number, elementIndex: number) => void;