@react-three/fiber 10.0.0-alpha.3 → 10.0.0-alpha.5

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/legacy.d.cts CHANGED
@@ -1,9 +1,9 @@
1
1
  import * as THREE$1 from 'three';
2
- import { WebGLCubeRenderTarget, WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Node as Node$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three';
2
+ import { WebGLCubeRenderTarget, WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Object3D, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Frustum, OrthographicCamera } from 'three';
3
3
  import * as React$1 from 'react';
4
4
  import { ReactNode, Component, RefObject, JSX } from 'react';
5
5
  import * as three_webgpu from 'three/webgpu';
6
- import { WebGPURenderer as WebGPURenderer$1, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject } from 'three/webgpu';
6
+ import { WebGPURenderer as WebGPURenderer$1, Node, StorageTexture, Storage3DTexture, StorageArrayTexture, Data3DTexture, CanvasTarget } from 'three/webgpu';
7
7
  import { StoreApi } from 'zustand';
8
8
  import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
9
9
  import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
@@ -38,12 +38,12 @@ function _mergeNamespaces(n, m) {
38
38
  declare const R3F_BUILD_LEGACY = true;
39
39
  declare const R3F_BUILD_WEBGPU = false;
40
40
 
41
- declare const Inspector: {
42
- new (): {};
43
- };
44
- declare const WebGPURenderer: {
45
- new (): {};
46
- };
41
+ type Inspector = never;
42
+ /** Not available on the legacy (WebGL-only) entry. */
43
+ declare function loadInspector(): Promise<never>;
44
+ declare class WebGPURenderer {
45
+ constructor();
46
+ }
47
47
 
48
48
  declare const RenderTarget: any;
49
49
 
@@ -58,7 +58,8 @@ var THREE = /*#__PURE__*/_mergeNamespaces({
58
58
  R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
59
59
  RenderTarget: RenderTarget,
60
60
  RenderTargetCompat: WebGLRenderTarget,
61
- WebGPURenderer: WebGPURenderer
61
+ WebGPURenderer: WebGPURenderer,
62
+ loadInspector: loadInspector
62
63
  }, [THREE$1]);
63
64
 
64
65
  //* Utility Types ==============================
@@ -347,6 +348,7 @@ type BufferLike =
347
348
  | Uint16Array
348
349
  | Int16Array
349
350
  | THREE$1.BufferAttribute // Base class for all buffer attributes
351
+ | THREE$1.InterleavedBufferAttribute
350
352
  | Node // TSL buffer nodes (instancedArray, storage)
351
353
 
352
354
  /** Flat record of buffer-like values (no nested scopes) */
@@ -358,6 +360,25 @@ type BufferRecord = Record<string, BufferLike>
358
360
  */
359
361
  type BufferStore = Record<string, BufferLike | BufferRecord>
360
362
 
363
+ //* Node Types (useNodes) ========================================
364
+
365
+ /**
366
+ * Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
367
+ * the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
368
+ * code passes through. Creators are constrained to this same type, so the shape a creator returns
369
+ * and the shape the store holds are one type by construction.
370
+ */
371
+ type NodeLike = TSLNodeType | LegacyTSLNodeLike
372
+
373
+ /** Flat record of TSL nodes (no nested scopes) */
374
+ type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
375
+
376
+ /**
377
+ * Node store that can contain both root-level nodes and scoped node objects.
378
+ * Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
379
+ */
380
+ type NodeStore = Record<string, NodeLike | NodeRecord>
381
+
361
382
  //* Storage Types (useGPUStorage) ========================================
362
383
 
363
384
  /**
@@ -372,7 +393,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
372
393
  * ```
373
394
  */
374
395
  type StorageLike =
375
- | StorageTexture // GPU storage texture
396
+ | StorageTexture // 2D GPU storage texture
397
+ | Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
398
+ | StorageArrayTexture // 2D-array GPU storage texture
376
399
  | Data3DTexture // 3D texture (can be used as storage)
377
400
  | Node // TSL storage texture nodes (storageTexture)
378
401
 
@@ -491,11 +514,28 @@ interface InternalState {
491
514
  /** Container for child attachment (scene for root, original container for portals) */
492
515
  container?: THREE$1.Object3D
493
516
  /**
494
- * CanvasTarget for multi-canvas WebGPU rendering.
495
- * Created for all WebGPU canvases to support renderer sharing.
517
+ * The CanvasTarget this root sizes and renders through.
518
+ *
519
+ * A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
520
+ * around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
521
+ * R3F created for its own element. Either way there is exactly one target per canvas element,
522
+ * and the canvas-target job makes it the renderer's active one before this root renders.
523
+ * Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
496
524
  * @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
497
525
  */
498
526
  canvasTarget?: CanvasTarget
527
+ /**
528
+ * Set when this root's canvas target has been resized and the backend's cached render pass
529
+ * descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
530
+ *
531
+ * Flushed by the canvas-target job in the `start` phase, which is the only place this root's
532
+ * target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
533
+ * whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
534
+ * invalidate some other canvas's descriptor instead.
535
+ *
536
+ * @see https://github.com/pmndrs/react-three-fiber/issues/3847
537
+ */
538
+ canvasTargetSizeDirty?: boolean
499
539
  /**
500
540
  * Whether multi-canvas rendering is active.
501
541
  * True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
@@ -605,7 +645,7 @@ interface RootState {
605
645
  /** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
606
646
  uniforms: UniformStore
607
647
  /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
608
- nodes: Record<string, any>
648
+ nodes: NodeStore
609
649
  /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
610
650
  buffers: BufferStore
611
651
  /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
@@ -617,7 +657,7 @@ interface RootState {
617
657
  /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
618
658
  renderPipeline: ThreeRenderPipeline | null
619
659
  /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
620
- passes: Record<string, any>
660
+ passes: PassRecord
621
661
  /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
622
662
  _hmrVersion: number
623
663
  /** Internal: whether setSize() has taken ownership of canvas dimensions */
@@ -705,12 +745,19 @@ type DefaultRendererProps = {
705
745
  */
706
746
  interface CanvasSchedulerConfig {
707
747
  /**
708
- * Render this canvas after another canvas completes.
709
- * Pass the `id` of another canvas.
748
+ * Run this Canvas root before the referenced Canvas root id(s).
710
749
  */
711
- after?: string
750
+ before?: string | string[]
712
751
  /**
713
- * Limit this canvas's render rate (frames per second).
752
+ * Run this Canvas root after the referenced Canvas root id(s).
753
+ */
754
+ after?: string | string[]
755
+ /**
756
+ * Numeric root order. Lower values run first.
757
+ */
758
+ order?: number
759
+ /**
760
+ * Limit this Canvas's default render job (frames per second).
714
761
  */
715
762
  fps?: number
716
763
  }
@@ -797,14 +844,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
797
844
  performance?: Partial<Omit<Performance, 'regress'>>
798
845
  /** Target pixel ratio. Can clamp between a range: `[min, max]` */
799
846
  dpr?: Dpr
800
- /** Props that go into the default raycaster */
801
- raycaster?: Partial<THREE$1.Raycaster>
847
+ /**
848
+ * Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
849
+ * so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
850
+ */
851
+ raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
802
852
  /** A `THREE.Scene` instance or props that go into the default scene */
803
853
  scene?: THREE$1.Scene | Partial<THREE$1.Scene>
804
854
  /** A `THREE.Camera` instance or props that go into the default camera */
805
855
  camera?: CameraProps
806
856
  /** An R3F event manager to manage elements' pointer events */
807
- events?: (store: RootStore) => EventManager<HTMLElement>
857
+ events?: (store: RootStore) => EventManager<Element>
808
858
  /** Callback after the canvas has rendered (but not yet committed) */
809
859
  onCreated?: (state: RootState) => void
810
860
  /** Response for pointer clicks that have missed any target */
@@ -1033,7 +1083,7 @@ interface CanvasProps
1033
1083
  */
1034
1084
  resize?: Options
1035
1085
  /** The target where events are being subscribed to, default: the div that wraps canvas */
1036
- eventSource?: HTMLElement | React$1.RefObject<HTMLElement | null>
1086
+ eventSource?: Element | React$1.RefObject<Element | null>
1037
1087
  /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
1038
1088
  eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
1039
1089
  /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
@@ -1141,81 +1191,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
1141
1191
 
1142
1192
  type RenderTargetOptions = RenderTargetOptions$1
1143
1193
 
1144
- //* Global Types ==============================
1194
+ //* Global TSL Types ==============================
1145
1195
 
1146
1196
  declare global {
1147
1197
  /**
1148
- * Uniform node type.
1149
- *
1150
- * This is three's own `UniformNode`, not a re-declaration of it. It previously was a
1151
- * hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
1152
- * exported type globally — so R3F's ~58 references resolved to an approximation that was
1153
- * missing members three actually ships (`setName` among them) and had drifted to the wrong
1154
- * arity when three made `UniformNode` two-parameter.
1155
- *
1156
- * three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
1157
- * so the node type is fixed to `unknown` and the single parameter is kept for call-site
1158
- * ergonomics. The result is three's structural type, so members stay in sync with the
1159
- * installed three instead of needing to be mirrored by hand.
1198
+ * Broad callable-node fallback for dynamic store readers.
1199
+ * Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
1160
1200
  */
1161
- type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
1201
+ type CallableTSLNode = ((...params: never[]) => unknown) & {
1202
+ readonly shaderNode: unknown
1203
+ readonly id: number
1204
+ }
1162
1205
 
1163
- /**
1164
- * ShaderCallable - the return type of Fn()
1165
- * A callable shader function node that can be invoked with parameters.
1166
- * The function returns a ShaderNodeObject when called.
1167
- *
1168
- * @example
1169
- * ```tsx
1170
- * // Define a shader function
1171
- * const blendColorFn = Fn(([color1, color2, factor]) => {
1172
- * return mix(color1, color2, factor)
1173
- * })
1174
- *
1175
- * // Type when retrieving from nodes store
1176
- * const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
1177
- *
1178
- * // Or with specific return type
1179
- * const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
1180
- * ```
1181
- */
1182
- type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
1206
+ /** Legacy structural node accepted when at least one historical marker exists. */
1207
+ type LegacyTSLNodeLike = {
1208
+ label?: ((label: string) => unknown) | string
1209
+ setName?: (name: string) => unknown
1210
+ } & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
1183
1211
 
1184
- /**
1185
- * ShaderNodeRef - a ShaderNodeObject wrapper around a Node
1186
- * This is the common return type for TSL operations (add, mul, sin, etc.)
1187
- *
1188
- * @example
1189
- * ```tsx
1190
- * const { wobble } = nodes as { wobble: ShaderNodeRef }
1191
- * ```
1192
- */
1193
- type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
1212
+ /** Node type accepted by broad dynamic node-store readers. */
1213
+ type TSLNodeType = three_webgpu.Node | CallableTSLNode
1194
1214
 
1195
1215
  /**
1196
- * TSLNodeType - Union of all common TSL node types
1197
- * Used by ScopedStore to properly type node access from the store.
1198
- *
1199
- * Includes:
1200
- * - Node: base Three.js node type
1201
- * - ShaderCallable: function nodes created with Fn()
1202
- * - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
1203
- *
1204
- * @example
1205
- * ```tsx
1206
- * // In useLocalNodes, nodes are typed as TSLNodeType
1207
- * const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
1208
- * positionNode: nodes.myPosition, // Works - Node is in union
1209
- * blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
1210
- * }))
1211
- *
1212
- * // Can narrow with type guard or assertion when needed
1213
- * if (typeof blendColorFn === 'function') {
1214
- * blendColorFn(someColor, 0.5)
1215
- * }
1216
- * ```
1216
+ * Derive Three's shader node type from an existing node or a supported raw input.
1217
+ * Existing InputNode generics take precedence over structural value normalization.
1218
+ * Both generics must be inferred because Three's UniformNode intersects an unknown-typed
1219
+ * InputNode base with its concrete InputNode specialization.
1217
1220
  */
1218
- type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
1221
+ type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
1222
+ ? TNodeType
1223
+ : T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
1224
+ ? TNodeType
1225
+ : T extends number
1226
+ ? 'float'
1227
+ : T extends boolean
1228
+ ? 'bool'
1229
+ : T extends string | three_webgpu.Color | { r: number; g: number; b: number }
1230
+ ? 'color'
1231
+ : T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
1232
+ ? 'vec4'
1233
+ : T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
1234
+ ? 'vec3'
1235
+ : T extends three_webgpu.Vector2 | { x: number; y: number }
1236
+ ? 'vec2'
1237
+ : T extends three_webgpu.Matrix4
1238
+ ? 'mat4'
1239
+ : T extends three_webgpu.Matrix3
1240
+ ? 'mat3'
1241
+ : T extends three_webgpu.Matrix2
1242
+ ? 'mat2'
1243
+ : unknown
1244
+
1245
+ /** Derive the normalized JavaScript value stored by a uniform node. */
1246
+ type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
1247
+ ? TValue
1248
+ : T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
1249
+ ? TValue
1250
+ : T extends string | { r: number; g: number; b: number }
1251
+ ? three_webgpu.Color
1252
+ : T extends { x: number; y: number; z: number; w: number }
1253
+ ? three_webgpu.Vector4
1254
+ : T extends { x: number; y: number; z: number }
1255
+ ? three_webgpu.Vector3
1256
+ : T extends { x: number; y: number }
1257
+ ? three_webgpu.Vector2
1258
+ : T extends number
1259
+ ? number
1260
+ : T extends boolean
1261
+ ? boolean
1262
+ : T
1263
+
1264
+ /** Three's exact UniformNode with shader and value generics derived from an input. */
1265
+ type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
1266
+
1267
+ /** Preserve every input key while mapping values to exact Three uniform nodes. */
1268
+ type UniformNodesFor<T extends UniformInputRecord> = {
1269
+ [K in keyof T]: UniformNodeFor<T[K]>
1270
+ }
1271
+
1272
+ /** Backward-compatible single-parameter uniform alias. */
1273
+ type UniformNode<T = unknown> = UniformNodeFor<T>
1219
1274
 
1220
1275
  /** Flat record of uniform nodes (no nested scopes) */
1221
1276
  type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
@@ -1240,7 +1295,7 @@ declare global {
1240
1295
  * Acceptable input values for useUniforms - raw values that get converted to UniformNodes
1241
1296
  * Supports:
1242
1297
  * - Primitives: number, string (color), boolean
1243
- * - Three.js types: Color, Vector2/3/4, Matrix3/4, Euler, Quaternion
1298
+ * - Three.js types: Color, Vector2/3/4, Matrix2/3/4
1244
1299
  * - Plain objects: { x, y, z, w } converted to vectors
1245
1300
  * - TSL nodes: color(), vec3(), float() for type casting
1246
1301
  * - UniformNode: existing uniforms (reused as-is)
@@ -1253,88 +1308,124 @@ declare global {
1253
1308
  | three_webgpu.Vector2
1254
1309
  | three_webgpu.Vector3
1255
1310
  | three_webgpu.Vector4
1311
+ | three_webgpu.Matrix2
1256
1312
  | three_webgpu.Matrix3
1257
1313
  | three_webgpu.Matrix4
1258
- | three_webgpu.Euler
1259
- | three_webgpu.Quaternion
1260
- | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
1314
+ | { x: number; y: number }
1315
+ | { x: number; y: number; z: number }
1316
+ | { x: number; y: number; z: number; w: number }
1261
1317
  | { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
1262
- | Node // TSL nodes like color(), vec3(), float() for type casting
1318
+ | three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
1263
1319
  | UniformNode
1264
1320
 
1265
1321
  /** Input record for useUniforms - accepts raw values or UniformNodes */
1266
1322
  type UniformInputRecord = Record<string, UniformValue>
1267
1323
  }
1268
1324
 
1269
- //* Module Augmentation ==============================
1270
-
1271
- declare module 'three/tsl' {
1325
+ declare global {
1272
1326
  /**
1273
- * Fn with array parameter destructuring
1274
- * @example Fn(([uv, skew]) => { ... })
1327
+ * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1328
+ * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1329
+ * is r185, so the new name is the only one.
1275
1330
  */
1276
- export function Fn<R extends Node = Node>(
1277
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1278
- ): ShaderCallable<R>
1331
+ type ThreeRenderPipeline = three_webgpu.RenderPipeline
1279
1332
 
1280
1333
  /**
1281
- * Fn with object parameter destructuring
1282
- * @example Fn(({ color, intensity }) => { ... })
1334
+ * The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
1335
+ * `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
1336
+ * `getTextureNode`, `setMRT` and `dispose` track the installed version.
1283
1337
  */
1284
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1285
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1286
- ): ShaderCallable<R>
1338
+ type ScenePassNode = three_webgpu.PassNode
1287
1339
 
1288
1340
  /**
1289
- * Fn with array params + layout
1290
- * @example Fn(([a, b]) => { ... }, { layout: [...] })
1341
+ * Pass record - stores TSL pass nodes for render pipeline.
1342
+ *
1343
+ * `scenePass` is the only key the library owns. It is optional here because this is also the
1344
+ * shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
1345
+ * or `clearPasses()`. Inside the callbacks it is always present; see
1346
+ * {@link RenderPipelineCallbackState}.
1347
+ *
1348
+ * Every other key is user-registered, via a callback's return value. Those are TSL nodes of
1349
+ * any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
1350
+ * `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
1351
+ * site when you need a member, e.g. `passes.velocity as TextureNode`.
1352
+ *
1353
+ * The index signature admits `undefined` because a key may simply not be registered, and
1354
+ * because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
1355
+ * optional property whose type excludes `undefined` from the index signature is an error
1356
+ * (TS2411) for every consumer compiling these declarations.
1291
1357
  */
1292
- export function Fn<R extends Node = Node>(
1293
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1294
- layout: { layout?: unknown },
1295
- ): ShaderCallable<R>
1358
+ interface PassRecord {
1359
+ scenePass?: ScenePassNode
1360
+ [key: string]: three_webgpu.Node | undefined
1361
+ }
1296
1362
 
1297
1363
  /**
1298
- * Fn with object params + layout
1364
+ * State passed to pipeline callbacks after the active pipeline has been created.
1365
+ *
1366
+ * `passes.scenePass` is required here: the hook installs the default scene pass before either
1367
+ * callback runs, so callbacks can use it without a guard or a cast.
1368
+ *
1369
+ * `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
1370
+ * the legacy renderer before either callback can run, so a callback never sees WebGL.
1299
1371
  */
1300
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1301
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1302
- layout: { layout?: unknown },
1303
- ): ShaderCallable<R>
1304
- }
1372
+ type RenderPipelineCallbackState = RootState & {
1373
+ renderPipeline: ThreeRenderPipeline
1374
+ passes: PassRecord & { scenePass: ScenePassNode }
1375
+ renderer: three_webgpu.WebGPURenderer
1376
+ isLegacy: false
1377
+ }
1305
1378
 
1306
- declare global {
1307
1379
  /**
1308
- * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1309
- * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1310
- * is r185, so the new name is the only one.
1380
+ * What a callback may return to register entries into `state.passes`.
1381
+ *
1382
+ * `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
1383
+ * created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
1384
+ * store entry would leave the store pointing at a node the hook never disposes, and the hook
1385
+ * disposing a pass nothing references. So returning it is a type error.
1311
1386
  */
1312
- type ThreeRenderPipeline = three_webgpu.RenderPipeline
1313
-
1314
- /** Pass record - stores TSL pass nodes for render pipeline */
1315
- type PassRecord = Record<string, any>
1387
+ type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
1316
1388
 
1317
1389
  /** Setup callback - runs first to configure MRT, create additional passes */
1318
- type RenderPipelineSetupCallback = (state: RootState) => PassRecord | void
1390
+ type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1319
1391
 
1320
1392
  /** Main callback - runs second to configure outputNode, create effect passes */
1321
- type RenderPipelineMainCallback = (state: RootState) => PassRecord | void
1393
+ type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1322
1394
 
1323
- /** Return type for useRenderPipeline hook */
1324
- interface UseRenderPipelineReturn {
1395
+ /** The imperative half of useRenderPipeline's return value, present in every state */
1396
+ interface UseRenderPipelineActions {
1325
1397
  /** Current passes from state */
1326
1398
  passes: PassRecord
1327
- /** RenderPipeline instance (null if not initialized) */
1328
- renderPipeline: ThreeRenderPipeline | null
1329
1399
  /** Clear all passes from state */
1330
1400
  clearPasses: () => void
1331
1401
  /** Reset RenderPipeline entirely (clears PP + passes) */
1332
1402
  reset: () => void
1333
1403
  /** Re-run setup/main callbacks with current closure values */
1334
1404
  rebuild: () => void
1335
- /** True when RenderPipeline is configured and ready */
1336
- isReady: boolean
1337
1405
  }
1406
+
1407
+ /**
1408
+ * Return type for useRenderPipeline hook, discriminated on `isReady`.
1409
+ *
1410
+ * `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
1411
+ * callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
1412
+ * `clearPasses()` empties the record while leaving the pipeline in place.
1413
+ */
1414
+ type UseRenderPipelineReturn = UseRenderPipelineActions &
1415
+ (
1416
+ | {
1417
+ /** True when RenderPipeline is configured and ready */
1418
+ isReady: true
1419
+ /** RenderPipeline instance */
1420
+ renderPipeline: ThreeRenderPipeline
1421
+ }
1422
+ | {
1423
+ /** False until the pipeline has been created */
1424
+ isReady: false
1425
+ /** Not initialized yet, or torn down by reset() */
1426
+ renderPipeline: null
1427
+ }
1428
+ )
1338
1429
  }
1339
1430
 
1340
1431
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
@@ -1413,10 +1504,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
1413
1504
 
1414
1505
  /**
1415
1506
  * For node material properties (colorNode, positionNode, etc.), accept broader types
1416
- * since @types/three has broken inheritance for TSL node subclasses.
1507
+ * since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
1508
+ * `nodeType`, so this structural key test remains neutral to the selected Three entry.
1417
1509
  */
1418
1510
  type NodeProps<P> = {
1419
- [K in keyof P as P[K] extends Node$1 | null ? K : never]?: TSLNodeInput
1511
+ [K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
1420
1512
  }
1421
1513
 
1422
1514
  interface ReactProps<P> {
@@ -1437,11 +1529,30 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
1437
1529
  [K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
1438
1530
  }
1439
1531
 
1532
+ /** Method names of Object3D, excluded from the `primitive` element's typed props. */
1533
+ type Object3DMethod = NonNullable<
1534
+ {
1535
+ [K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
1536
+ }[keyof Object3D]
1537
+ >
1538
+
1440
1539
  type ThreeExports = typeof THREE
1441
1540
  type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
1442
1541
 
1443
1542
  interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
1444
- primitive: Omit<ThreeElement<any>, 'args'> & { object: object }
1543
+ /**
1544
+ * `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
1545
+ * Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
1546
+ * untyped, and any other prop is accepted and applied to the object by name. Object3D's own
1547
+ * methods are left out of the typed surface: they return `this`, so a subclass element's
1548
+ * props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
1549
+ */
1550
+ primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | 'onUpdate' | Object3DMethod> & {
1551
+ object: object
1552
+ ref?: React.Ref<any>
1553
+ onUpdate?: (self: any) => void
1554
+ [prop: string]: unknown
1555
+ }
1445
1556
  // Conflicts with DOM types can be accessed through a three* prefix
1446
1557
  threeAudio: ThreeElementsImpl['audio']
1447
1558
  threeSource: ThreeElementsImpl['source']
@@ -1482,6 +1593,7 @@ type three_d_Matrix3 = Matrix3;
1482
1593
  type three_d_Matrix4 = Matrix4;
1483
1594
  type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
1484
1595
  type three_d_NodeProps<P> = NodeProps<P>;
1596
+ type three_d_Object3DMethod = Object3DMethod;
1485
1597
  type three_d_Quaternion = Quaternion;
1486
1598
  type three_d_RaycastableRepresentation = RaycastableRepresentation;
1487
1599
  type three_d_ReactProps<P> = ReactProps<P>;
@@ -1496,7 +1608,7 @@ type three_d_Vector3 = Vector3;
1496
1608
  type three_d_Vector4 = Vector4;
1497
1609
  type three_d_VectorRepresentation = VectorRepresentation;
1498
1610
  declare namespace three_d {
1499
- export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
1611
+ export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Object3DMethod as Object3DMethod, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
1500
1612
  }
1501
1613
 
1502
1614
  /**
@@ -1845,7 +1957,7 @@ declare function createEvents(store: RootStore): {
1845
1957
  processDeferredPointer: (event: DomEvent, pointerId: number) => void;
1846
1958
  };
1847
1959
  /** Default R3F event manager for web */
1848
- declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
1960
+ declare function createPointerEvents(store: RootStore): EventManager<Element>;
1849
1961
 
1850
1962
  /**
1851
1963
  * Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
@@ -1878,7 +1990,7 @@ declare namespace useLoader {
1878
1990
  *
1879
1991
  * @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
1880
1992
  * @param priorityOrOptions - Either a priority number (backwards compat) or options object
1881
- * @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
1993
+ * @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
1882
1994
  *
1883
1995
  * @example
1884
1996
  * // Simple priority (backwards compat)
@@ -2174,7 +2286,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
2174
2286
  * Invalidates the view, requesting a frame to be rendered.
2175
2287
  * In demand mode, this triggers the scheduler to run frames.
2176
2288
  *
2177
- * @param state - Optional root state (ignored in new scheduler, kept for backwards compat)
2289
+ * With a state argument, only that root's jobs run on the requested frames; other
2290
+ * roots on 'demand' stay idle. Without one, every registered root is invalidated.
2291
+ *
2292
+ * @param state - Optional root state; targets the invalidation at that root
2178
2293
  * @param frames - Number of frames to request (default: 1)
2179
2294
  * @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
2180
2295
  *
@@ -2185,14 +2300,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
2185
2300
  * Advances the frameloop and runs render effects.
2186
2301
  * Useful for when manually rendering via `frameloop="never"`.
2187
2302
  *
2303
+ * With a state argument, only that root is stepped. Without one, every
2304
+ * registered root is stepped for backwards compatibility.
2305
+ *
2188
2306
  * @param timestamp - The timestamp to use for this frame
2189
2307
  * @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)
2308
+ * @param state - Optional root state; targets the manual step at that root
2192
2309
  *
2193
2310
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
2194
2311
  */
2195
- declare function advance(timestamp: number): void;
2312
+ declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
2196
2313
 
2197
2314
  /* eslint-disable @definitelytyped/no-unnecessary-generics */
2198
2315
  declare function ReactReconciler<
@@ -3237,6 +3354,7 @@ declare namespace ReactReconciler {
3237
3354
 
3238
3355
  declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
3239
3356
  declare function extend<T extends Catalogue>(objects: T): void;
3357
+ declare function extend(objects: Record<string, unknown>): void;
3240
3358
  declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
3241
3359
 
3242
3360
  declare const isRenderer: (def: any) => boolean;
@@ -3680,29 +3798,44 @@ declare const hasConstructor: (object: unknown) => object is {
3680
3798
  * Used to identify values that should be resolved from refs after mount.
3681
3799
  */
3682
3800
  declare const FROM_REF: unique symbol;
3801
+ /** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
3802
+ interface FromRefMarker<T = unknown, R = T> {
3803
+ [FROM_REF]: React$1.RefObject<T | null>;
3804
+ /** Optional transform applied to the resolved ref before assignment. */
3805
+ transform?: (value: T) => R;
3806
+ }
3683
3807
  /**
3684
3808
  * Defers prop application until the referenced object is available.
3685
3809
  * Useful for props like `target` that need sibling refs to be populated.
3686
3810
  *
3811
+ * Only top-level props on a three element are resolved: a marker nested inside another value
3812
+ * (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
3813
+ * than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
3814
+ * what gets assigned.
3815
+ *
3687
3816
  * @param ref - React ref object to resolve at mount time
3688
- * @returns A marker value that applyProps will resolve after mount
3817
+ * @param transform - Optional mapping from the resolved object to the value the prop expects
3818
+ * @returns A marker value that the reconciler resolves after mount
3689
3819
  *
3690
3820
  * @example
3691
3821
  * const targetRef = useRef<THREE.Object3D>(null)
3692
3822
  *
3693
3823
  * <group ref={targetRef} position={[-3, -2, -15]} />
3694
3824
  * <spotLight target={fromRef(targetRef)} intensity={100} />
3825
+ *
3826
+ * @example
3827
+ * // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
3828
+ * <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
3695
3829
  */
3696
3830
  declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
3831
+ declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
3697
3832
  /**
3698
3833
  * Type guard to check if a value is a fromRef marker.
3699
3834
  *
3700
3835
  * @param value - Value to check
3701
3836
  * @returns True if value is a fromRef marker
3702
3837
  */
3703
- declare function isFromRef(value: unknown): value is {
3704
- [FROM_REF]: React$1.RefObject<any>;
3705
- };
3838
+ declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
3706
3839
 
3707
3840
  /**
3708
3841
  * Symbol marker for mount-only method calls.
@@ -3729,7 +3862,15 @@ declare const ONCE: unique symbol;
3729
3862
  * // No arguments
3730
3863
  * <geometry center={once()} />
3731
3864
  */
3732
- declare function once<T>(...args: T[]): T;
3865
+ declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
3866
+ /**
3867
+ * What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
3868
+ * the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
3869
+ * methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
3870
+ *
3871
+ * The runtime value is always the marker object; only the declared type follows the prop.
3872
+ */
3873
+ type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
3733
3874
  /**
3734
3875
  * Type guard to check if a value is a once marker.
3735
3876
  *
@@ -3747,4 +3888,4 @@ declare function isOnce(value: unknown): value is {
3747
3888
  declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
3748
3889
 
3749
3890
  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, LegacyInternalState as 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, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, LegacyRootState as 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 };
3891
+ 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, FromRefMarker, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as 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, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, LegacyRootState as 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 };