@react-three/fiber 10.0.0-canary.8f5b4d3 → 10.0.0-canary.979dc2d

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1,3 +1,4 @@
1
+ import * as three_examples_jsm_inspector_Inspector_js from 'three/examples/jsm/inspector/Inspector.js';
1
2
  import * as three_webgpu from 'three/webgpu';
2
3
  import { CubeRenderTarget, RenderTarget, WebGPURenderer, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three/webgpu';
3
4
  import * as THREE$1 from 'three';
@@ -47,6 +48,9 @@ function _mergeNamespaces(n, m) {
47
48
  declare const R3F_BUILD_LEGACY = true;
48
49
  declare const R3F_BUILD_WEBGPU = true;
49
50
 
51
+ /** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
52
+ declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
53
+
50
54
  var THREE = /*#__PURE__*/_mergeNamespaces({
51
55
  __proto__: null,
52
56
  CubeRenderTarget: CubeRenderTarget,
@@ -58,7 +62,8 @@ var THREE = /*#__PURE__*/_mergeNamespaces({
58
62
  WebGLCubeRenderTarget: WebGLCubeRenderTarget,
59
63
  WebGLRenderTarget: WebGLRenderTarget,
60
64
  WebGLRenderer: WebGLRenderer,
61
- WebGLRendererParameters: WebGLRendererParameters
65
+ WebGLRendererParameters: WebGLRendererParameters,
66
+ loadInspector: loadInspector
62
67
  }, [three_webgpu]);
63
68
 
64
69
  //* Utility Types ==============================
@@ -358,6 +363,33 @@ type BufferRecord = Record<string, BufferLike>
358
363
  */
359
364
  type BufferStore = Record<string, BufferLike | BufferRecord>
360
365
 
366
+ //* Node Types (useNodes) ========================================
367
+
368
+ /**
369
+ * Structural shape of a TSL node as stored on `state.nodes`.
370
+ *
371
+ * Deliberately minimal rather than three's nominal `Node`: in @types/three several node classes
372
+ * TSL hands back (OperatorNode, ConstNode, ...) do not extend `Node` cleanly, so a `Node` bound
373
+ * would reject values `useNodes` creators legitimately return. This is the same shape
374
+ * `useNodes` already constrains creators to (`TSLNodeLike`).
375
+ */
376
+ interface NodeLike {
377
+ uuid?: string
378
+ nodeType?: string | null
379
+ /** label method for chaining - sets the node's label and returns self */
380
+ label?: ((label: string) => NodeLike) | string
381
+ setName?: (name: string) => this
382
+ }
383
+
384
+ /** Flat record of TSL nodes (no nested scopes) */
385
+ type NodeRecord = Record<string, NodeLike>
386
+
387
+ /**
388
+ * Node store that can contain both root-level nodes and scoped node objects.
389
+ * Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
390
+ */
391
+ type NodeStore = Record<string, NodeLike | NodeRecord>
392
+
361
393
  //* Storage Types (useGPUStorage) ========================================
362
394
 
363
395
  /**
@@ -491,11 +523,28 @@ interface InternalState {
491
523
  /** Container for child attachment (scene for root, original container for portals) */
492
524
  container?: THREE$1.Object3D
493
525
  /**
494
- * CanvasTarget for multi-canvas WebGPU rendering.
495
- * Created for all WebGPU canvases to support renderer sharing.
526
+ * The CanvasTarget this root sizes and renders through.
527
+ *
528
+ * A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
529
+ * around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
530
+ * R3F created for its own element. Either way there is exactly one target per canvas element,
531
+ * and the canvas-target job makes it the renderer's active one before this root renders.
532
+ * Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
496
533
  * @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
497
534
  */
498
535
  canvasTarget?: CanvasTarget
536
+ /**
537
+ * Set when this root's canvas target has been resized and the backend's cached render pass
538
+ * descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
539
+ *
540
+ * Flushed by the canvas-target job in the `start` phase, which is the only place this root's
541
+ * target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
542
+ * whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
543
+ * invalidate some other canvas's descriptor instead.
544
+ *
545
+ * @see https://github.com/pmndrs/react-three-fiber/issues/3847
546
+ */
547
+ canvasTargetSizeDirty?: boolean
499
548
  /**
500
549
  * Whether multi-canvas rendering is active.
501
550
  * True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
@@ -605,7 +654,7 @@ interface RootState {
605
654
  /** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
606
655
  uniforms: UniformStore
607
656
  /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
608
- nodes: Record<string, any>
657
+ nodes: NodeStore
609
658
  /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
610
659
  buffers: BufferStore
611
660
  /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
@@ -617,7 +666,7 @@ interface RootState {
617
666
  /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
618
667
  renderPipeline: ThreeRenderPipeline | null
619
668
  /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
620
- passes: Record<string, any>
669
+ passes: PassRecord
621
670
  /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
622
671
  _hmrVersion: number
623
672
  /** Internal: whether setSize() has taken ownership of canvas dimensions */
@@ -705,12 +754,19 @@ type DefaultRendererProps = {
705
754
  */
706
755
  interface CanvasSchedulerConfig {
707
756
  /**
708
- * Render this canvas after another canvas completes.
709
- * Pass the `id` of another canvas.
757
+ * Run this Canvas root before the referenced Canvas root id(s).
758
+ */
759
+ before?: string | string[]
760
+ /**
761
+ * Run this Canvas root after the referenced Canvas root id(s).
710
762
  */
711
- after?: string
763
+ after?: string | string[]
712
764
  /**
713
- * Limit this canvas's render rate (frames per second).
765
+ * Numeric root order. Lower values run first.
766
+ */
767
+ order?: number
768
+ /**
769
+ * Limit this Canvas's default render job (frames per second).
714
770
  */
715
771
  fps?: number
716
772
  }
@@ -1158,7 +1214,33 @@ declare global {
1158
1214
  * ergonomics. The result is three's structural type, so members stay in sync with the
1159
1215
  * installed three instead of needing to be mirrored by hand.
1160
1216
  */
1161
- type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
1217
+ type UniformNode<T = unknown> = three_webgpu.UniformNode<UniformNodeTypeFor<T>, T>
1218
+
1219
+ /**
1220
+ * three's node type name for a uniform value type, mirroring the `uniform()` overloads.
1221
+ * A `UniformNode<number>` is a `Node<'float'>`, so TSL math (`.mul`, `.add`, ...) accepts it.
1222
+ * Unknown or unlisted value types resolve to `unknown`, which TSL math rejects: narrow with
1223
+ * `as UniformNode<number>` (or the matching value type) at the call site.
1224
+ */
1225
+ type UniformNodeTypeFor<T> = T extends number
1226
+ ? 'float'
1227
+ : T extends boolean
1228
+ ? 'bool'
1229
+ : T extends three_webgpu.Color
1230
+ ? 'color'
1231
+ : T extends three_webgpu.Vector2
1232
+ ? 'vec2'
1233
+ : T extends three_webgpu.Vector3
1234
+ ? 'vec3'
1235
+ : T extends three_webgpu.Vector4
1236
+ ? 'vec4'
1237
+ : T extends three_webgpu.Matrix2
1238
+ ? 'mat2'
1239
+ : T extends three_webgpu.Matrix3
1240
+ ? 'mat3'
1241
+ : T extends three_webgpu.Matrix4
1242
+ ? 'mat4'
1243
+ : unknown
1162
1244
 
1163
1245
  /**
1164
1246
  * ShaderCallable - the return type of Fn()
@@ -1311,30 +1393,97 @@ declare global {
1311
1393
  */
1312
1394
  type ThreeRenderPipeline = three_webgpu.RenderPipeline
1313
1395
 
1314
- /** Pass record - stores TSL pass nodes for render pipeline */
1315
- type PassRecord = Record<string, any>
1396
+ /**
1397
+ * The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
1398
+ * `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
1399
+ * `getTextureNode`, `setMRT` and `dispose` track the installed version.
1400
+ */
1401
+ type ScenePassNode = three_webgpu.PassNode
1402
+
1403
+ /**
1404
+ * Pass record - stores TSL pass nodes for render pipeline.
1405
+ *
1406
+ * `scenePass` is the only key the library owns. It is optional here because this is also the
1407
+ * shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
1408
+ * or `clearPasses()`. Inside the callbacks it is always present; see
1409
+ * {@link RenderPipelineCallbackState}.
1410
+ *
1411
+ * Every other key is user-registered, via a callback's return value. Those are TSL nodes of
1412
+ * any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
1413
+ * `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
1414
+ * site when you need a member, e.g. `passes.velocity as TextureNode`.
1415
+ */
1416
+ interface PassRecord {
1417
+ scenePass?: ScenePassNode
1418
+ [key: string]: three_webgpu.Node
1419
+ }
1420
+
1421
+ /**
1422
+ * State passed to pipeline callbacks after the active pipeline has been created.
1423
+ *
1424
+ * `passes.scenePass` is required here: the hook installs the default scene pass before either
1425
+ * callback runs, so callbacks can use it without a guard or a cast.
1426
+ *
1427
+ * `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
1428
+ * the legacy renderer before either callback can run, so a callback never sees WebGL.
1429
+ */
1430
+ type RenderPipelineCallbackState = RootState & {
1431
+ renderPipeline: ThreeRenderPipeline
1432
+ passes: PassRecord & { scenePass: ScenePassNode }
1433
+ renderer: three_webgpu.WebGPURenderer
1434
+ isLegacy: false
1435
+ }
1436
+
1437
+ /**
1438
+ * What a callback may return to register entries into `state.passes`.
1439
+ *
1440
+ * `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
1441
+ * created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
1442
+ * store entry would leave the store pointing at a node the hook never disposes, and the hook
1443
+ * disposing a pass nothing references. So returning it is a type error.
1444
+ */
1445
+ type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
1316
1446
 
1317
1447
  /** Setup callback - runs first to configure MRT, create additional passes */
1318
- type RenderPipelineSetupCallback = (state: RootState) => PassRecord | void
1448
+ type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1319
1449
 
1320
1450
  /** Main callback - runs second to configure outputNode, create effect passes */
1321
- type RenderPipelineMainCallback = (state: RootState) => PassRecord | void
1451
+ type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1322
1452
 
1323
- /** Return type for useRenderPipeline hook */
1324
- interface UseRenderPipelineReturn {
1453
+ /** The imperative half of useRenderPipeline's return value, present in every state */
1454
+ interface UseRenderPipelineActions {
1325
1455
  /** Current passes from state */
1326
1456
  passes: PassRecord
1327
- /** RenderPipeline instance (null if not initialized) */
1328
- renderPipeline: ThreeRenderPipeline | null
1329
1457
  /** Clear all passes from state */
1330
1458
  clearPasses: () => void
1331
1459
  /** Reset RenderPipeline entirely (clears PP + passes) */
1332
1460
  reset: () => void
1333
1461
  /** Re-run setup/main callbacks with current closure values */
1334
1462
  rebuild: () => void
1335
- /** True when RenderPipeline is configured and ready */
1336
- isReady: boolean
1337
1463
  }
1464
+
1465
+ /**
1466
+ * Return type for useRenderPipeline hook, discriminated on `isReady`.
1467
+ *
1468
+ * `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
1469
+ * callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
1470
+ * `clearPasses()` empties the record while leaving the pipeline in place.
1471
+ */
1472
+ type UseRenderPipelineReturn = UseRenderPipelineActions &
1473
+ (
1474
+ | {
1475
+ /** True when RenderPipeline is configured and ready */
1476
+ isReady: true
1477
+ /** RenderPipeline instance */
1478
+ renderPipeline: ThreeRenderPipeline
1479
+ }
1480
+ | {
1481
+ /** False until the pipeline has been created */
1482
+ isReady: false
1483
+ /** Not initialized yet, or torn down by reset() */
1484
+ renderPipeline: null
1485
+ }
1486
+ )
1338
1487
  }
1339
1488
 
1340
1489
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
@@ -1878,7 +2027,7 @@ declare namespace useLoader {
1878
2027
  *
1879
2028
  * @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
1880
2029
  * @param priorityOrOptions - Either a priority number (backwards compat) or options object
1881
- * @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
2030
+ * @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
1882
2031
  *
1883
2032
  * @example
1884
2033
  * // Simple priority (backwards compat)
@@ -2174,7 +2323,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
2174
2323
  * Invalidates the view, requesting a frame to be rendered.
2175
2324
  * In demand mode, this triggers the scheduler to run frames.
2176
2325
  *
2177
- * @param state - Optional root state (ignored in new scheduler, kept for backwards compat)
2326
+ * With a state argument, only that root's jobs run on the requested frames; other
2327
+ * roots on 'demand' stay idle. Without one, every registered root is invalidated.
2328
+ *
2329
+ * @param state - Optional root state; targets the invalidation at that root
2178
2330
  * @param frames - Number of frames to request (default: 1)
2179
2331
  * @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
2180
2332
  *
@@ -2185,14 +2337,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
2185
2337
  * Advances the frameloop and runs render effects.
2186
2338
  * Useful for when manually rendering via `frameloop="never"`.
2187
2339
  *
2340
+ * With a state argument, only that root is stepped. Without one, every
2341
+ * registered root is stepped for backwards compatibility.
2342
+ *
2188
2343
  * @param timestamp - The timestamp to use for this frame
2189
2344
  * @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
2190
- * @param state - Ignored (kept for backwards compat)
2191
- * @param frame - Ignored (kept for backwards compat)
2345
+ * @param state - Optional root state; targets the manual step at that root
2192
2346
  *
2193
2347
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
2194
2348
  */
2195
- declare function advance(timestamp: number): void;
2349
+ declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
2196
2350
 
2197
2351
  /* eslint-disable @definitelytyped/no-unnecessary-generics */
2198
2352
  declare function ReactReconciler<
@@ -3747,4 +3901,4 @@ declare function isOnce(value: unknown): value is {
3747
3901
  declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
3748
3902
 
3749
3903
  export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
3750
- export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
3904
+ export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeLike, NodeProps, NodeRecord, NodeStore, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
package/dist/index.d.mts CHANGED
@@ -1,3 +1,4 @@
1
+ import * as three_examples_jsm_inspector_Inspector_js from 'three/examples/jsm/inspector/Inspector.js';
1
2
  import * as three_webgpu from 'three/webgpu';
2
3
  import { CubeRenderTarget, RenderTarget, WebGPURenderer, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three/webgpu';
3
4
  import * as THREE$1 from 'three';
@@ -47,6 +48,9 @@ function _mergeNamespaces(n, m) {
47
48
  declare const R3F_BUILD_LEGACY = true;
48
49
  declare const R3F_BUILD_WEBGPU = true;
49
50
 
51
+ /** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
52
+ declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
53
+
50
54
  var THREE = /*#__PURE__*/_mergeNamespaces({
51
55
  __proto__: null,
52
56
  CubeRenderTarget: CubeRenderTarget,
@@ -58,7 +62,8 @@ var THREE = /*#__PURE__*/_mergeNamespaces({
58
62
  WebGLCubeRenderTarget: WebGLCubeRenderTarget,
59
63
  WebGLRenderTarget: WebGLRenderTarget,
60
64
  WebGLRenderer: WebGLRenderer,
61
- WebGLRendererParameters: WebGLRendererParameters
65
+ WebGLRendererParameters: WebGLRendererParameters,
66
+ loadInspector: loadInspector
62
67
  }, [three_webgpu]);
63
68
 
64
69
  //* Utility Types ==============================
@@ -358,6 +363,33 @@ type BufferRecord = Record<string, BufferLike>
358
363
  */
359
364
  type BufferStore = Record<string, BufferLike | BufferRecord>
360
365
 
366
+ //* Node Types (useNodes) ========================================
367
+
368
+ /**
369
+ * Structural shape of a TSL node as stored on `state.nodes`.
370
+ *
371
+ * Deliberately minimal rather than three's nominal `Node`: in @types/three several node classes
372
+ * TSL hands back (OperatorNode, ConstNode, ...) do not extend `Node` cleanly, so a `Node` bound
373
+ * would reject values `useNodes` creators legitimately return. This is the same shape
374
+ * `useNodes` already constrains creators to (`TSLNodeLike`).
375
+ */
376
+ interface NodeLike {
377
+ uuid?: string
378
+ nodeType?: string | null
379
+ /** label method for chaining - sets the node's label and returns self */
380
+ label?: ((label: string) => NodeLike) | string
381
+ setName?: (name: string) => this
382
+ }
383
+
384
+ /** Flat record of TSL nodes (no nested scopes) */
385
+ type NodeRecord = Record<string, NodeLike>
386
+
387
+ /**
388
+ * Node store that can contain both root-level nodes and scoped node objects.
389
+ * Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
390
+ */
391
+ type NodeStore = Record<string, NodeLike | NodeRecord>
392
+
361
393
  //* Storage Types (useGPUStorage) ========================================
362
394
 
363
395
  /**
@@ -491,11 +523,28 @@ interface InternalState {
491
523
  /** Container for child attachment (scene for root, original container for portals) */
492
524
  container?: THREE$1.Object3D
493
525
  /**
494
- * CanvasTarget for multi-canvas WebGPU rendering.
495
- * Created for all WebGPU canvases to support renderer sharing.
526
+ * The CanvasTarget this root sizes and renders through.
527
+ *
528
+ * A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
529
+ * around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
530
+ * R3F created for its own element. Either way there is exactly one target per canvas element,
531
+ * and the canvas-target job makes it the renderer's active one before this root renders.
532
+ * Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
496
533
  * @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
497
534
  */
498
535
  canvasTarget?: CanvasTarget
536
+ /**
537
+ * Set when this root's canvas target has been resized and the backend's cached render pass
538
+ * descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
539
+ *
540
+ * Flushed by the canvas-target job in the `start` phase, which is the only place this root's
541
+ * target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
542
+ * whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
543
+ * invalidate some other canvas's descriptor instead.
544
+ *
545
+ * @see https://github.com/pmndrs/react-three-fiber/issues/3847
546
+ */
547
+ canvasTargetSizeDirty?: boolean
499
548
  /**
500
549
  * Whether multi-canvas rendering is active.
501
550
  * True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
@@ -605,7 +654,7 @@ interface RootState {
605
654
  /** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
606
655
  uniforms: UniformStore
607
656
  /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
608
- nodes: Record<string, any>
657
+ nodes: NodeStore
609
658
  /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
610
659
  buffers: BufferStore
611
660
  /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
@@ -617,7 +666,7 @@ interface RootState {
617
666
  /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
618
667
  renderPipeline: ThreeRenderPipeline | null
619
668
  /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
620
- passes: Record<string, any>
669
+ passes: PassRecord
621
670
  /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
622
671
  _hmrVersion: number
623
672
  /** Internal: whether setSize() has taken ownership of canvas dimensions */
@@ -705,12 +754,19 @@ type DefaultRendererProps = {
705
754
  */
706
755
  interface CanvasSchedulerConfig {
707
756
  /**
708
- * Render this canvas after another canvas completes.
709
- * Pass the `id` of another canvas.
757
+ * Run this Canvas root before the referenced Canvas root id(s).
758
+ */
759
+ before?: string | string[]
760
+ /**
761
+ * Run this Canvas root after the referenced Canvas root id(s).
710
762
  */
711
- after?: string
763
+ after?: string | string[]
712
764
  /**
713
- * Limit this canvas's render rate (frames per second).
765
+ * Numeric root order. Lower values run first.
766
+ */
767
+ order?: number
768
+ /**
769
+ * Limit this Canvas's default render job (frames per second).
714
770
  */
715
771
  fps?: number
716
772
  }
@@ -1158,7 +1214,33 @@ declare global {
1158
1214
  * ergonomics. The result is three's structural type, so members stay in sync with the
1159
1215
  * installed three instead of needing to be mirrored by hand.
1160
1216
  */
1161
- type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
1217
+ type UniformNode<T = unknown> = three_webgpu.UniformNode<UniformNodeTypeFor<T>, T>
1218
+
1219
+ /**
1220
+ * three's node type name for a uniform value type, mirroring the `uniform()` overloads.
1221
+ * A `UniformNode<number>` is a `Node<'float'>`, so TSL math (`.mul`, `.add`, ...) accepts it.
1222
+ * Unknown or unlisted value types resolve to `unknown`, which TSL math rejects: narrow with
1223
+ * `as UniformNode<number>` (or the matching value type) at the call site.
1224
+ */
1225
+ type UniformNodeTypeFor<T> = T extends number
1226
+ ? 'float'
1227
+ : T extends boolean
1228
+ ? 'bool'
1229
+ : T extends three_webgpu.Color
1230
+ ? 'color'
1231
+ : T extends three_webgpu.Vector2
1232
+ ? 'vec2'
1233
+ : T extends three_webgpu.Vector3
1234
+ ? 'vec3'
1235
+ : T extends three_webgpu.Vector4
1236
+ ? 'vec4'
1237
+ : T extends three_webgpu.Matrix2
1238
+ ? 'mat2'
1239
+ : T extends three_webgpu.Matrix3
1240
+ ? 'mat3'
1241
+ : T extends three_webgpu.Matrix4
1242
+ ? 'mat4'
1243
+ : unknown
1162
1244
 
1163
1245
  /**
1164
1246
  * ShaderCallable - the return type of Fn()
@@ -1311,30 +1393,97 @@ declare global {
1311
1393
  */
1312
1394
  type ThreeRenderPipeline = three_webgpu.RenderPipeline
1313
1395
 
1314
- /** Pass record - stores TSL pass nodes for render pipeline */
1315
- type PassRecord = Record<string, any>
1396
+ /**
1397
+ * The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
1398
+ * `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
1399
+ * `getTextureNode`, `setMRT` and `dispose` track the installed version.
1400
+ */
1401
+ type ScenePassNode = three_webgpu.PassNode
1402
+
1403
+ /**
1404
+ * Pass record - stores TSL pass nodes for render pipeline.
1405
+ *
1406
+ * `scenePass` is the only key the library owns. It is optional here because this is also the
1407
+ * shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
1408
+ * or `clearPasses()`. Inside the callbacks it is always present; see
1409
+ * {@link RenderPipelineCallbackState}.
1410
+ *
1411
+ * Every other key is user-registered, via a callback's return value. Those are TSL nodes of
1412
+ * any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
1413
+ * `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
1414
+ * site when you need a member, e.g. `passes.velocity as TextureNode`.
1415
+ */
1416
+ interface PassRecord {
1417
+ scenePass?: ScenePassNode
1418
+ [key: string]: three_webgpu.Node
1419
+ }
1420
+
1421
+ /**
1422
+ * State passed to pipeline callbacks after the active pipeline has been created.
1423
+ *
1424
+ * `passes.scenePass` is required here: the hook installs the default scene pass before either
1425
+ * callback runs, so callbacks can use it without a guard or a cast.
1426
+ *
1427
+ * `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
1428
+ * the legacy renderer before either callback can run, so a callback never sees WebGL.
1429
+ */
1430
+ type RenderPipelineCallbackState = RootState & {
1431
+ renderPipeline: ThreeRenderPipeline
1432
+ passes: PassRecord & { scenePass: ScenePassNode }
1433
+ renderer: three_webgpu.WebGPURenderer
1434
+ isLegacy: false
1435
+ }
1436
+
1437
+ /**
1438
+ * What a callback may return to register entries into `state.passes`.
1439
+ *
1440
+ * `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
1441
+ * created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
1442
+ * store entry would leave the store pointing at a node the hook never disposes, and the hook
1443
+ * disposing a pass nothing references. So returning it is a type error.
1444
+ */
1445
+ type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
1316
1446
 
1317
1447
  /** Setup callback - runs first to configure MRT, create additional passes */
1318
- type RenderPipelineSetupCallback = (state: RootState) => PassRecord | void
1448
+ type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1319
1449
 
1320
1450
  /** Main callback - runs second to configure outputNode, create effect passes */
1321
- type RenderPipelineMainCallback = (state: RootState) => PassRecord | void
1451
+ type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1322
1452
 
1323
- /** Return type for useRenderPipeline hook */
1324
- interface UseRenderPipelineReturn {
1453
+ /** The imperative half of useRenderPipeline's return value, present in every state */
1454
+ interface UseRenderPipelineActions {
1325
1455
  /** Current passes from state */
1326
1456
  passes: PassRecord
1327
- /** RenderPipeline instance (null if not initialized) */
1328
- renderPipeline: ThreeRenderPipeline | null
1329
1457
  /** Clear all passes from state */
1330
1458
  clearPasses: () => void
1331
1459
  /** Reset RenderPipeline entirely (clears PP + passes) */
1332
1460
  reset: () => void
1333
1461
  /** Re-run setup/main callbacks with current closure values */
1334
1462
  rebuild: () => void
1335
- /** True when RenderPipeline is configured and ready */
1336
- isReady: boolean
1337
1463
  }
1464
+
1465
+ /**
1466
+ * Return type for useRenderPipeline hook, discriminated on `isReady`.
1467
+ *
1468
+ * `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
1469
+ * callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
1470
+ * `clearPasses()` empties the record while leaving the pipeline in place.
1471
+ */
1472
+ type UseRenderPipelineReturn = UseRenderPipelineActions &
1473
+ (
1474
+ | {
1475
+ /** True when RenderPipeline is configured and ready */
1476
+ isReady: true
1477
+ /** RenderPipeline instance */
1478
+ renderPipeline: ThreeRenderPipeline
1479
+ }
1480
+ | {
1481
+ /** False until the pipeline has been created */
1482
+ isReady: false
1483
+ /** Not initialized yet, or torn down by reset() */
1484
+ renderPipeline: null
1485
+ }
1486
+ )
1338
1487
  }
1339
1488
 
1340
1489
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
@@ -1878,7 +2027,7 @@ declare namespace useLoader {
1878
2027
  *
1879
2028
  * @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
1880
2029
  * @param priorityOrOptions - Either a priority number (backwards compat) or options object
1881
- * @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
2030
+ * @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
1882
2031
  *
1883
2032
  * @example
1884
2033
  * // Simple priority (backwards compat)
@@ -2174,7 +2323,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
2174
2323
  * Invalidates the view, requesting a frame to be rendered.
2175
2324
  * In demand mode, this triggers the scheduler to run frames.
2176
2325
  *
2177
- * @param state - Optional root state (ignored in new scheduler, kept for backwards compat)
2326
+ * With a state argument, only that root's jobs run on the requested frames; other
2327
+ * roots on 'demand' stay idle. Without one, every registered root is invalidated.
2328
+ *
2329
+ * @param state - Optional root state; targets the invalidation at that root
2178
2330
  * @param frames - Number of frames to request (default: 1)
2179
2331
  * @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
2180
2332
  *
@@ -2185,14 +2337,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
2185
2337
  * Advances the frameloop and runs render effects.
2186
2338
  * Useful for when manually rendering via `frameloop="never"`.
2187
2339
  *
2340
+ * With a state argument, only that root is stepped. Without one, every
2341
+ * registered root is stepped for backwards compatibility.
2342
+ *
2188
2343
  * @param timestamp - The timestamp to use for this frame
2189
2344
  * @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
2190
- * @param state - Ignored (kept for backwards compat)
2191
- * @param frame - Ignored (kept for backwards compat)
2345
+ * @param state - Optional root state; targets the manual step at that root
2192
2346
  *
2193
2347
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
2194
2348
  */
2195
- declare function advance(timestamp: number): void;
2349
+ declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
2196
2350
 
2197
2351
  /* eslint-disable @definitelytyped/no-unnecessary-generics */
2198
2352
  declare function ReactReconciler<
@@ -3747,4 +3901,4 @@ declare function isOnce(value: unknown): value is {
3747
3901
  declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
3748
3902
 
3749
3903
  export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
3750
- export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
3904
+ export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeLike, NodeProps, NodeRecord, NodeStore, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };