@react-three/fiber 10.0.0-canary.4a21acb → 10.0.0-canary.4bf885a

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.ts CHANGED
@@ -1,5 +1,6 @@
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
- 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
+ import { CubeRenderTarget, RenderTarget, WebGPURenderer, Node, StorageTexture, Storage3DTexture, StorageArrayTexture, Data3DTexture, CanvasTarget, 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, Object3D, 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, Frustum, OrthographicCamera } from 'three/webgpu';
3
4
  import * as THREE$1 from 'three';
4
5
  import { WebGLCubeRenderTarget, WebGLRenderTarget, WebGLRenderer, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
5
6
  import { WebGLRendererParameters } from 'three/src/renderers/WebGLRenderer.js';
@@ -12,23 +13,8 @@ import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFr
12
13
  export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
13
14
  import { Options } from 'react-use-measure';
14
15
  import * as react_jsx_runtime from 'react/jsx-runtime';
15
- import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
16
16
  import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
17
17
 
18
- function _mergeNamespaces(n, m) {
19
- m.forEach(function (e) {
20
- e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
21
- if (k !== 'default' && !(k in n)) {
22
- var d = Object.getOwnPropertyDescriptor(e, k);
23
- Object.defineProperty(n, k, d.get ? d : {
24
- enumerable: true,
25
- get: function () { return e[k]; }
26
- });
27
- }
28
- });
29
- });
30
- return Object.freeze(n);
31
- }
32
18
 
33
19
  /**
34
20
  * @fileoverview Internal Three.js re-exports - DEFAULT ENTRY
@@ -48,19 +34,9 @@ function _mergeNamespaces(n, m) {
48
34
  declare const R3F_BUILD_LEGACY = true;
49
35
  declare const R3F_BUILD_WEBGPU = true;
50
36
 
51
- var THREE = /*#__PURE__*/_mergeNamespaces({
52
- __proto__: null,
53
- CubeRenderTarget: CubeRenderTarget,
54
- CubeRenderTargetCompat: CubeRenderTarget,
55
- Inspector: Inspector,
56
- R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
57
- R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
58
- RenderTargetCompat: RenderTarget,
59
- WebGLCubeRenderTarget: WebGLCubeRenderTarget,
60
- WebGLRenderTarget: WebGLRenderTarget,
61
- WebGLRenderer: WebGLRenderer,
62
- WebGLRendererParameters: WebGLRendererParameters
63
- }, [three_webgpu]);
37
+ /** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
38
+ declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
39
+
64
40
 
65
41
  //* Utility Types ==============================
66
42
 
@@ -348,6 +324,7 @@ type BufferLike =
348
324
  | Uint16Array
349
325
  | Int16Array
350
326
  | THREE$1.BufferAttribute // Base class for all buffer attributes
327
+ | THREE$1.InterleavedBufferAttribute
351
328
  | Node // TSL buffer nodes (instancedArray, storage)
352
329
 
353
330
  /** Flat record of buffer-like values (no nested scopes) */
@@ -359,6 +336,25 @@ type BufferRecord = Record<string, BufferLike>
359
336
  */
360
337
  type BufferStore = Record<string, BufferLike | BufferRecord>
361
338
 
339
+ //* Node Types (useNodes) ========================================
340
+
341
+ /**
342
+ * Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
343
+ * the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
344
+ * code passes through. Creators are constrained to this same type, so the shape a creator returns
345
+ * and the shape the store holds are one type by construction.
346
+ */
347
+ type NodeLike = TSLNodeType | LegacyTSLNodeLike
348
+
349
+ /** Flat record of TSL nodes (no nested scopes) */
350
+ type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
351
+
352
+ /**
353
+ * Node store that can contain both root-level nodes and scoped node objects.
354
+ * Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
355
+ */
356
+ type NodeStore = Record<string, NodeLike | NodeRecord>
357
+
362
358
  //* Storage Types (useGPUStorage) ========================================
363
359
 
364
360
  /**
@@ -373,7 +369,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
373
369
  * ```
374
370
  */
375
371
  type StorageLike =
376
- | StorageTexture // GPU storage texture
372
+ | StorageTexture // 2D GPU storage texture
373
+ | Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
374
+ | StorageArrayTexture // 2D-array GPU storage texture
377
375
  | Data3DTexture // 3D texture (can be used as storage)
378
376
  | Node // TSL storage texture nodes (storageTexture)
379
377
 
