@react-three/fiber 10.0.0-canary.4bc4a97 → 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/extension.cjs +278 -0
- package/dist/extension.d.cts +1675 -0
- package/dist/extension.d.mts +1675 -0
- package/dist/extension.d.ts +1647 -0
- package/dist/extension.mjs +258 -0
- package/dist/index.cjs +984 -899
- package/dist/index.d.cts +337 -156
- package/dist/index.d.mts +337 -156
- package/dist/index.d.ts +335 -182
- package/dist/index.mjs +985 -902
- package/dist/legacy.cjs +997 -913
- package/dist/legacy.d.cts +358 -209
- package/dist/legacy.d.mts +358 -209
- package/dist/legacy.d.ts +356 -233
- package/dist/legacy.mjs +998 -916
- package/dist/webgpu/index.cjs +899 -736
- package/dist/webgpu/index.d.cts +412 -262
- package/dist/webgpu/index.d.mts +412 -262
- package/dist/webgpu/index.d.ts +410 -288
- package/dist/webgpu/index.mjs +900 -739
- package/package.json +7 -2
package/dist/index.d.mts
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,
|
|
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';
|
|
@@ -47,6 +48,9 @@ function _mergeNamespaces(n, m) {
|
|
|
47
48
|
declare const R3F_BUILD_LEGACY = true;
|
|
48
49
|
declare const R3F_BUILD_WEBGPU = true;
|
|
49
50
|
|
|
51
|
+
/** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
|
|
52
|
+
declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
|
|
53
|
+
|
|
50
54
|
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
51
55
|
__proto__: null,
|
|
52
56
|
CubeRenderTarget: CubeRenderTarget,
|
|
@@ -58,7 +62,8 @@ var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
|
58
62
|
WebGLCubeRenderTarget: WebGLCubeRenderTarget,
|
|
59
63
|
WebGLRenderTarget: WebGLRenderTarget,
|
|
60
64
|
WebGLRenderer: WebGLRenderer,
|
|
61
|
-
WebGLRendererParameters: WebGLRendererParameters
|
|
65
|
+
WebGLRendererParameters: WebGLRendererParameters,
|
|
66
|
+
loadInspector: loadInspector
|
|
62
67
|
}, [three_webgpu]);
|
|
63
68
|
|
|
64
69
|
//* Utility Types ==============================
|
|
@@ -347,6 +352,7 @@ type BufferLike =
|
|
|
347
352
|
| Uint16Array
|
|
348
353
|
| Int16Array
|
|
349
354
|
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
355
|
+
| THREE$1.InterleavedBufferAttribute
|
|
350
356
|
| Node // TSL buffer nodes (instancedArray, storage)
|
|
351
357
|
|
|
352
358
|
/** Flat record of buffer-like values (no nested scopes) */
|
|
@@ -358,6 +364,25 @@ type BufferRecord = Record<string, BufferLike>
|
|
|
358
364
|
*/
|
|
359
365
|
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
360
366
|
|
|
367
|
+
//* Node Types (useNodes) ========================================
|
|
368
|
+
|
|
369
|
+
/**
|
|
370
|
+
* Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
|
|
371
|
+
* the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
|
|
372
|
+
* code passes through. Creators are constrained to this same type, so the shape a creator returns
|
|
373
|
+
* and the shape the store holds are one type by construction.
|
|
374
|
+
*/
|
|
375
|
+
type NodeLike = TSLNodeType | LegacyTSLNodeLike
|
|
376
|
+
|
|
377
|
+
/** Flat record of TSL nodes (no nested scopes) */
|
|
378
|
+
type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* Node store that can contain both root-level nodes and scoped node objects.
|
|
382
|
+
* Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
|
|
383
|
+
*/
|
|
384
|
+
type NodeStore = Record<string, NodeLike | NodeRecord>
|
|
385
|
+
|
|
361
386
|
//* Storage Types (useGPUStorage) ========================================
|
|
362
387
|
|
|
363
388
|
/**
|
|
@@ -372,7 +397,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
|
372
397
|
* ```
|
|
373
398
|
*/
|
|
374
399
|
type StorageLike =
|
|
375
|
-
| StorageTexture // GPU storage texture
|
|
400
|
+
| StorageTexture // 2D GPU storage texture
|
|
401
|
+
| Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
|
|
402
|
+
| StorageArrayTexture // 2D-array GPU storage texture
|
|
376
403
|
| Data3DTexture // 3D texture (can be used as storage)
|
|
377
404
|
| Node // TSL storage texture nodes (storageTexture)
|
|
378
405
|
|
|
@@ -484,6 +511,12 @@ interface InternalState {
|
|
|
484
511
|
actualRenderer: R3FRenderer
|
|
485
512
|
/** Global scheduler reference (for useFrame hook) */
|
|
486
513
|
scheduler: SchedulerApi | null
|
|
514
|
+
/**
|
|
515
|
+
* Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
|
|
516
|
+
* `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
|
|
517
|
+
* render-phase takeover. Used by `useRenderPipeline`.
|
|
518
|
+
*/
|
|
519
|
+
renderOverride?: (() => void) | null
|
|
487
520
|
/** This root's unique ID in the global scheduler */
|
|
488
521
|
rootId?: string
|
|
489
522
|
/** Function to unregister this root from the global scheduler */
|
|
@@ -491,11 +524,28 @@ interface InternalState {
|
|
|
491
524
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
492
525
|
container?: THREE$1.Object3D
|
|
493
526
|
/**
|
|
494
|
-
* CanvasTarget
|
|
495
|
-
*
|
|
527
|
+
* The CanvasTarget this root sizes and renders through.
|
|
528
|
+
*
|
|
529
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
530
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
531
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
532
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
533
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
496
534
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
497
535
|
*/
|
|
498
536
|
canvasTarget?: CanvasTarget
|
|
537
|
+
/**
|
|
538
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
539
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
540
|
+
*
|
|
541
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
542
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
543
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
544
|
+
* invalidate some other canvas's descriptor instead.
|
|
545
|
+
*
|
|
546
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
547
|
+
*/
|
|
548
|
+
canvasTargetSizeDirty?: boolean
|
|
499
549
|
/**
|
|
500
550
|
* Whether multi-canvas rendering is active.
|
|
501
551
|
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
@@ -605,7 +655,7 @@ interface RootState {
|
|
|
605
655
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
606
656
|
uniforms: UniformStore
|
|
607
657
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
608
|
-
nodes:
|
|
658
|
+
nodes: NodeStore
|
|
609
659
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
610
660
|
buffers: BufferStore
|
|
611
661
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -617,7 +667,7 @@ interface RootState {
|
|
|
617
667
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
618
668
|
renderPipeline: ThreeRenderPipeline | null
|
|
619
669
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
620
|
-
passes:
|
|
670
|
+
passes: PassRecord
|
|
621
671
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
622
672
|
_hmrVersion: number
|
|
623
673
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -705,12 +755,19 @@ type DefaultRendererProps = {
|
|
|
705
755
|
*/
|
|
706
756
|
interface CanvasSchedulerConfig {
|
|
707
757
|
/**
|
|
708
|
-
*
|
|
709
|
-
|
|
758
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
759
|
+
*/
|
|
760
|
+
before?: string | string[]
|
|
761
|
+
/**
|
|
762
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
710
763
|
*/
|
|
711
|
-
after?: string
|
|
764
|
+
after?: string | string[]
|
|
712
765
|
/**
|
|
713
|
-
*
|
|
766
|
+
* Numeric root order. Lower values run first.
|
|
767
|
+
*/
|
|
768
|
+
order?: number
|
|
769
|
+
/**
|
|
770
|
+
* Limit this Canvas's default render job (frames per second).
|
|
714
771
|
*/
|
|
715
772
|
fps?: number
|
|
716
773
|
}
|
|
@@ -797,14 +854,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
797
854
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
798
855
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
799
856
|
dpr?: Dpr
|
|
800
|
-
/**
|
|
801
|
-
|
|
857
|
+
/**
|
|
858
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
859
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
860
|
+
*/
|
|
861
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
802
862
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
803
863
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
804
864
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
805
865
|
camera?: CameraProps
|
|
806
866
|
/** An R3F event manager to manage elements' pointer events */
|
|
807
|
-
events?: (store: RootStore) => EventManager<
|
|
867
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
808
868
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
809
869
|
onCreated?: (state: RootState) => void
|
|
810
870
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -893,7 +953,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
|
|
|
893
953
|
object?: T
|
|
894
954
|
dispose?: null
|
|
895
955
|
attach?: AttachType<T>
|
|
896
|
-
onUpdate?: (self: T) => void
|
|
897
956
|
}
|
|
898
957
|
|
|
899
958
|
interface Instance<O = any> {
|
|
@@ -1033,7 +1092,7 @@ interface CanvasProps
|
|
|
1033
1092
|
*/
|
|
1034
1093
|
resize?: Options
|
|
1035
1094
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1036
|
-
eventSource?:
|
|
1095
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1037
1096
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1038
1097
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1039
1098
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1141,81 +1200,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1141
1200
|
|
|
1142
1201
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1143
1202
|
|
|
1144
|
-
//* Global Types ==============================
|
|
1203
|
+
//* Global TSL Types ==============================
|
|
1145
1204
|
|
|
1146
1205
|
declare global {
|
|
1147
1206
|
/**
|
|
1148
|
-
*
|
|
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.
|
|
1207
|
+
* Broad callable-node fallback for dynamic store readers.
|
|
1208
|
+
* Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
|
|
1160
1209
|
*/
|
|
1161
|
-
type
|
|
1210
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1211
|
+
readonly shaderNode: unknown
|
|
1212
|
+
readonly id: number
|
|
1213
|
+
}
|
|
1162
1214
|
|
|
1163
|
-
/**
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
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
|
|
1215
|
+
/** Legacy structural node accepted when at least one historical marker exists. */
|
|
1216
|
+
type LegacyTSLNodeLike = {
|
|
1217
|
+
label?: ((label: string) => unknown) | string
|
|
1218
|
+
setName?: (name: string) => unknown
|
|
1219
|
+
} & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
|
|
1183
1220
|
|
|
1184
|
-
/**
|
|
1185
|
-
|
|
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>
|
|
1221
|
+
/** Node type accepted by broad dynamic node-store readers. */
|
|
1222
|
+
type TSLNodeType = three_webgpu.Node | CallableTSLNode
|
|
1194
1223
|
|
|
1195
1224
|
/**
|
|
1196
|
-
*
|
|
1197
|
-
*
|
|
1198
|
-
*
|
|
1199
|
-
*
|
|
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
|
-
* ```
|
|
1225
|
+
* Derive Three's shader node type from an existing node or a supported raw input.
|
|
1226
|
+
* Existing InputNode generics take precedence over structural value normalization.
|
|
1227
|
+
* Both generics must be inferred because Three's UniformNode intersects an unknown-typed
|
|
1228
|
+
* InputNode base with its concrete InputNode specialization.
|
|
1217
1229
|
*/
|
|
1218
|
-
type
|
|
1230
|
+
type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
|
|
1231
|
+
? TNodeType
|
|
1232
|
+
: T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
|
|
1233
|
+
? TNodeType
|
|
1234
|
+
: T extends number
|
|
1235
|
+
? 'float'
|
|
1236
|
+
: T extends boolean
|
|
1237
|
+
? 'bool'
|
|
1238
|
+
: T extends string | three_webgpu.Color | { r: number; g: number; b: number }
|
|
1239
|
+
? 'color'
|
|
1240
|
+
: T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
|
|
1241
|
+
? 'vec4'
|
|
1242
|
+
: T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
|
|
1243
|
+
? 'vec3'
|
|
1244
|
+
: T extends three_webgpu.Vector2 | { x: number; y: number }
|
|
1245
|
+
? 'vec2'
|
|
1246
|
+
: T extends three_webgpu.Matrix4
|
|
1247
|
+
? 'mat4'
|
|
1248
|
+
: T extends three_webgpu.Matrix3
|
|
1249
|
+
? 'mat3'
|
|
1250
|
+
: T extends three_webgpu.Matrix2
|
|
1251
|
+
? 'mat2'
|
|
1252
|
+
: unknown
|
|
1253
|
+
|
|
1254
|
+
/** Derive the normalized JavaScript value stored by a uniform node. */
|
|
1255
|
+
type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
|
|
1256
|
+
? TValue
|
|
1257
|
+
: T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
|
|
1258
|
+
? TValue
|
|
1259
|
+
: T extends string | { r: number; g: number; b: number }
|
|
1260
|
+
? three_webgpu.Color
|
|
1261
|
+
: T extends { x: number; y: number; z: number; w: number }
|
|
1262
|
+
? three_webgpu.Vector4
|
|
1263
|
+
: T extends { x: number; y: number; z: number }
|
|
1264
|
+
? three_webgpu.Vector3
|
|
1265
|
+
: T extends { x: number; y: number }
|
|
1266
|
+
? three_webgpu.Vector2
|
|
1267
|
+
: T extends number
|
|
1268
|
+
? number
|
|
1269
|
+
: T extends boolean
|
|
1270
|
+
? boolean
|
|
1271
|
+
: T
|
|
1272
|
+
|
|
1273
|
+
/** Three's exact UniformNode with shader and value generics derived from an input. */
|
|
1274
|
+
type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
|
|
1275
|
+
|
|
1276
|
+
/** Preserve every input key while mapping values to exact Three uniform nodes. */
|
|
1277
|
+
type UniformNodesFor<T extends UniformInputRecord> = {
|
|
1278
|
+
[K in keyof T]: UniformNodeFor<T[K]>
|
|
1279
|
+
}
|
|
1280
|
+
|
|
1281
|
+
/** Backward-compatible single-parameter uniform alias. */
|
|
1282
|
+
type UniformNode<T = unknown> = UniformNodeFor<T>
|
|
1219
1283
|
|
|
1220
1284
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1221
1285
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1240,7 +1304,7 @@ declare global {
|
|
|
1240
1304
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1241
1305
|
* Supports:
|
|
1242
1306
|
* - Primitives: number, string (color), boolean
|
|
1243
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1307
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1244
1308
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1245
1309
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1246
1310
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1253,88 +1317,124 @@ declare global {
|
|
|
1253
1317
|
| three_webgpu.Vector2
|
|
1254
1318
|
| three_webgpu.Vector3
|
|
1255
1319
|
| three_webgpu.Vector4
|
|
1320
|
+
| three_webgpu.Matrix2
|
|
1256
1321
|
| three_webgpu.Matrix3
|
|
1257
1322
|
| three_webgpu.Matrix4
|
|
1258
|
-
|
|
|
1259
|
-
|
|
|
1260
|
-
| { x: number; y
|
|
1323
|
+
| { x: number; y: number }
|
|
1324
|
+
| { x: number; y: number; z: number }
|
|
1325
|
+
| { x: number; y: number; z: number; w: number }
|
|
1261
1326
|
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1262
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1327
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1263
1328
|
| UniformNode
|
|
1264
1329
|
|
|
1265
1330
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1266
1331
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1267
1332
|
}
|
|
1268
1333
|
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
declare module 'three/tsl' {
|
|
1334
|
+
declare global {
|
|
1272
1335
|
/**
|
|
1273
|
-
*
|
|
1274
|
-
*
|
|
1336
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1337
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1338
|
+
* is r185, so the new name is the only one.
|
|
1275
1339
|
*/
|
|
1276
|
-
|
|
1277
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1278
|
-
): ShaderCallable<R>
|
|
1340
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1279
1341
|
|
|
1280
1342
|
/**
|
|
1281
|
-
*
|
|
1282
|
-
*
|
|
1343
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1344
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1345
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1283
1346
|
*/
|
|
1284
|
-
|
|
1285
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1286
|
-
): ShaderCallable<R>
|
|
1347
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1287
1348
|
|
|
1288
1349
|
/**
|
|
1289
|
-
*
|
|
1290
|
-
*
|
|
1350
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1351
|
+
*
|
|
1352
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1353
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1354
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1355
|
+
* {@link RenderPipelineCallbackState}.
|
|
1356
|
+
*
|
|
1357
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1358
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1359
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1360
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1361
|
+
*
|
|
1362
|
+
* The index signature admits `undefined` because a key may simply not be registered, and
|
|
1363
|
+
* because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
|
|
1364
|
+
* optional property whose type excludes `undefined` from the index signature is an error
|
|
1365
|
+
* (TS2411) for every consumer compiling these declarations.
|
|
1291
1366
|
*/
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1367
|
+
interface PassRecord {
|
|
1368
|
+
scenePass?: ScenePassNode
|
|
1369
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1370
|
+
}
|
|
1296
1371
|
|
|
1297
1372
|
/**
|
|
1298
|
-
*
|
|
1373
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1374
|
+
*
|
|
1375
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1376
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1377
|
+
*
|
|
1378
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1379
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1299
1380
|
*/
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1381
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1382
|
+
renderPipeline: ThreeRenderPipeline
|
|
1383
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1384
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1385
|
+
isLegacy: false
|
|
1386
|
+
}
|
|
1305
1387
|
|
|
1306
|
-
declare global {
|
|
1307
1388
|
/**
|
|
1308
|
-
*
|
|
1309
|
-
*
|
|
1310
|
-
* is
|
|
1389
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1390
|
+
*
|
|
1391
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1392
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1393
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1394
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1311
1395
|
*/
|
|
1312
|
-
type
|
|
1313
|
-
|
|
1314
|
-
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1315
|
-
type PassRecord = Record<string, any>
|
|
1396
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1316
1397
|
|
|
1317
1398
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1318
|
-
type RenderPipelineSetupCallback = (state:
|
|
1399
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1319
1400
|
|
|
1320
1401
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1321
|
-
type RenderPipelineMainCallback = (state:
|
|
1402
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1322
1403
|
|
|
1323
|
-
/**
|
|
1324
|
-
interface
|
|
1404
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1405
|
+
interface UseRenderPipelineActions {
|
|
1325
1406
|
/** Current passes from state */
|
|
1326
1407
|
passes: PassRecord
|
|
1327
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1328
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1329
1408
|
/** Clear all passes from state */
|
|
1330
1409
|
clearPasses: () => void
|
|
1331
1410
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1332
1411
|
reset: () => void
|
|
1333
1412
|
/** Re-run setup/main callbacks with current closure values */
|
|
1334
1413
|
rebuild: () => void
|
|
1335
|
-
/** True when RenderPipeline is configured and ready */
|
|
1336
|
-
isReady: boolean
|
|
1337
1414
|
}
|
|
1415
|
+
|
|
1416
|
+
/**
|
|
1417
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1418
|
+
*
|
|
1419
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1420
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1421
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1422
|
+
*/
|
|
1423
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1424
|
+
(
|
|
1425
|
+
| {
|
|
1426
|
+
/** True when RenderPipeline is configured and ready */
|
|
1427
|
+
isReady: true
|
|
1428
|
+
/** RenderPipeline instance */
|
|
1429
|
+
renderPipeline: ThreeRenderPipeline
|
|
1430
|
+
}
|
|
1431
|
+
| {
|
|
1432
|
+
/** False until the pipeline has been created */
|
|
1433
|
+
isReady: false
|
|
1434
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1435
|
+
renderPipeline: null
|
|
1436
|
+
}
|
|
1437
|
+
)
|
|
1338
1438
|
}
|
|
1339
1439
|
|
|
1340
1440
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -1413,10 +1513,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1413
1513
|
|
|
1414
1514
|
/**
|
|
1415
1515
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1416
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1516
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1517
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1417
1518
|
*/
|
|
1418
1519
|
type NodeProps<P> = {
|
|
1419
|
-
[K in keyof P as P[K] extends
|
|
1520
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1420
1521
|
}
|
|
1421
1522
|
|
|
1422
1523
|
interface ReactProps<P> {
|
|
@@ -1437,11 +1538,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1437
1538
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1438
1539
|
}
|
|
1439
1540
|
|
|
1541
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1542
|
+
type Object3DMethod = NonNullable<
|
|
1543
|
+
{
|
|
1544
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1545
|
+
}[keyof Object3D]
|
|
1546
|
+
>
|
|
1547
|
+
|
|
1440
1548
|
type ThreeExports = typeof THREE
|
|
1441
1549
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1442
1550
|
|
|
1443
1551
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1444
|
-
|
|
1552
|
+
/**
|
|
1553
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1554
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1555
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1556
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1557
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1558
|
+
*/
|
|
1559
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
|
|
1560
|
+
object: object
|
|
1561
|
+
ref?: React.Ref<any>
|
|
1562
|
+
[prop: string]: unknown
|
|
1563
|
+
}
|
|
1445
1564
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1446
1565
|
threeAudio: ThreeElementsImpl['audio']
|
|
1447
1566
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1482,6 +1601,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1482
1601
|
type three_d_Matrix4 = Matrix4;
|
|
1483
1602
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1484
1603
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1604
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1485
1605
|
type three_d_Quaternion = Quaternion;
|
|
1486
1606
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1487
1607
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1496,7 +1616,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1496
1616
|
type three_d_Vector4 = Vector4;
|
|
1497
1617
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1498
1618
|
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 };
|
|
1619
|
+
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
1620
|
}
|
|
1501
1621
|
|
|
1502
1622
|
/**
|
|
@@ -1845,7 +1965,48 @@ declare function createEvents(store: RootStore): {
|
|
|
1845
1965
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1846
1966
|
};
|
|
1847
1967
|
/** Default R3F event manager for web */
|
|
1848
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1968
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1969
|
+
|
|
1970
|
+
interface RootExtension {
|
|
1971
|
+
/** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
|
|
1972
|
+
* set up are not set up a second time, but get the new entry's dispose and hmr. */
|
|
1973
|
+
name: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* Called once per root, after its renderer exists and before `onCreated` and the first frame.
|
|
1976
|
+
* `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
|
|
1977
|
+
* to the primary canvas. Return fields to merge into the root's state, or nothing.
|
|
1978
|
+
*/
|
|
1979
|
+
setup?(store: RootStore): Partial<RootState> | void;
|
|
1980
|
+
/** Called when a root this extension set up unmounts. */
|
|
1981
|
+
dispose?(store: RootStore): void;
|
|
1982
|
+
/** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
|
|
1983
|
+
hmr?(store: RootStore): void;
|
|
1984
|
+
}
|
|
1985
|
+
/**
|
|
1986
|
+
* Register an extension. It is set up on every live root immediately, and on every root created
|
|
1987
|
+
* afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
|
|
1988
|
+
* it already set up keep its state and still get its dispose when they unmount.
|
|
1989
|
+
*/
|
|
1990
|
+
declare function registerRootExtension(extension: RootExtension): () => void;
|
|
1991
|
+
/**
|
|
1992
|
+
* Point a root's default render job at a different render function, or back at
|
|
1993
|
+
* `renderer.render(scene, camera)` with `null`.
|
|
1994
|
+
*
|
|
1995
|
+
* The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
|
|
1996
|
+
* boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
|
|
1997
|
+
*/
|
|
1998
|
+
declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
|
|
1999
|
+
|
|
2000
|
+
/**
|
|
2001
|
+
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
2002
|
+
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2003
|
+
*/
|
|
2004
|
+
declare function useStore(): RootStore;
|
|
2005
|
+
/**
|
|
2006
|
+
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
2007
|
+
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
2008
|
+
*/
|
|
2009
|
+
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
1849
2010
|
|
|
1850
2011
|
/**
|
|
1851
2012
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -1878,7 +2039,7 @@ declare namespace useLoader {
|
|
|
1878
2039
|
*
|
|
1879
2040
|
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
1880
2041
|
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
1881
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
2042
|
+
* @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
|
|
1882
2043
|
*
|
|
1883
2044
|
* @example
|
|
1884
2045
|
* // Simple priority (backwards compat)
|
|
@@ -2089,16 +2250,6 @@ declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
|
|
|
2089
2250
|
declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
|
|
2090
2251
|
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
|
|
2091
2252
|
|
|
2092
|
-
/**
|
|
2093
|
-
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
2094
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2095
|
-
*/
|
|
2096
|
-
declare function useStore(): RootStore;
|
|
2097
|
-
/**
|
|
2098
|
-
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
2099
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
2100
|
-
*/
|
|
2101
|
-
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
2102
2253
|
/**
|
|
2103
2254
|
* Exposes an object's {@link Instance}.
|
|
2104
2255
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2174,7 +2325,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2174
2325
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2175
2326
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2176
2327
|
*
|
|
2177
|
-
*
|
|
2328
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
2329
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
2330
|
+
*
|
|
2331
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2178
2332
|
* @param frames - Number of frames to request (default: 1)
|
|
2179
2333
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2180
2334
|
*
|
|
@@ -2185,14 +2339,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2185
2339
|
* Advances the frameloop and runs render effects.
|
|
2186
2340
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2187
2341
|
*
|
|
2342
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2343
|
+
* registered root is stepped for backwards compatibility.
|
|
2344
|
+
*
|
|
2188
2345
|
* @param timestamp - The timestamp to use for this frame
|
|
2189
2346
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2190
|
-
* @param state -
|
|
2191
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2347
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2192
2348
|
*
|
|
2193
2349
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2194
2350
|
*/
|
|
2195
|
-
declare function advance(timestamp: number): void;
|
|
2351
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2196
2352
|
|
|
2197
2353
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2198
2354
|
declare function ReactReconciler<
|
|
@@ -3237,6 +3393,7 @@ declare namespace ReactReconciler {
|
|
|
3237
3393
|
|
|
3238
3394
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3239
3395
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3396
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3240
3397
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3241
3398
|
|
|
3242
3399
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3261,6 +3418,7 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
|
|
|
3261
3418
|
declare function flushSync<R>(fn: () => R): R;
|
|
3262
3419
|
|
|
3263
3420
|
declare const context: React$1.Context<RootStore>;
|
|
3421
|
+
|
|
3264
3422
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3265
3423
|
|
|
3266
3424
|
/**
|
|
@@ -3514,7 +3672,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
|
|
|
3514
3672
|
declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
|
|
3515
3673
|
/**
|
|
3516
3674
|
* Triggers an update for an instance.
|
|
3517
|
-
*
|
|
3675
|
+
* Invalidates the frame if the root is in demand mode.
|
|
3518
3676
|
*
|
|
3519
3677
|
* @param instance - Instance to invalidate
|
|
3520
3678
|
*/
|
|
@@ -3680,29 +3838,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3680
3838
|
* Used to identify values that should be resolved from refs after mount.
|
|
3681
3839
|
*/
|
|
3682
3840
|
declare const FROM_REF: unique symbol;
|
|
3841
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3842
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3843
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3844
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3845
|
+
transform?: (value: T) => R;
|
|
3846
|
+
}
|
|
3683
3847
|
/**
|
|
3684
3848
|
* Defers prop application until the referenced object is available.
|
|
3685
3849
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3686
3850
|
*
|
|
3851
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3852
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3853
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3854
|
+
* what gets assigned.
|
|
3855
|
+
*
|
|
3687
3856
|
* @param ref - React ref object to resolve at mount time
|
|
3688
|
-
* @
|
|
3857
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3858
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
3689
3859
|
*
|
|
3690
3860
|
* @example
|
|
3691
3861
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3692
3862
|
*
|
|
3693
3863
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3694
3864
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3865
|
+
*
|
|
3866
|
+
* @example
|
|
3867
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3868
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
3695
3869
|
*/
|
|
3696
3870
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3871
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
3697
3872
|
/**
|
|
3698
3873
|
* Type guard to check if a value is a fromRef marker.
|
|
3699
3874
|
*
|
|
3700
3875
|
* @param value - Value to check
|
|
3701
3876
|
* @returns True if value is a fromRef marker
|
|
3702
3877
|
*/
|
|
3703
|
-
declare function isFromRef(value: unknown): value is
|
|
3704
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3705
|
-
};
|
|
3878
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3706
3879
|
|
|
3707
3880
|
/**
|
|
3708
3881
|
* Symbol marker for mount-only method calls.
|
|
@@ -3729,7 +3902,15 @@ declare const ONCE: unique symbol;
|
|
|
3729
3902
|
* // No arguments
|
|
3730
3903
|
* <geometry center={once()} />
|
|
3731
3904
|
*/
|
|
3732
|
-
declare function once<
|
|
3905
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3906
|
+
/**
|
|
3907
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3908
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3909
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3910
|
+
*
|
|
3911
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3912
|
+
*/
|
|
3913
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
3733
3914
|
/**
|
|
3734
3915
|
* Type guard to check if a value is a once marker.
|
|
3735
3916
|
*
|
|
@@ -3746,5 +3927,5 @@ declare function isOnce(value: unknown): value is {
|
|
|
3746
3927
|
*/
|
|
3747
3928
|
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3748
3929
|
|
|
3749
|
-
export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
|
|
3750
|
-
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|
|
3930
|
+
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 };
|
|
3931
|
+
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 };
|