@react-three/fiber 10.0.0-canary.8f5b4d3 → 10.0.0-canary.908b65b

package/dist/shared/fiber.YgTUGbja.d.ts

@@ -0,0 +1,48 @@
+import { aO as FrameNextCallback } from './fiber.C_MFx7We.js';
+import { UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
+
+/**
+ * Frame hook with phase-based ordering, priority, and FPS throttling.
+ *
+ * Always delivers full RootState — works both inside and outside Canvas context:
+ * - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
+ * - Outside Canvas: The job registers immediately but the callback is held until a
+ *   Canvas adopts it, then runs with full RootState. For hostless / standalone
+ *   frame loops with no Canvas, use `@pmndrs/scheduler` directly.
+ *
+ * Returns a controls object for manual stepping, pausing, and resuming.
+ *
+ * @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
+ * @param priorityOrOptions - Either a priority number (backwards compat) or options object
+ * @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
+ *
+ * @example
+ * // Simple priority (backwards compat)
+ * useFrame((state, delta) => { ... }, 5)
+ *
+ * @example
+ * // With phase-based ordering
+ * useFrame((state, delta) => { ... }, { phase: 'physics' })
+ *
+ * @example
+ * // Outside Canvas - callback waits for a Canvas, then always has full state
+ * function UI() {
+ *   useFrame((state, delta) => { syncUI(state.camera) });
+ *   return <button>...</button>;
+ * }
+ *
+ * @example
+ * // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
+ * import { getScheduler } from '@pmndrs/scheduler'
+ * getScheduler().register((state, delta) => { updateGame(delta) })
+ *
+ * @example
+ * // Scheduler-only access (no callback)
+ * const { scheduler } = useFrame()
+ * scheduler.pauseJob('some-job-id')
+ *
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
+ */
+declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
+
+export { useFrame as u };