@three-flatland/devtools 0.1.0-alpha.3 → 1.0.0-alpha.6

package/dist/create-pane.d.cts

@@ -1,66 +0,0 @@
-import { Pane } from 'tweakpane';
-
-interface CreatePaneOptions {
-    /** Custom container element */
-    container?: HTMLElement;
-    /** Pane title (default: 'Controls') */
-    title?: string;
-    /** Default expansion state (default: true) */
-    expanded?: boolean;
-    /**
-     * Who drives the stats-graph render?
-     *  - `'raf'` (default): the pane starts its own `requestAnimationFrame`
-     *    loop. Zero setup; fine for simple apps.
-     *  - `'manual'`: no internal rAF. Call `bundle.update()` from your own
-     *    frame tick — `renderer.setAnimationLoop` callback, R3F `useFrame`,
-     *    or any ticker you already own. Preferred when you have a render
-     *    loop; avoids a second rAF (which Safari throttles).
-     */
-    driver?: 'raf' | 'manual';
-}
-interface PaneBundle {
-    pane: Pane;
-    /**
-     * Render a stats-graph frame. Call from your existing animation loop
-     * (R3F `useFrame`, `renderer.setAnimationLoop`, etc.) for shared-tick
-     * visuals — avoids a second `requestAnimationFrame` callback, which
-     * Safari penalises.
-     *
-     * If you never call `update()`, the graph falls back to its own rAF
-     * so the pane works out-of-the-box in apps without a render loop.
-     */
-    update(): void;
-    /**
-     * `true` once `pane.dispose()` has been called. Lets React hooks
-     * detect that a prior cleanup tore the bundle down and decide
-     * whether to recreate (StrictMode mount→cleanup→mount).
-     */
-    readonly disposed: boolean;
-}
-declare function claimPane(bundle: PaneBundle): void;
-/**
- * Create a themed Tweakpane instance with collapsible header and stats.
- *
- * Layout:
- *   [Controls ▾]          ← collapsible pane header
- *   ┌─ FPS/MS/MEM graph ─┐ ← always visible (click to cycle)
- *   ├─ Stats (folder) ───┤ ← collapsible: draws, tris
- *   ├─ ...user controls...┤
- *   └────────────────────┘
- *
- * @param options - Title, expansion state, and stats-graph `driver` (see
- *   {@link CreatePaneOptions}). Defaults to a self-ticking `'raf'` pane
- *   titled "Controls".
- * @returns A {@link PaneBundle} — the Tweakpane `pane` plus an `update()`
- *   tick and a `disposed` flag.
- *
- * @example
- * ```typescript
- * const { pane } = createPane({ title: 'Debug' })
- * const folder = pane.addFolder({ title: 'Sprite' })
- * folder.addBinding(state, 'scale', { min: 0.1, max: 4 })
- * ```
- */
-declare function createPane(options?: CreatePaneOptions): PaneBundle;
-
-export { type CreatePaneOptions, type PaneBundle, claimPane, createPane };