@@ -485,6 +483,12 @@ interface InternalState {
485
483
  actualRenderer: R3FRenderer
486
484
  /** Global scheduler reference (for useFrame hook) */
487
485
  scheduler: SchedulerApi | null
486
+ /**
487
+ * Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
488
+ * `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
489
+ * render-phase takeover. Used by `useRenderPipeline`.
490
+ */
491
+ renderOverride?: (() => void) | null
488
492
  /** This root's unique ID in the global scheduler */
489
493
  rootId?: string
490
494
  /** Function to unregister this root from the global scheduler */
@@ -492,11 +496,28 @@ interface InternalState {
492
496
  /** Container for child attachment (scene for root, original container for portals) */
493
497
  container?: THREE$1.Object3D
494
498
  /**
495
- * CanvasTarget for multi-canvas WebGPU rendering.
496
- * Created for all WebGPU canvases to support renderer sharing.
499
+ * The CanvasTarget this root sizes and renders through.
500
+ *
501
+ * A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
502
+ * around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
503
+ * R3F created for its own element. Either way there is exactly one target per canvas element,
504
+ * and the canvas-target job makes it the renderer's active one before this root renders.
505
+ * Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
497
506
  * @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
498
507
  */
499
508
  canvasTarget?: CanvasTarget
509
+ /**
510
+ * Set when this root's canvas target has been resized and the backend's cached render pass
511
+ * descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
512
+ *
513
+ * Flushed by the canvas-target job in the `start` phase, which is the only place this root's
514
+ * target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
515
+ * whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
516
+ * invalidate some other canvas's descriptor instead.
517
+ *
518
+ * @see https://github.com/pmndrs/react-three-fiber/issues/3847
519
+ */
520
+ canvasTargetSizeDirty?: boolean
500
521
  /**
501
522
  * Whether multi-canvas rendering is active.
502
523
  * True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
@@ -606,7 +627,7 @@ interface RootState {
606
627
  /** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
607
628
  uniforms: UniformStore
608
629
  /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
609
- nodes: Record<string, any>
630
+ nodes: NodeStore
610
631
  /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
611
632
  buffers: BufferStore
612
633
  /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
@@ -618,7 +639,7 @@ interface RootState {
618
639
  /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
619
640
  renderPipeline: ThreeRenderPipeline | null
620
641
  /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
621
- passes: Record<string, any>
642
+ passes: PassRecord
622
643
  /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
623
644
  _hmrVersion: number
624
645
  /** Internal: whether setSize() has taken ownership of canvas dimensions */
@@ -706,12 +727,19 @@ type DefaultRendererProps = {
706
727
  */
707
728
  interface CanvasSchedulerConfig {
708
729
  /**
709
- * Render this canvas after another canvas completes.
710
- * Pass the `id` of another canvas.
730
+ * Run this Canvas root before the referenced Canvas root id(s).
731
+ */
732
+ before?: string | string[]
733
+ /**
734
+ * Run this Canvas root after the referenced Canvas root id(s).
711
735
  */
712
- after?: string
736
+ after?: string | string[]
713
737
  /**
714
- * Limit this canvas's render rate (frames per second).
738
+ * Numeric root order. Lower values run first.
739
+ */
740
+ order?: number
741
+ /**
742
+ * Limit this Canvas's default render job (frames per second).
715
743
  */
716
744
  fps?: number
717
745
  }
@@ -798,14 +826,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
798
826
  performance?: Partial<Omit<Performance, 'regress'>>
799
827
  /** Target pixel ratio. Can clamp between a range: `[min, max]` */
800
828
  dpr?: Dpr
801
- /** Props that go into the default raycaster */
802
- raycaster?: Partial<THREE$1.Raycaster>
829
+ /**
830
+ * Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
831
+ * so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
832
+ */
833
+ raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
803
834
  /** A `THREE.Scene` instance or props that go into the default scene */
804
835
  scene?: THREE$1.Scene | Partial<THREE$1.Scene>
805
836
  /** A `THREE.Camera` instance or props that go into the default camera */
806
837
  camera?: CameraProps
807
838
  /** An R3F event manager to manage elements' pointer events */
808
- events?: (store: RootStore) => EventManager<HTMLElement>
839
+ events?: (store: RootStore) => EventManager<Element>
809
840
  /** Callback after the canvas has rendered (but not yet committed) */
810
841
  onCreated?: (state: RootState) => void
811
842
  /** Response for pointer clicks that have missed any target */
@@ -894,7 +925,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
894
925
  object?: T
895
926
  dispose?: null
896
927
  attach?: AttachType<T>
897
- onUpdate?: (self: T) => void
898
928
  }
899
929
 
900
930
  interface Instance<O = any> {
@@ -1034,7 +1064,7 @@ interface CanvasProps
1034
1064
  */
1035
1065
  resize?: Options
1036
1066
  /** The target where events are being subscribed to, default: the div that wraps canvas */
1037
- eventSource?: HTMLElement | React$1.RefObject<HTMLElement | null>
1067
+ eventSource?: Element | React$1.RefObject<Element | null>
1038
1068
  /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
1039
1069
  eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
1040
1070
  /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
@@ -1142,81 +1172,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
1142
1172
 
1143
1173
  type RenderTargetOptions = RenderTargetOptions$1
1144
1174
 
1145
- //* Global Types ==============================
1175
+ //* Global TSL Types ==============================
1146
1176
 
1147
1177
  declare global {
1148
1178
  /**
1149
- * Uniform node type.
1150
- *
1151
- * This is three's own `UniformNode`, not a re-declaration of it. It previously was a
1152
- * hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
1153
- * exported type globally — so R3F's ~58 references resolved to an approximation that was
1154
- * missing members three actually ships (`setName` among them) and had drifted to the wrong
1155
- * arity when three made `UniformNode` two-parameter.
1156
- *
1157
- * three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
1158
- * so the node type is fixed to `unknown` and the single parameter is kept for call-site
1159
- * ergonomics. The result is three's structural type, so members stay in sync with the
1160
- * installed three instead of needing to be mirrored by hand.
1179
+ * Broad callable-node fallback for dynamic store readers.
1180
+ * Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
1161
1181
  */
1162
- type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
1182
+ type CallableTSLNode = ((...params: never[]) => unknown) & {
1183
+ readonly shaderNode: unknown
1184
+ readonly id: number
1185
+ }
1163
1186
 
1164
- /**
1165
- * ShaderCallable - the return type of Fn()
1166
- * A callable shader function node that can be invoked with parameters.
1167
- * The function returns a ShaderNodeObject when called.
1168
- *
1169
- * @example
1170
- * ```tsx
1171
- * // Define a shader function
1172
- * const blendColorFn = Fn(([color1, color2, factor]) => {
1173
- * return mix(color1, color2, factor)
1174
- * })
1175
- *
1176
- * // Type when retrieving from nodes store
1177
- * const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
1178
- *
1179
- * // Or with specific return type
1180
- * const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
1181
- * ```
1182
- */
1183
- type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
1187
+ /** Legacy structural node accepted when at least one historical marker exists. */
1188
+ type LegacyTSLNodeLike = {
1189
+ label?: ((label: string) => unknown) | string
1190
+ setName?: (name: string) => unknown
1191
+ } & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
1184
1192
 
1185
- /**
1186
- * ShaderNodeRef - a ShaderNodeObject wrapper around a Node
1187
- * This is the common return type for TSL operations (add, mul, sin, etc.)
1188
- *
1189
- * @example
1190
- * ```tsx
1191
- * const { wobble } = nodes as { wobble: ShaderNodeRef }
1192
- * ```
1193
- */
1194
- type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
1193
+ /** Node type accepted by broad dynamic node-store readers. */
1194
+ type TSLNodeType = three_webgpu.Node | CallableTSLNode
1195
1195
 
1196
1196
  /**
1197
- * TSLNodeType - Union of all common TSL node types
1198
- * Used by ScopedStore to properly type node access from the store.
1199
- *
1200
- * Includes:
1201
- * - Node: base Three.js node type
1202
- * - ShaderCallable: function nodes created with Fn()
1203
- * - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
1204
- *
1205
- * @example
1206
- * ```tsx
1207
- * // In useLocalNodes, nodes are typed as TSLNodeType
1208
- * const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
1209
- * positionNode: nodes.myPosition, // Works - Node is in union
1210
- * blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
1211
- * }))
1212
- *
1213
- * // Can narrow with type guard or assertion when needed
1214
- * if (typeof blendColorFn === 'function') {
1215
- * blendColorFn(someColor, 0.5)
1216
- * }
1217
- * ```
1197
+ * Derive Three's shader node type from an existing node or a supported raw input.
1198
+ * Existing InputNode generics take precedence over structural value normalization.
1199
+ * Both generics must be inferred because Three's UniformNode intersects an unknown-typed
1200
+ * InputNode base with its concrete InputNode specialization.
1218
1201
  */
1219
- type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
1202
+ type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
1203
+ ? TNodeType
1204
+ : T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
1205
+ ? TNodeType
1206
+ : T extends number
1207
+ ? 'float'
1208
+ : T extends boolean
1209
+ ? 'bool'
1210
+ : T extends string | three_webgpu.Color | { r: number; g: number; b: number }
1211
+ ? 'color'
1212
+ : T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
1213
+ ? 'vec4'
1214
+ : T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
1215
+ ? 'vec3'
1216
+ : T extends three_webgpu.Vector2 | { x: number; y: number }
1217
+ ? 'vec2'
1218
+ : T extends three_webgpu.Matrix4
1219
+ ? 'mat4'
1220
+ : T extends three_webgpu.Matrix3
1221
+ ? 'mat3'
1222
+ : T extends three_webgpu.Matrix2
1223
+ ? 'mat2'
1224
+ : unknown
1225
+
1226
+ /** Derive the normalized JavaScript value stored by a uniform node. */
1227
+ type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
1228
+ ? TValue
1229
+ : T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
1230
+ ? TValue
1231
+ : T extends string | { r: number; g: number; b: number }
1232
+ ? three_webgpu.Color
1233
+ : T extends { x: number; y: number; z: number; w: number }
1234
+ ? three_webgpu.Vector4
1235
+ : T extends { x: number; y: number; z: number }
1236
+ ? three_webgpu.Vector3
1237
+ : T extends { x: number; y: number }
1238
+ ? three_webgpu.Vector2
1239
+ : T extends number
1240
+ ? number
1241
+ : T extends boolean
1242
+ ? boolean
1243
+ : T
1244
+
1245
+ /** Three's exact UniformNode with shader and value generics derived from an input. */
1246
+ type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
1247
+
1248
+ /** Preserve every input key while mapping values to exact Three uniform nodes. */
1249
+ type UniformNodesFor<T extends UniformInputRecord> = {
1250
+ [K in keyof T]: UniformNodeFor<T[K]>
1251
+ }
1252
+
1253
+ /** Backward-compatible single-parameter uniform alias. */
1254
+ type UniformNode<T = unknown> = UniformNodeFor<T>
1220
1255
 
1221
1256
  /** Flat record of uniform nodes (no nested scopes) */
1222
1257
  type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
@@ -1241,7 +1276,7 @@ declare global {
1241
1276
  * Acceptable input values for useUniforms - raw values that get converted to UniformNodes
1242
1277
  * Supports:
1243
1278
  * - Primitives: number, string (color), boolean
1244
- * - Three.js types: Color, Vector2/3/4, Matrix3/4, Euler, Quaternion
1279
+ * - Three.js types: Color, Vector2/3/4, Matrix2/3/4
1245
1280
  * - Plain objects: { x, y, z, w } converted to vectors
1246
1281
  * - TSL nodes: color(), vec3(), float() for type casting
1247
1282
  * - UniformNode: existing uniforms (reused as-is)
@@ -1254,88 +1289,124 @@ declare global {
1254
1289
  | three_webgpu.Vector2
1255
1290
  | three_webgpu.Vector3
1256
1291
  | three_webgpu.Vector4
1292
+ | three_webgpu.Matrix2
1257
1293
  | three_webgpu.Matrix3
1258
1294
  | three_webgpu.Matrix4
1259
- | three_webgpu.Euler
1260
- | three_webgpu.Quaternion
1261
- | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
1295
+ | { x: number; y: number }
1296
+ | { x: number; y: number; z: number }
1297
+ | { x: number; y: number; z: number; w: number }
1262
1298
  | { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
1263
- | Node // TSL nodes like color(), vec3(), float() for type casting
1299
+ | three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
1264
1300
  | UniformNode
1265
1301
 
1266
1302
  /** Input record for useUniforms - accepts raw values or UniformNodes */
1267
1303
  type UniformInputRecord = Record<string, UniformValue>
1268
1304
  }
1269
1305
 
1270
- //* Module Augmentation ==============================
1271
-
1272
- declare module 'three/tsl' {
1306
+ declare global {
1273
1307
  /**
1274
- * Fn with array parameter destructuring
1275
- * @example Fn(([uv, skew]) => { ... })
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.
1276
1311
  */
1277
- export function Fn<R extends Node = Node>(
1278
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1279
- ): ShaderCallable<R>
1312
+ type ThreeRenderPipeline = three_webgpu.RenderPipeline
1280
1313
 
1281
1314
  /**
1282
- * Fn with object parameter destructuring
1283
- * @example Fn(({ color, intensity }) => { ... })
1315
+ * The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
1316
+ * `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
1317
+ * `getTextureNode`, `setMRT` and `dispose` track the installed version.
1284
1318
  */
1285
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1286
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1287
- ): ShaderCallable<R>
1319
+ type ScenePassNode = three_webgpu.PassNode
1288
1320
 
1289
1321
  /**
1290
- * Fn with array params + layout
1291
- * @example Fn(([a, b]) => { ... }, { layout: [...] })
1322
+ * Pass record - stores TSL pass nodes for render pipeline.
1323
+ *
1324
+ * `scenePass` is the only key the library owns. It is optional here because this is also the
1325
+ * shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
1326
+ * or `clearPasses()`. Inside the callbacks it is always present; see
1327
+ * {@link RenderPipelineCallbackState}.
1328
+ *
1329
+ * Every other key is user-registered, via a callback's return value. Those are TSL nodes of
1330
+ * any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
1331
+ * `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
1332
+ * site when you need a member, e.g. `passes.velocity as TextureNode`.
1333
+ *
1334
+ * The index signature admits `undefined` because a key may simply not be registered, and
1335
+ * because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
1336
+ * optional property whose type excludes `undefined` from the index signature is an error
1337
+ * (TS2411) for every consumer compiling these declarations.
1292
1338
  */
1293
- export function Fn<R extends Node = Node>(
1294
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1295
- layout: { layout?: unknown },
1296
- ): ShaderCallable<R>
1339
+ interface PassRecord {
1340
+ scenePass?: ScenePassNode
1341
+ [key: string]: three_webgpu.Node | undefined
1342
+ }
1297
1343
 
1298
1344
  /**
1299
- * Fn with object params + layout
1345
+ * State passed to pipeline callbacks after the active pipeline has been created.
1346
+ *
1347
+ * `passes.scenePass` is required here: the hook installs the default scene pass before either
1348
+ * callback runs, so callbacks can use it without a guard or a cast.
1349
+ *
1350
+ * `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
1351
+ * the legacy renderer before either callback can run, so a callback never sees WebGL.
1300
1352
  */
1301
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1302
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1303
- layout: { layout?: unknown },
1304
- ): ShaderCallable<R>
1305
- }
1353
+ type RenderPipelineCallbackState = RootState & {
1354
+ renderPipeline: ThreeRenderPipeline
1355
+ passes: PassRecord & { scenePass: ScenePassNode }
1356
+ renderer: three_webgpu.WebGPURenderer
1357
+ isLegacy: false
1358
+ }
1306
1359
 
1307
- declare global {
1308
1360
  /**
1309
- * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1310
- * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1311
- * is r185, so the new name is the only one.
1361
+ * What a callback may return to register entries into `state.passes`.
1362
+ *
1363
+ * `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
1364
+ * created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
1365
+ * store entry would leave the store pointing at a node the hook never disposes, and the hook
1366
+ * disposing a pass nothing references. So returning it is a type error.
1312
1367
  */
1313
- type ThreeRenderPipeline = three_webgpu.RenderPipeline
1314
-
1315
- /** Pass record - stores TSL pass nodes for render pipeline */
1316
- type PassRecord = Record<string, any>
1368
+ type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
1317
1369
 
1318
1370
  /** Setup callback - runs first to configure MRT, create additional passes */
1319
- type RenderPipelineSetupCallback = (state: RootState) => PassRecord | void
1371
+ type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1320
1372
 
1321
1373
  /** Main callback - runs second to configure outputNode, create effect passes */
1322
- type RenderPipelineMainCallback = (state: RootState) => PassRecord | void
1374
+ type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1323
1375
 
1324
- /** Return type for useRenderPipeline hook */
1325
- interface UseRenderPipelineReturn {
1376
+ /** The imperative half of useRenderPipeline's return value, present in every state */
1377
+ interface UseRenderPipelineActions {
1326
1378
  /** Current passes from state */
1327
1379
  passes: PassRecord
1328
- /** RenderPipeline instance (null if not initialized) */
1329
- renderPipeline: ThreeRenderPipeline | null
1330
1380
  /** Clear all passes from state */
1331
1381
  clearPasses: () => void
1332
1382
  /** Reset RenderPipeline entirely (clears PP + passes) */
1333
1383
  reset: () => void
1334
1384
  /** Re-run setup/main callbacks with current closure values */
1335
1385
  rebuild: () => void
1336
- /** True when RenderPipeline is configured and ready */
1337
- isReady: boolean
1338
1386
  }
1387
+
1388
+ /**
1389
+ * Return type for useRenderPipeline hook, discriminated on `isReady`.
1390
+ *
1391
+ * `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
1392
+ * callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
1393
+ * `clearPasses()` empties the record while leaving the pipeline in place.
1394
+ */
1395
+ type UseRenderPipelineReturn = UseRenderPipelineActions &
1396
+ (
1397
+ | {
1398
+ /** True when RenderPipeline is configured and ready */
1399
+ isReady: true
1400
+ /** RenderPipeline instance */
1401
+ renderPipeline: ThreeRenderPipeline
1402
+ }
1403
+ | {
1404
+ /** False until the pipeline has been created */
1405
+ isReady: false
1406
+ /** Not initialized yet, or torn down by reset() */
1407
+ renderPipeline: null
1408
+ }
1409
+ )
1339
1410
  }
1340
1411
 
1341
1412
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
@@ -1414,10 +1485,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
1414
1485
 
1415
1486
  /**
1416
1487
  * For node material properties (colorNode, positionNode, etc.), accept broader types
1417
- * since @types/three has broken inheritance for TSL node subclasses.
1488
+ * since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
1489
+ * `nodeType`, so this structural key test remains neutral to the selected Three entry.
1418
1490
  */
1419
1491
  type NodeProps<P> = {
1420
- [K in keyof P as P[K] extends Node | null ? K : never]?: TSLNodeInput
1492
+ [K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
1421
1493
  }
1422
1494
 
1423
1495
  interface ReactProps<P> {
@@ -1438,11 +1510,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
1438
1510
  [K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
1439
1511
  }
1440
1512
 
1513
+ /** Method names of Object3D, excluded from the `primitive` element's typed props. */
1514
+ type Object3DMethod = NonNullable<
1515
+ {
1516
+ [K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
1517
+ }[keyof Object3D]
1518
+ >
1519
+
1441
1520
  type ThreeExports = typeof import('three') & typeof import('three/webgpu')
1442
1521
  type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
1443
1522
 
1444
1523
  interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
1445
- primitive: Omit<ThreeElement<any>, 'args'> & { object: object }
1524
+ /**
1525
+ * `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
1526
+ * Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
1527
+ * untyped, and any other prop is accepted and applied to the object by name. Object3D's own
1528
+ * methods are left out of the typed surface: they return `this`, so a subclass element's
1529
+ * props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
1530
+ */
1531
+ primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
1532
+ object: object
1533
+ ref?: React.Ref<any>
1534
+ [prop: string]: unknown
1535
+ }
1446
1536
  // Conflicts with DOM types can be accessed through a three* prefix
1447
1537
  threeAudio: ThreeElementsImpl['audio']
1448
1538
  threeSource: ThreeElementsImpl['source']
@@ -1483,6 +1573,7 @@ type three_d_Matrix3 = Matrix3;
1483
1573
  type three_d_Matrix4 = Matrix4;
1484
1574
  type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
1485
1575
  type three_d_NodeProps<P> = NodeProps<P>;
1576
+ type three_d_Object3DMethod = Object3DMethod;
1486
1577
  type three_d_Quaternion = Quaternion;
1487
1578
  type three_d_RaycastableRepresentation = RaycastableRepresentation;
1488
1579
  type three_d_ReactProps<P> = ReactProps<P>;
@@ -1497,7 +1588,7 @@ type three_d_Vector3 = Vector3;
1497
1588
  type three_d_Vector4 = Vector4;
1498
1589
  type three_d_VectorRepresentation = VectorRepresentation;
1499
1590
  declare namespace three_d {
1500
- 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 };
1591
+ 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 };
1501
1592
  }
1502
1593
 
1503
1594
  /**
@@ -1635,9 +1726,9 @@ type EnvironmentProps = {
1635
1726
  blur?: number;
1636
1727
  backgroundBlurriness?: number;
1637
1728
  backgroundIntensity?: number;
1638
- backgroundRotation?: Euler$3;
1729
+ backgroundRotation?: Euler;
1639
1730
  environmentIntensity?: number;
1640
- environmentRotation?: Euler$3;
1731
+ environmentRotation?: Euler;
1641
1732
  map?: Texture$1;
1642
1733
  preset?: PresetsType;
1643
1734
  scene?: Scene | React$1.RefObject<Scene>;
@@ -1721,7 +1812,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
1721
1812
  declare function EnvironmentPortal({ children, near, far, resolution, frames, map, background, blur, backgroundBlurriness, backgroundIntensity, backgroundRotation, environmentIntensity, environmentRotation, scene, files, path, preset, extensions, }: EnvironmentProps): react_jsx_runtime.JSX.Element;
1722
1813
  declare module '@react-three/fiber' {
1723
1814
  interface ThreeElements {
1724
- groundProjectedEnvImpl: ThreeElement$1<typeof GroundedSkybox>;
1815
+ groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
1725
1816
  }
1726
1817
  }
1727
1818
  /**
@@ -1821,6 +1912,24 @@ declare module '@react-three/fiber' {
1821
1912
  */
1822
1913
  declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
1823
1914
 
1915
+ /**
1916
+ * Moves every trace of interactivity from one object to its replacement, for reconstruction.
1917
+ *
1918
+ * When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
1919
+ * instance. Removing the old object from the interaction state and registering the new one from
1920
+ * scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
1921
+ * the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
1922
+ * is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
1923
+ * swap the user never asked to see (#3744).
1924
+ *
1925
+ * Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
1926
+ * left alone — releasing and re-acquiring it is precisely the glitch being avoided.
1927
+ *
1928
+ * Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
1929
+ * the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
1930
+ * cannot outlive the object it described.
1931
+ */
1932
+ declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
1824
1933
  declare function removeInteractivity(store: RootStore, object: Object3D): void;
1825
1934
  declare function createEvents(store: RootStore): {
1826
1935
  handlePointer: (name: string) => (event: DomEvent) => void;
@@ -1828,7 +1937,48 @@ declare function createEvents(store: RootStore): {
1828
1937
  processDeferredPointer: (event: DomEvent, pointerId: number) => void;
1829
1938
  };
1830
1939
  /** Default R3F event manager for web */
1831
- declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
1940
+ declare function createPointerEvents(store: RootStore): EventManager<Element>;
1941
+
1942
+ interface RootExtension {
1943
+ /** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
1944
+ * set up are not set up a second time, but get the new entry's dispose and hmr. */
1945
+ name: string;
1946
+ /**
1947
+ * Called once per root, after its renderer exists and before `onCreated` and the first frame.
1948
+ * `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
1949
+ * to the primary canvas. Return fields to merge into the root's state, or nothing.
1950
+ */
1951
+ setup?(store: RootStore): Partial<RootState> | void;
1952
+ /** Called when a root this extension set up unmounts. */
1953
+ dispose?(store: RootStore): void;
1954
+ /** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
1955
+ hmr?(store: RootStore): void;
1956
+ }
1957
+ /**
1958
+ * Register an extension. It is set up on every live root immediately, and on every root created
1959
+ * afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
1960
+ * it already set up keep its state and still get its dispose when they unmount.
1961
+ */
1962
+ declare function registerRootExtension(extension: RootExtension): () => void;
1963
+ /**
1964
+ * Point a root's default render job at a different render function, or back at
1965
+ * `renderer.render(scene, camera)` with `null`.
1966
+ *
1967
+ * The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
1968
+ * boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
1969
+ */
1970
+ declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
1971
+
1972
+ /**
1973
+ * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
1974
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
1975
+ */
1976
+ declare function useStore(): RootStore;
1977
+ /**
1978
+ * Accesses R3F's internal state, containing renderer, canvas, scene, etc.
1979
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
1980
+ */
1981
+ declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
1832
1982
 
1833
1983
  /**
1834
1984
  * Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
@@ -1861,7 +2011,7 @@ declare namespace useLoader {
1861
2011
  *
1862
2012
  * @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
1863
2013
  * @param priorityOrOptions - Either a priority number (backwards compat) or options object
1864
- * @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
2014
+ * @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
1865
2015
  *
1866
2016
  * @example
1867
2017
  * // Simple priority (backwards compat)
@@ -2072,16 +2222,6 @@ declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
2072
2222
  declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
2073
2223
  declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
2074
2224
 
2075
- /**
2076
- * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
2077
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
2078
- */
2079
- declare function useStore(): RootStore;
2080
- /**
2081
- * Accesses R3F's internal state, containing renderer, canvas, scene, etc.
2082
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
2083
- */
2084
- declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
2085
2225
  /**
2086
2226
  * Exposes an object's {@link Instance}.
2087
2227
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
@@ -2157,7 +2297,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
2157
2297
  * Invalidates the view, requesting a frame to be rendered.
2158
2298
  * In demand mode, this triggers the scheduler to run frames.
2159
2299
  *
2160
- * @param state - Optional root state (ignored in new scheduler, kept for backwards compat)
2300
+ * With a state argument, only that root's jobs run on the requested frames; other
2301
+ * roots on 'demand' stay idle. Without one, every registered root is invalidated.
2302
+ *
2303
+ * @param state - Optional root state; targets the invalidation at that root
2161
2304
  * @param frames - Number of frames to request (default: 1)
2162
2305
  * @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
2163
2306
  *
@@ -2168,14 +2311,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
2168
2311
  * Advances the frameloop and runs render effects.
2169
2312
  * Useful for when manually rendering via `frameloop="never"`.
2170
2313
  *
2314
+ * With a state argument, only that root is stepped. Without one, every
2315
+ * registered root is stepped for backwards compatibility.
2316
+ *
2171
2317
  * @param timestamp - The timestamp to use for this frame
2172
2318
  * @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
2173
- * @param state - Ignored (kept for backwards compat)
2174
- * @param frame - Ignored (kept for backwards compat)
2319
+ * @param state - Optional root state; targets the manual step at that root
2175
2320
  *
2176
2321
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
2177
2322
  */
2178
- declare function advance(timestamp: number): void;
2323
+ declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
2179
2324
 
2180
2325
  /* eslint-disable @definitelytyped/no-unnecessary-generics */
2181
2326
  declare function ReactReconciler<
@@ -3220,6 +3365,7 @@ declare namespace ReactReconciler {
3220
3365
 
3221
3366
  declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
3222
3367
  declare function extend<T extends Catalogue>(objects: T): void;
3368
+ declare function extend(objects: Record<string, unknown>): void;
3223
3369
  declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
3224
3370
 
3225
3371
  declare const isRenderer: (def: any) => boolean;
@@ -3244,13 +3390,9 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
3244
3390
  declare function flushSync<R>(fn: () => R): R;
3245
3391
 
3246
3392
  declare const context: React$1.Context<RootStore>;
3393
+
3247
3394
  declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
3248
3395
 
3249
- /**
3250
- * Safely flush async effects when testing, simulating a legacy root.
3251
- * @deprecated Import from React instead. import { act } from 'react'
3252
- */
3253
- declare const act: typeof React$1.act;
3254
3396
  /**
3255
3397
  * An SSR-friendly useLayoutEffect.
3256
3398
  *
@@ -3502,7 +3644,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
3502
3644
  declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
3503
3645
  /**
3504
3646
  * Triggers an update for an instance.
3505
- * Calls onUpdate callback and invalidates the frame if necessary.
3647
+ * Invalidates the frame if the root is in demand mode.
3506
3648
  *
3507
3649
  * @param instance - Instance to invalidate
3508
3650
  */
@@ -3668,29 +3810,44 @@ declare const hasConstructor: (object: unknown) => object is {
3668
3810
  * Used to identify values that should be resolved from refs after mount.
3669
3811
  */
3670
3812
  declare const FROM_REF: unique symbol;
3813
+ /** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
3814
+ interface FromRefMarker<T = unknown, R = T> {
3815
+ [FROM_REF]: React$1.RefObject<T | null>;
3816
+ /** Optional transform applied to the resolved ref before assignment. */
3817
+ transform?: (value: T) => R;
3818
+ }
3671
3819
  /**
3672
3820
  * Defers prop application until the referenced object is available.
3673
3821
  * Useful for props like `target` that need sibling refs to be populated.
3674
3822
  *
3823
+ * Only top-level props on a three element are resolved: a marker nested inside another value
3824
+ * (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
3825
+ * than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
3826
+ * what gets assigned.
3827
+ *
3675
3828
  * @param ref - React ref object to resolve at mount time
3676
- * @returns A marker value that applyProps will resolve after mount
3829
+ * @param transform - Optional mapping from the resolved object to the value the prop expects
3830
+ * @returns A marker value that the reconciler resolves after mount
3677
3831
  *
3678
3832
  * @example
3679
3833
  * const targetRef = useRef<THREE.Object3D>(null)
3680
3834
  *
3681
3835
  * <group ref={targetRef} position={[-3, -2, -15]} />
3682
3836
  * <spotLight target={fromRef(targetRef)} intensity={100} />
3837
+ *
3838
+ * @example
3839
+ * // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
3840
+ * <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
3683
3841
  */
3684
3842
  declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
3843
+ declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
3685
3844
  /**
3686
3845
  * Type guard to check if a value is a fromRef marker.
3687
3846
  *
3688
3847
  * @param value - Value to check
3689
3848
  * @returns True if value is a fromRef marker
3690
3849
  */
3691
- declare function isFromRef(value: unknown): value is {
3692
- [FROM_REF]: React$1.RefObject<any>;
3693
- };
3850
+ declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
3694
3851
 
3695
3852
  /**
3696
3853
  * Symbol marker for mount-only method calls.
@@ -3717,7 +3874,15 @@ declare const ONCE: unique symbol;
3717
3874
  * // No arguments
3718
3875
  * <geometry center={once()} />
3719
3876
  */
3720
- declare function once<T>(...args: T[]): T;
3877
+ declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
3878
+ /**
3879
+ * What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
3880
+ * the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
3881
+ * methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
3882
+ *
3883
+ * The runtime value is always the marker object; only the declared type follows the prop.
3884
+ */
3885
+ type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
3721
3886
  /**
3722
3887
  * Type guard to check if a value is a once marker.
3723
3888
  *
@@ -3734,5 +3899,5 @@ declare function isOnce(value: unknown): value is {
3734
3899
  */
3735
3900
  declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
3736
3901
 
3737
- 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, act, 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, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
3738
- 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 };
3902
+ 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, registerRootExtension, removeInteractivity, resolve, setRenderOverride, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
3903
+ 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, 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, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootExtension, 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 };