@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/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 +2771 -2550
- package/dist/index.d.cts +358 -165
- package/dist/index.d.mts +358 -165
- package/dist/index.d.ts +356 -191
- package/dist/index.mjs +2771 -2552
- package/dist/legacy.cjs +2558 -2338
- package/dist/legacy.d.cts +379 -218
- package/dist/legacy.d.mts +379 -218
- package/dist/legacy.d.ts +377 -242
- package/dist/legacy.mjs +2208 -1990
- package/dist/webgpu/index.cjs +3113 -2814
- package/dist/webgpu/index.d.cts +433 -271
- package/dist/webgpu/index.d.mts +433 -271
- package/dist/webgpu/index.d.ts +431 -297
- package/dist/webgpu/index.mjs +2587 -2290
- package/package.json +9 -4
- package/readme.md +1 -1
- package/react-reconciler/constants.d.ts +0 -7
- package/react-reconciler/constants.js +0 -1
- package/react-reconciler/index.d.ts +0 -1044
- package/react-reconciler/index.js +0 -208
package/dist/webgpu/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,
|
|
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, Matrix2, WebGPURendererParameters } from 'three/webgpu';
|
|
3
4
|
import { Inspector } from 'three/addons/inspector/Inspector.js';
|
|
4
5
|
import * as THREE$1 from 'three';
|
|
5
6
|
import { Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
|
|
@@ -11,23 +12,8 @@ import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFr
|
|
|
11
12
|
export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
|
|
12
13
|
import { Options } from 'react-use-measure';
|
|
13
14
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
14
|
-
import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
|
|
15
15
|
import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
|
|
16
16
|
|
|
17
|
-
function _mergeNamespaces(n, m) {
|
|
18
|
-
m.forEach(function (e) {
|
|
19
|
-
e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
|
|
20
|
-
if (k !== 'default' && !(k in n)) {
|
|
21
|
-
var d = Object.getOwnPropertyDescriptor(e, k);
|
|
22
|
-
Object.defineProperty(n, k, d.get ? d : {
|
|
23
|
-
enumerable: true,
|
|
24
|
-
get: function () { return e[k]; }
|
|
25
|
-
});
|
|
26
|
-
}
|
|
27
|
-
});
|
|
28
|
-
});
|
|
29
|
-
return Object.freeze(n);
|
|
30
|
-
}
|
|
31
17
|
|
|
32
18
|
/**
|
|
33
19
|
* @fileoverview Internal Three.js re-exports - WEBGPU ONLY ENTRY
|
|
@@ -41,6 +27,8 @@ function _mergeNamespaces(n, m) {
|
|
|
41
27
|
declare const R3F_BUILD_LEGACY = false;
|
|
42
28
|
declare const R3F_BUILD_WEBGPU = true;
|
|
43
29
|
|
|
30
|
+
/** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
|
|
31
|
+
declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
|
|
44
32
|
declare const WebGLRenderer: {
|
|
45
33
|
new (): {};
|
|
46
34
|
};
|
|
@@ -51,19 +39,6 @@ declare const WebGLRenderTarget: any;
|
|
|
51
39
|
|
|
52
40
|
declare const WebGLCubeRenderTarget: any;
|
|
53
41
|
|
|
54
|
-
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
55
|
-
__proto__: null,
|
|
56
|
-
CubeRenderTargetCompat: CubeRenderTarget,
|
|
57
|
-
Inspector: Inspector,
|
|
58
|
-
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
59
|
-
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
60
|
-
RenderTargetCompat: RenderTarget,
|
|
61
|
-
WebGLCubeRenderTarget: WebGLCubeRenderTarget,
|
|
62
|
-
WebGLRenderTarget: WebGLRenderTarget,
|
|
63
|
-
WebGLRenderer: WebGLRenderer,
|
|
64
|
-
WebGLRendererParameters: WebGLRendererParameters,
|
|
65
|
-
WebGLShadowMap: WebGLShadowMap
|
|
66
|
-
}, [three_webgpu]);
|
|
67
42
|
|
|
68
43
|
//* Utility Types ==============================
|
|
69
44
|
|
|
@@ -351,6 +326,7 @@ type BufferLike =
|
|
|
351
326
|
| Uint16Array
|
|
352
327
|
| Int16Array
|
|
353
328
|
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
329
|
+
| THREE$1.InterleavedBufferAttribute
|
|
354
330
|
| Node // TSL buffer nodes (instancedArray, storage)
|
|
355
331
|
|
|
356
332
|
/** Flat record of buffer-like values (no nested scopes) */
|
|
@@ -362,6 +338,25 @@ type BufferRecord = Record<string, BufferLike>
|
|
|
362
338
|
*/
|
|
363
339
|
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
364
340
|
|
|
341
|
+
//* Node Types (useNodes) ========================================
|
|
342
|
+
|
|
343
|
+
/**
|
|
344
|
+
* Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
|
|
345
|
+
* the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
|
|
346
|
+
* code passes through. Creators are constrained to this same type, so the shape a creator returns
|
|
347
|
+
* and the shape the store holds are one type by construction.
|
|
348
|
+
*/
|
|
349
|
+
type NodeLike = TSLNodeType | LegacyTSLNodeLike
|
|
350
|
+
|
|
351
|
+
/** Flat record of TSL nodes (no nested scopes) */
|
|
352
|
+
type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* Node store that can contain both root-level nodes and scoped node objects.
|
|
356
|
+
* Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
|
|
357
|
+
*/
|
|
358
|
+
type NodeStore = Record<string, NodeLike | NodeRecord>
|
|
359
|
+
|
|
365
360
|
//* Storage Types (useGPUStorage) ========================================
|
|
366
361
|
|
|
367
362
|
/**
|
|
@@ -376,7 +371,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
|
376
371
|
* ```
|
|
377
372
|
*/
|
|
378
373
|
type StorageLike =
|
|
379
|
-
| StorageTexture // GPU storage texture
|
|
374
|
+
| StorageTexture // 2D GPU storage texture
|
|
375
|
+
| Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
|
|
376
|
+
| StorageArrayTexture // 2D-array GPU storage texture
|
|
380
377
|
| Data3DTexture // 3D texture (can be used as storage)
|
|
381
378
|
| Node // TSL storage texture nodes (storageTexture)
|
|
382
379
|
|
|
@@ -488,6 +485,12 @@ interface InternalState {
|
|
|
488
485
|
actualRenderer: R3FRenderer
|
|
489
486
|
/** Global scheduler reference (for useFrame hook) */
|
|
490
487
|
scheduler: SchedulerApi | null
|
|
488
|
+
/**
|
|
489
|
+
* Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
|
|
490
|
+
* `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
|
|
491
|
+
* render-phase takeover. Used by `useRenderPipeline`.
|
|
492
|
+
*/
|
|
493
|
+
renderOverride?: (() => void) | null
|
|
491
494
|
/** This root's unique ID in the global scheduler */
|
|
492
495
|
rootId?: string
|
|
493
496
|
/** Function to unregister this root from the global scheduler */
|
|
@@ -495,11 +498,28 @@ interface InternalState {
|
|
|
495
498
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
496
499
|
container?: THREE$1.Object3D
|
|
497
500
|
/**
|
|
498
|
-
* CanvasTarget
|
|
499
|
-
*
|
|
501
|
+
* The CanvasTarget this root sizes and renders through.
|
|
502
|
+
*
|
|
503
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
504
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
505
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
506
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
507
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
500
508
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
501
509
|
*/
|
|
502
510
|
canvasTarget?: CanvasTarget
|
|
511
|
+
/**
|
|
512
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
513
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
514
|
+
*
|
|
515
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
516
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
517
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
518
|
+
* invalidate some other canvas's descriptor instead.
|
|
519
|
+
*
|
|
520
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
521
|
+
*/
|
|
522
|
+
canvasTargetSizeDirty?: boolean
|
|
503
523
|
/**
|
|
504
524
|
* Whether multi-canvas rendering is active.
|
|
505
525
|
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
@@ -609,7 +629,7 @@ interface RootState {
|
|
|
609
629
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
610
630
|
uniforms: UniformStore
|
|
611
631
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
612
|
-
nodes:
|
|
632
|
+
nodes: NodeStore
|
|
613
633
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
614
634
|
buffers: BufferStore
|
|
615
635
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -621,7 +641,7 @@ interface RootState {
|
|
|
621
641
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
622
642
|
renderPipeline: ThreeRenderPipeline | null
|
|
623
643
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
624
|
-
passes:
|
|
644
|
+
passes: PassRecord
|
|
625
645
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
626
646
|
_hmrVersion: number
|
|
627
647
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -709,12 +729,19 @@ type DefaultRendererProps = {
|
|
|
709
729
|
*/
|
|
710
730
|
interface CanvasSchedulerConfig {
|
|
711
731
|
/**
|
|
712
|
-
*
|
|
713
|
-
|
|
732
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
733
|
+
*/
|
|
734
|
+
before?: string | string[]
|
|
735
|
+
/**
|
|
736
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
714
737
|
*/
|
|
715
|
-
after?: string
|
|
738
|
+
after?: string | string[]
|
|
716
739
|
/**
|
|
717
|
-
*
|
|
740
|
+
* Numeric root order. Lower values run first.
|
|
741
|
+
*/
|
|
742
|
+
order?: number
|
|
743
|
+
/**
|
|
744
|
+
* Limit this Canvas's default render job (frames per second).
|
|
718
745
|
*/
|
|
719
746
|
fps?: number
|
|
720
747
|
}
|
|
@@ -801,14 +828,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
801
828
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
802
829
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
803
830
|
dpr?: Dpr
|
|
804
|
-
/**
|
|
805
|
-
|
|
831
|
+
/**
|
|
832
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
833
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
834
|
+
*/
|
|
835
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
806
836
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
807
837
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
808
838
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
809
839
|
camera?: CameraProps
|
|
810
840
|
/** An R3F event manager to manage elements' pointer events */
|
|
811
|
-
events?: (store: RootStore) => EventManager<
|
|
841
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
812
842
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
813
843
|
onCreated?: (state: RootState) => void
|
|
814
844
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -897,7 +927,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
|
|
|
897
927
|
object?: T
|
|
898
928
|
dispose?: null
|
|
899
929
|
attach?: AttachType<T>
|
|
900
|
-
onUpdate?: (self: T) => void
|
|
901
930
|
}
|
|
902
931
|
|
|
903
932
|
interface Instance<O = any> {
|
|
@@ -1037,7 +1066,7 @@ interface CanvasProps
|
|
|
1037
1066
|
*/
|
|
1038
1067
|
resize?: Options
|
|
1039
1068
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1040
|
-
eventSource?:
|
|
1069
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1041
1070
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1042
1071
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1043
1072
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1145,81 +1174,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1145
1174
|
|
|
1146
1175
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1147
1176
|
|
|
1148
|
-
//* Global Types ==============================
|
|
1177
|
+
//* Global TSL Types ==============================
|
|
1149
1178
|
|
|
1150
1179
|
declare global {
|
|
1151
1180
|
/**
|
|
1152
|
-
*
|
|
1153
|
-
*
|
|
1154
|
-
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1155
|
-
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1156
|
-
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1157
|
-
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1158
|
-
* arity when three made `UniformNode` two-parameter.
|
|
1159
|
-
*
|
|
1160
|
-
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1161
|
-
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1162
|
-
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1163
|
-
* installed three instead of needing to be mirrored by hand.
|
|
1181
|
+
* Broad callable-node fallback for dynamic store readers.
|
|
1182
|
+
* Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
|
|
1164
1183
|
*/
|
|
1165
|
-
type
|
|
1184
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1185
|
+
readonly shaderNode: unknown
|
|
1186
|
+
readonly id: number
|
|
1187
|
+
}
|
|
1166
1188
|
|
|
1167
|
-
/**
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
* @example
|
|
1173
|
-
* ```tsx
|
|
1174
|
-
* // Define a shader function
|
|
1175
|
-
* const blendColorFn = Fn(([color1, color2, factor]) => {
|
|
1176
|
-
* return mix(color1, color2, factor)
|
|
1177
|
-
* })
|
|
1178
|
-
*
|
|
1179
|
-
* // Type when retrieving from nodes store
|
|
1180
|
-
* const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
|
|
1181
|
-
*
|
|
1182
|
-
* // Or with specific return type
|
|
1183
|
-
* const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
|
|
1184
|
-
* ```
|
|
1185
|
-
*/
|
|
1186
|
-
type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
|
|
1189
|
+
/** Legacy structural node accepted when at least one historical marker exists. */
|
|
1190
|
+
type LegacyTSLNodeLike = {
|
|
1191
|
+
label?: ((label: string) => unknown) | string
|
|
1192
|
+
setName?: (name: string) => unknown
|
|
1193
|
+
} & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
|
|
1187
1194
|
|
|
1188
|
-
/**
|
|
1189
|
-
|
|
1190
|
-
* This is the common return type for TSL operations (add, mul, sin, etc.)
|
|
1191
|
-
*
|
|
1192
|
-
* @example
|
|
1193
|
-
* ```tsx
|
|
1194
|
-
* const { wobble } = nodes as { wobble: ShaderNodeRef }
|
|
1195
|
-
* ```
|
|
1196
|
-
*/
|
|
1197
|
-
type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
|
|
1195
|
+
/** Node type accepted by broad dynamic node-store readers. */
|
|
1196
|
+
type TSLNodeType = three_webgpu.Node | CallableTSLNode
|
|
1198
1197
|
|
|
1199
1198
|
/**
|
|
1200
|
-
*
|
|
1201
|
-
*
|
|
1202
|
-
*
|
|
1203
|
-
*
|
|
1204
|
-
* - Node: base Three.js node type
|
|
1205
|
-
* - ShaderCallable: function nodes created with Fn()
|
|
1206
|
-
* - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
|
|
1207
|
-
*
|
|
1208
|
-
* @example
|
|
1209
|
-
* ```tsx
|
|
1210
|
-
* // In useLocalNodes, nodes are typed as TSLNodeType
|
|
1211
|
-
* const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
|
|
1212
|
-
* positionNode: nodes.myPosition, // Works - Node is in union
|
|
1213
|
-
* blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
|
|
1214
|
-
* }))
|
|
1215
|
-
*
|
|
1216
|
-
* // Can narrow with type guard or assertion when needed
|
|
1217
|
-
* if (typeof blendColorFn === 'function') {
|
|
1218
|
-
* blendColorFn(someColor, 0.5)
|
|
1219
|
-
* }
|
|
1220
|
-
* ```
|
|
1199
|
+
* Derive Three's shader node type from an existing node or a supported raw input.
|
|
1200
|
+
* Existing InputNode generics take precedence over structural value normalization.
|
|
1201
|
+
* Both generics must be inferred because Three's UniformNode intersects an unknown-typed
|
|
1202
|
+
* InputNode base with its concrete InputNode specialization.
|
|
1221
1203
|
*/
|
|
1222
|
-
type
|
|
1204
|
+
type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
|
|
1205
|
+
? TNodeType
|
|
1206
|
+
: T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
|
|
1207
|
+
? TNodeType
|
|
1208
|
+
: T extends number
|
|
1209
|
+
? 'float'
|
|
1210
|
+
: T extends boolean
|
|
1211
|
+
? 'bool'
|
|
1212
|
+
: T extends string | three_webgpu.Color | { r: number; g: number; b: number }
|
|
1213
|
+
? 'color'
|
|
1214
|
+
: T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
|
|
1215
|
+
? 'vec4'
|
|
1216
|
+
: T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
|
|
1217
|
+
? 'vec3'
|
|
1218
|
+
: T extends three_webgpu.Vector2 | { x: number; y: number }
|
|
1219
|
+
? 'vec2'
|
|
1220
|
+
: T extends three_webgpu.Matrix4
|
|
1221
|
+
? 'mat4'
|
|
1222
|
+
: T extends three_webgpu.Matrix3
|
|
1223
|
+
? 'mat3'
|
|
1224
|
+
: T extends three_webgpu.Matrix2
|
|
1225
|
+
? 'mat2'
|
|
1226
|
+
: unknown
|
|
1227
|
+
|
|
1228
|
+
/** Derive the normalized JavaScript value stored by a uniform node. */
|
|
1229
|
+
type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
|
|
1230
|
+
? TValue
|
|
1231
|
+
: T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
|
|
1232
|
+
? TValue
|
|
1233
|
+
: T extends string | { r: number; g: number; b: number }
|
|
1234
|
+
? three_webgpu.Color
|
|
1235
|
+
: T extends { x: number; y: number; z: number; w: number }
|
|
1236
|
+
? three_webgpu.Vector4
|
|
1237
|
+
: T extends { x: number; y: number; z: number }
|
|
1238
|
+
? three_webgpu.Vector3
|
|
1239
|
+
: T extends { x: number; y: number }
|
|
1240
|
+
? three_webgpu.Vector2
|
|
1241
|
+
: T extends number
|
|
1242
|
+
? number
|
|
1243
|
+
: T extends boolean
|
|
1244
|
+
? boolean
|
|
1245
|
+
: T
|
|
1246
|
+
|
|
1247
|
+
/** Three's exact UniformNode with shader and value generics derived from an input. */
|
|
1248
|
+
type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
|
|
1249
|
+
|
|
1250
|
+
/** Preserve every input key while mapping values to exact Three uniform nodes. */
|
|
1251
|
+
type UniformNodesFor<T extends UniformInputRecord> = {
|
|
1252
|
+
[K in keyof T]: UniformNodeFor<T[K]>
|
|
1253
|
+
}
|
|
1254
|
+
|
|
1255
|
+
/** Backward-compatible single-parameter uniform alias. */
|
|
1256
|
+
type UniformNode<T = unknown> = UniformNodeFor<T>
|
|
1223
1257
|
|
|
1224
1258
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1225
1259
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1244,7 +1278,7 @@ declare global {
|
|
|
1244
1278
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1245
1279
|
* Supports:
|
|
1246
1280
|
* - Primitives: number, string (color), boolean
|
|
1247
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1281
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1248
1282
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1249
1283
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1250
1284
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1257,88 +1291,124 @@ declare global {
|
|
|
1257
1291
|
| three_webgpu.Vector2
|
|
1258
1292
|
| three_webgpu.Vector3
|
|
1259
1293
|
| three_webgpu.Vector4
|
|
1294
|
+
| three_webgpu.Matrix2
|
|
1260
1295
|
| three_webgpu.Matrix3
|
|
1261
1296
|
| three_webgpu.Matrix4
|
|
1262
|
-
|
|
|
1263
|
-
|
|
|
1264
|
-
| { x: number; y
|
|
1297
|
+
| { x: number; y: number }
|
|
1298
|
+
| { x: number; y: number; z: number }
|
|
1299
|
+
| { x: number; y: number; z: number; w: number }
|
|
1265
1300
|
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1266
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1301
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1267
1302
|
| UniformNode
|
|
1268
1303
|
|
|
1269
1304
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1270
1305
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1271
1306
|
}
|
|
1272
1307
|
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
declare module 'three/tsl' {
|
|
1308
|
+
declare global {
|
|
1276
1309
|
/**
|
|
1277
|
-
*
|
|
1278
|
-
*
|
|
1310
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1311
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1312
|
+
* is r185, so the new name is the only one.
|
|
1279
1313
|
*/
|
|
1280
|
-
|
|
1281
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1282
|
-
): ShaderCallable<R>
|
|
1314
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1283
1315
|
|
|
1284
1316
|
/**
|
|
1285
|
-
*
|
|
1286
|
-
*
|
|
1317
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1318
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1319
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1287
1320
|
*/
|
|
1288
|
-
|
|
1289
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1290
|
-
): ShaderCallable<R>
|
|
1321
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1291
1322
|
|
|
1292
1323
|
/**
|
|
1293
|
-
*
|
|
1294
|
-
*
|
|
1324
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1325
|
+
*
|
|
1326
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1327
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1328
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1329
|
+
* {@link RenderPipelineCallbackState}.
|
|
1330
|
+
*
|
|
1331
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1332
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1333
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1334
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1335
|
+
*
|
|
1336
|
+
* The index signature admits `undefined` because a key may simply not be registered, and
|
|
1337
|
+
* because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
|
|
1338
|
+
* optional property whose type excludes `undefined` from the index signature is an error
|
|
1339
|
+
* (TS2411) for every consumer compiling these declarations.
|
|
1295
1340
|
*/
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1341
|
+
interface PassRecord {
|
|
1342
|
+
scenePass?: ScenePassNode
|
|
1343
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1344
|
+
}
|
|
1300
1345
|
|
|
1301
1346
|
/**
|
|
1302
|
-
*
|
|
1347
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1348
|
+
*
|
|
1349
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1350
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1351
|
+
*
|
|
1352
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1353
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1303
1354
|
*/
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1355
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1356
|
+
renderPipeline: ThreeRenderPipeline
|
|
1357
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1358
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1359
|
+
isLegacy: false
|
|
1360
|
+
}
|
|
1309
1361
|
|
|
1310
|
-
declare global {
|
|
1311
1362
|
/**
|
|
1312
|
-
*
|
|
1313
|
-
*
|
|
1314
|
-
* is
|
|
1363
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1364
|
+
*
|
|
1365
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1366
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1367
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1368
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1315
1369
|
*/
|
|
1316
|
-
type
|
|
1317
|
-
|
|
1318
|
-
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1319
|
-
type PassRecord = Record<string, any>
|
|
1370
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1320
1371
|
|
|
1321
1372
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1322
|
-
type RenderPipelineSetupCallback = (state:
|
|
1373
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1323
1374
|
|
|
1324
1375
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1325
|
-
type RenderPipelineMainCallback = (state:
|
|
1376
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1326
1377
|
|
|
1327
|
-
/**
|
|
1328
|
-
interface
|
|
1378
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1379
|
+
interface UseRenderPipelineActions {
|
|
1329
1380
|
/** Current passes from state */
|
|
1330
1381
|
passes: PassRecord
|
|
1331
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1332
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1333
1382
|
/** Clear all passes from state */
|
|
1334
1383
|
clearPasses: () => void
|
|
1335
1384
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1336
1385
|
reset: () => void
|
|
1337
1386
|
/** Re-run setup/main callbacks with current closure values */
|
|
1338
1387
|
rebuild: () => void
|
|
1339
|
-
/** True when RenderPipeline is configured and ready */
|
|
1340
|
-
isReady: boolean
|
|
1341
1388
|
}
|
|
1389
|
+
|
|
1390
|
+
/**
|
|
1391
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1392
|
+
*
|
|
1393
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1394
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1395
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1396
|
+
*/
|
|
1397
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1398
|
+
(
|
|
1399
|
+
| {
|
|
1400
|
+
/** True when RenderPipeline is configured and ready */
|
|
1401
|
+
isReady: true
|
|
1402
|
+
/** RenderPipeline instance */
|
|
1403
|
+
renderPipeline: ThreeRenderPipeline
|
|
1404
|
+
}
|
|
1405
|
+
| {
|
|
1406
|
+
/** False until the pipeline has been created */
|
|
1407
|
+
isReady: false
|
|
1408
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1409
|
+
renderPipeline: null
|
|
1410
|
+
}
|
|
1411
|
+
)
|
|
1342
1412
|
}
|
|
1343
1413
|
|
|
1344
1414
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -1417,10 +1487,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1417
1487
|
|
|
1418
1488
|
/**
|
|
1419
1489
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1420
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1490
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1491
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1421
1492
|
*/
|
|
1422
1493
|
type NodeProps<P> = {
|
|
1423
|
-
[K in keyof P as P[K] extends
|
|
1494
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1424
1495
|
}
|
|
1425
1496
|
|
|
1426
1497
|
interface ReactProps<P> {
|
|
@@ -1441,11 +1512,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1441
1512
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1442
1513
|
}
|
|
1443
1514
|
|
|
1515
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1516
|
+
type Object3DMethod = NonNullable<
|
|
1517
|
+
{
|
|
1518
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1519
|
+
}[keyof Object3D]
|
|
1520
|
+
>
|
|
1521
|
+
|
|
1444
1522
|
type ThreeExports = typeof import('three/webgpu')
|
|
1445
1523
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1446
1524
|
|
|
1447
1525
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1448
|
-
|
|
1526
|
+
/**
|
|
1527
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1528
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1529
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1530
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1531
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1532
|
+
*/
|
|
1533
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
|
|
1534
|
+
object: object
|
|
1535
|
+
ref?: React.Ref<any>
|
|
1536
|
+
[prop: string]: unknown
|
|
1537
|
+
}
|
|
1449
1538
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1450
1539
|
threeAudio: ThreeElementsImpl['audio']
|
|
1451
1540
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1486,6 +1575,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1486
1575
|
type three_d_Matrix4 = Matrix4;
|
|
1487
1576
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1488
1577
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1578
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1489
1579
|
type three_d_Quaternion = Quaternion;
|
|
1490
1580
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1491
1581
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1500,7 +1590,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1500
1590
|
type three_d_Vector4 = Vector4;
|
|
1501
1591
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1502
1592
|
declare namespace three_d {
|
|
1503
|
-
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 };
|
|
1593
|
+
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 };
|
|
1504
1594
|
}
|
|
1505
1595
|
|
|
1506
1596
|
/**
|
|
@@ -1638,9 +1728,9 @@ type EnvironmentProps = {
|
|
|
1638
1728
|
blur?: number;
|
|
1639
1729
|
backgroundBlurriness?: number;
|
|
1640
1730
|
backgroundIntensity?: number;
|
|
1641
|
-
backgroundRotation?: Euler
|
|
1731
|
+
backgroundRotation?: Euler;
|
|
1642
1732
|
environmentIntensity?: number;
|
|
1643
|
-
environmentRotation?: Euler
|
|
1733
|
+
environmentRotation?: Euler;
|
|
1644
1734
|
map?: Texture$1;
|
|
1645
1735
|
preset?: PresetsType;
|
|
1646
1736
|
scene?: Scene | React$1.RefObject<Scene>;
|
|
@@ -1724,7 +1814,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
|
|
|
1724
1814
|
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;
|
|
1725
1815
|
declare module '@react-three/fiber' {
|
|
1726
1816
|
interface ThreeElements {
|
|
1727
|
-
groundProjectedEnvImpl: ThreeElement
|
|
1817
|
+
groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
|
|
1728
1818
|
}
|
|
1729
1819
|
}
|
|
1730
1820
|
/**
|
|
@@ -1824,6 +1914,24 @@ declare module '@react-three/fiber' {
|
|
|
1824
1914
|
*/
|
|
1825
1915
|
declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
1826
1916
|
|
|
1917
|
+
/**
|
|
1918
|
+
* Moves every trace of interactivity from one object to its replacement, for reconstruction.
|
|
1919
|
+
*
|
|
1920
|
+
* When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
|
|
1921
|
+
* instance. Removing the old object from the interaction state and registering the new one from
|
|
1922
|
+
* scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
|
|
1923
|
+
* the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
|
|
1924
|
+
* is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
|
|
1925
|
+
* swap the user never asked to see (#3744).
|
|
1926
|
+
*
|
|
1927
|
+
* Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
|
|
1928
|
+
* left alone — releasing and re-acquiring it is precisely the glitch being avoided.
|
|
1929
|
+
*
|
|
1930
|
+
* Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
|
|
1931
|
+
* the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
|
|
1932
|
+
* cannot outlive the object it described.
|
|
1933
|
+
*/
|
|
1934
|
+
declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
|
|
1827
1935
|
declare function removeInteractivity(store: RootStore, object: Object3D): void;
|
|
1828
1936
|
declare function createEvents(store: RootStore): {
|
|
1829
1937
|
handlePointer: (name: string) => (event: DomEvent) => void;
|
|
@@ -1831,7 +1939,43 @@ declare function createEvents(store: RootStore): {
|
|
|
1831
1939
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1832
1940
|
};
|
|
1833
1941
|
/** Default R3F event manager for web */
|
|
1834
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1942
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1943
|
+
|
|
1944
|
+
interface RootExtension {
|
|
1945
|
+
/** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
|
|
1946
|
+
* set up are not set up a second time, but get the new entry's dispose and hmr. */
|
|
1947
|
+
name: string;
|
|
1948
|
+
/**
|
|
1949
|
+
* Called once per root, after its renderer exists and before `onCreated` and the first frame.
|
|
1950
|
+
* `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
|
|
1951
|
+
* to the primary canvas. Return fields to merge into the root's state, or nothing.
|
|
1952
|
+
*/
|
|
1953
|
+
setup?(store: RootStore): Partial<RootState> | void;
|
|
1954
|
+
/** Called when a root this extension set up unmounts. */
|
|
1955
|
+
dispose?(store: RootStore): void;
|
|
1956
|
+
/** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
|
|
1957
|
+
hmr?(store: RootStore): void;
|
|
1958
|
+
}
|
|
1959
|
+
/**
|
|
1960
|
+
* Register an extension. It is set up on every live root immediately, and on every root created
|
|
1961
|
+
* afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
|
|
1962
|
+
* it already set up keep its state and still get its dispose when they unmount.
|
|
1963
|
+
*/
|
|
1964
|
+
declare function registerRootExtension(extension: RootExtension): () => void;
|
|
1965
|
+
/**
|
|
1966
|
+
* Point a root's default render job at a different render function, or back at
|
|
1967
|
+
* `renderer.render(scene, camera)` with `null`.
|
|
1968
|
+
*
|
|
1969
|
+
* The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
|
|
1970
|
+
* boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
|
|
1971
|
+
*/
|
|
1972
|
+
declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
|
|
1973
|
+
|
|
1974
|
+
/**
|
|
1975
|
+
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
1976
|
+
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
1977
|
+
*/
|
|
1978
|
+
declare function useStore(): RootStore;
|
|
1835
1979
|
|
|
1836
1980
|
/**
|
|
1837
1981
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -1851,50 +1995,6 @@ declare namespace useLoader {
|
|
|
1851
1995
|
var loader: typeof getLoader;
|
|
1852
1996
|
}
|
|
1853
1997
|
|
|
1854
|
-
/**
|
|
1855
|
-
* Frame hook with phase-based ordering, priority, and FPS throttling.
|
|
1856
|
-
*
|
|
1857
|
-
* Always delivers full RootState — works both inside and outside Canvas context:
|
|
1858
|
-
* - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
|
|
1859
|
-
* - Outside Canvas: The job registers immediately but the callback is held until a
|
|
1860
|
-
* Canvas adopts it, then runs with full RootState. For hostless / standalone
|
|
1861
|
-
* frame loops with no Canvas, use `@pmndrs/scheduler` directly.
|
|
1862
|
-
*
|
|
1863
|
-
* Returns a controls object for manual stepping, pausing, and resuming.
|
|
1864
|
-
*
|
|
1865
|
-
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
1866
|
-
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
1867
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
1868
|
-
*
|
|
1869
|
-
* @example
|
|
1870
|
-
* // Simple priority (backwards compat)
|
|
1871
|
-
* useFrame((state, delta) => { ... }, 5)
|
|
1872
|
-
*
|
|
1873
|
-
* @example
|
|
1874
|
-
* // With phase-based ordering
|
|
1875
|
-
* useFrame((state, delta) => { ... }, { phase: 'physics' })
|
|
1876
|
-
*
|
|
1877
|
-
* @example
|
|
1878
|
-
* // Outside Canvas - callback waits for a Canvas, then always has full state
|
|
1879
|
-
* function UI() {
|
|
1880
|
-
* useFrame((state, delta) => { syncUI(state.camera) });
|
|
1881
|
-
* return <button>...</button>;
|
|
1882
|
-
* }
|
|
1883
|
-
*
|
|
1884
|
-
* @example
|
|
1885
|
-
* // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
|
|
1886
|
-
* import { getScheduler } from '@pmndrs/scheduler'
|
|
1887
|
-
* getScheduler().register((state, delta) => { updateGame(delta) })
|
|
1888
|
-
*
|
|
1889
|
-
* @example
|
|
1890
|
-
* // Scheduler-only access (no callback)
|
|
1891
|
-
* const { scheduler } = useFrame()
|
|
1892
|
-
* scheduler.pauseJob('some-job-id')
|
|
1893
|
-
*
|
|
1894
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
|
|
1895
|
-
*/
|
|
1896
|
-
declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
|
|
1897
|
-
|
|
1898
1998
|
declare const IsObject: (url: unknown) => url is Record<string, string>;
|
|
1899
1999
|
type TextureArray<T> = T extends string[] ? Texture$1[] : never;
|
|
1900
2000
|
type TextureRecord<T> = T extends Record<string, string> ? {
|
|
@@ -2075,16 +2175,6 @@ declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
|
|
|
2075
2175
|
declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
|
|
2076
2176
|
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
|
|
2077
2177
|
|
|
2078
|
-
/**
|
|
2079
|
-
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
2080
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2081
|
-
*/
|
|
2082
|
-
declare function useStore(): RootStore;
|
|
2083
|
-
/**
|
|
2084
|
-
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
2085
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
2086
|
-
*/
|
|
2087
|
-
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
2088
2178
|
/**
|
|
2089
2179
|
* Exposes an object's {@link Instance}.
|
|
2090
2180
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2160,7 +2250,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2160
2250
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2161
2251
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2162
2252
|
*
|
|
2163
|
-
*
|
|
2253
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
2254
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
2255
|
+
*
|
|
2256
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2164
2257
|
* @param frames - Number of frames to request (default: 1)
|
|
2165
2258
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2166
2259
|
*
|
|
@@ -2171,14 +2264,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2171
2264
|
* Advances the frameloop and runs render effects.
|
|
2172
2265
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2173
2266
|
*
|
|
2267
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2268
|
+
* registered root is stepped for backwards compatibility.
|
|
2269
|
+
*
|
|
2174
2270
|
* @param timestamp - The timestamp to use for this frame
|
|
2175
2271
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2176
|
-
* @param state -
|
|
2177
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2272
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2178
2273
|
*
|
|
2179
2274
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2180
2275
|
*/
|
|
2181
|
-
declare function advance(timestamp: number): void;
|
|
2276
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2182
2277
|
|
|
2183
2278
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2184
2279
|
declare function ReactReconciler<
|
|
@@ -3223,6 +3318,7 @@ declare namespace ReactReconciler {
|
|
|
3223
3318
|
|
|
3224
3319
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3225
3320
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3321
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3226
3322
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3227
3323
|
|
|
3228
3324
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3247,13 +3343,9 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
|
|
|
3247
3343
|
declare function flushSync<R>(fn: () => R): R;
|
|
3248
3344
|
|
|
3249
3345
|
declare const context: React$1.Context<RootStore>;
|
|
3346
|
+
|
|
3250
3347
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3251
3348
|
|
|
3252
|
-
/**
|
|
3253
|
-
* Safely flush async effects when testing, simulating a legacy root.
|
|
3254
|
-
* @deprecated Import from React instead. import { act } from 'react'
|
|
3255
|
-
*/
|
|
3256
|
-
declare const act: typeof React$1.act;
|
|
3257
3349
|
/**
|
|
3258
3350
|
* An SSR-friendly useLayoutEffect.
|
|
3259
3351
|
*
|
|
@@ -3505,7 +3597,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
|
|
|
3505
3597
|
declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
|
|
3506
3598
|
/**
|
|
3507
3599
|
* Triggers an update for an instance.
|
|
3508
|
-
*
|
|
3600
|
+
* Invalidates the frame if the root is in demand mode.
|
|
3509
3601
|
*
|
|
3510
3602
|
* @param instance - Instance to invalidate
|
|
3511
3603
|
*/
|
|
@@ -3671,29 +3763,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3671
3763
|
* Used to identify values that should be resolved from refs after mount.
|
|
3672
3764
|
*/
|
|
3673
3765
|
declare const FROM_REF: unique symbol;
|
|
3766
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3767
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3768
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3769
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3770
|
+
transform?: (value: T) => R;
|
|
3771
|
+
}
|
|
3674
3772
|
/**
|
|
3675
3773
|
* Defers prop application until the referenced object is available.
|
|
3676
3774
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3677
3775
|
*
|
|
3776
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3777
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3778
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3779
|
+
* what gets assigned.
|
|
3780
|
+
*
|
|
3678
3781
|
* @param ref - React ref object to resolve at mount time
|
|
3679
|
-
* @
|
|
3782
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3783
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
3680
3784
|
*
|
|
3681
3785
|
* @example
|
|
3682
3786
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3683
3787
|
*
|
|
3684
3788
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3685
3789
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3790
|
+
*
|
|
3791
|
+
* @example
|
|
3792
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3793
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
3686
3794
|
*/
|
|
3687
3795
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3796
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
3688
3797
|
/**
|
|
3689
3798
|
* Type guard to check if a value is a fromRef marker.
|
|
3690
3799
|
*
|
|
3691
3800
|
* @param value - Value to check
|
|
3692
3801
|
* @returns True if value is a fromRef marker
|
|
3693
3802
|
*/
|
|
3694
|
-
declare function isFromRef(value: unknown): value is
|
|
3695
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3696
|
-
};
|
|
3803
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3697
3804
|
|
|
3698
3805
|
/**
|
|
3699
3806
|
* Symbol marker for mount-only method calls.
|
|
@@ -3720,7 +3827,15 @@ declare const ONCE: unique symbol;
|
|
|
3720
3827
|
* // No arguments
|
|
3721
3828
|
* <geometry center={once()} />
|
|
3722
3829
|
*/
|
|
3723
|
-
declare function once<
|
|
3830
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3831
|
+
/**
|
|
3832
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3833
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3834
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3835
|
+
*
|
|
3836
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3837
|
+
*/
|
|
3838
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
3724
3839
|
/**
|
|
3725
3840
|
* Type guard to check if a value is a once marker.
|
|
3726
3841
|
*
|
|
@@ -3731,11 +3846,8 @@ declare function isOnce(value: unknown): value is {
|
|
|
3731
3846
|
[ONCE]: any[] | true;
|
|
3732
3847
|
};
|
|
3733
3848
|
|
|
3734
|
-
/**
|
|
3735
|
-
|
|
3736
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/canvas
|
|
3737
|
-
*/
|
|
3738
|
-
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3849
|
+
/** Distinguishes a resource leaf from a nested resource scope. */
|
|
3850
|
+
type ResourceLeafGuard<T> = (value: unknown) => value is T;
|
|
3739
3851
|
|
|
3740
3852
|
/**
|
|
3741
3853
|
* ScopedStore - Type-safe wrapper for nested stores (uniforms, nodes)
|
|
@@ -3757,33 +3869,30 @@ declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
|
3757
3869
|
* ```
|
|
3758
3870
|
*/
|
|
3759
3871
|
|
|
3760
|
-
/** Keys reserved for methods (excluded from index signature) */
|
|
3761
|
-
type MethodKeys = 'scope' | 'has' | 'keys';
|
|
3762
3872
|
/**
|
|
3763
3873
|
* Type-safe wrapper interface for accessing nested store data.
|
|
3764
3874
|
* Property access returns `T` (assumes leaf node).
|
|
3765
3875
|
* Use `.scope(key)` for nested object access.
|
|
3766
3876
|
*
|
|
3767
|
-
* Uses mapped type with key filtering to exclude method names from index signature,
|
|
3768
|
-
* allowing methods to have their correct return types.
|
|
3769
3877
|
*/
|
|
3770
|
-
type
|
|
3771
|
-
/** Direct property access returns the leaf type T (method keys excluded) */
|
|
3772
|
-
readonly [K in string as K extends MethodKeys ? never : K]: T;
|
|
3773
|
-
} & {
|
|
3878
|
+
type ScopedStoreMethods<TLeaf> = {
|
|
3774
3879
|
/** Access a nested scope by key. Returns empty wrapper if scope doesn't exist. */
|
|
3775
|
-
scope(key: string): ScopedStoreType<
|
|
3880
|
+
scope<TScope extends Record<string, TLeaf> = Record<string, TLeaf>>(key: string): ScopedStoreType<TLeaf, TScope>;
|
|
3776
3881
|
/** Check if a key exists in the store */
|
|
3777
3882
|
has(key: string): boolean;
|
|
3778
3883
|
/** Get all keys in the store */
|
|
3779
3884
|
keys(): string[];
|
|
3780
3885
|
};
|
|
3886
|
+
type ScopedStoreType<TLeaf, TEntries extends Record<string, TLeaf> = Record<string, TLeaf>> = Readonly<TEntries> & ScopedStoreMethods<TLeaf>;
|
|
3887
|
+
interface ScopedStoreData<TLeaf> {
|
|
3888
|
+
[key: string]: TLeaf | ScopedStoreData<TLeaf>;
|
|
3889
|
+
}
|
|
3781
3890
|
/**
|
|
3782
3891
|
* Create a type-safe ScopedStore wrapper around store data.
|
|
3783
3892
|
* @param data - The raw store data (uniforms or nodes from RootState)
|
|
3784
3893
|
* @returns A ScopedStoreType wrapper with type-safe access
|
|
3785
3894
|
*/
|
|
3786
|
-
declare function createScopedStore<
|
|
3895
|
+
declare function createScopedStore<TLeaf>(data: ScopedStoreData<TLeaf>, isLeaf: ResourceLeafGuard<TLeaf>): ScopedStoreType<TLeaf>;
|
|
3787
3896
|
/**
|
|
3788
3897
|
* State type passed to creator functions with ScopedStore wrappers.
|
|
3789
3898
|
* Provides type-safe access to uniforms, nodes, buffers, and gpuStorage without manual casting.
|
|
@@ -3791,8 +3900,8 @@ declare function createScopedStore<T>(data: Record<string, any>): ScopedStoreTyp
|
|
|
3791
3900
|
type CreatorState = Omit<RootState, 'uniforms' | 'nodes' | 'buffers' | 'gpuStorage'> & {
|
|
3792
3901
|
/** Type-safe uniform access - property access returns UniformNode */
|
|
3793
3902
|
uniforms: ScopedStoreType<UniformNode>;
|
|
3794
|
-
/** Type-safe node access
|
|
3795
|
-
nodes: ScopedStoreType<
|
|
3903
|
+
/** Type-safe node access for real, callable, and legacy structural nodes */
|
|
3904
|
+
nodes: ScopedStoreType<NodeLike>;
|
|
3796
3905
|
/** Type-safe buffer access - property access returns BufferLike (TypedArrays, BufferAttributes, TSL nodes) */
|
|
3797
3906
|
buffers: ScopedStoreType<BufferLike>;
|
|
3798
3907
|
/** Type-safe GPU storage access - property access returns StorageLike (StorageTexture, TSL nodes) */
|
|
@@ -3808,17 +3917,18 @@ type ClearUniformsFn = (scope?: string) => void;
|
|
|
3808
3917
|
/** Function signature for rebuildUniforms util */
|
|
3809
3918
|
type RebuildUniformsFn = (scope?: string) => void;
|
|
3810
3919
|
/** Return type with utils included */
|
|
3811
|
-
type UniformsWithUtils<T extends UniformRecord = UniformRecord> = T & {
|
|
3920
|
+
type UniformsWithUtils<T extends UniformRecord | UniformStore = UniformRecord> = T & {
|
|
3812
3921
|
removeUniforms: RemoveUniformsFn;
|
|
3813
3922
|
clearUniforms: ClearUniformsFn;
|
|
3814
3923
|
rebuildUniforms: RebuildUniformsFn;
|
|
3815
3924
|
};
|
|
3816
|
-
declare function useUniforms(): UniformsWithUtils<
|
|
3925
|
+
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3926
|
+
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3927
|
+
declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3928
|
+
declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3929
|
+
declare function useUniforms(): UniformsWithUtils<UniformStore>;
|
|
3817
3930
|
declare function useUniforms(scope: string): UniformsWithUtils;
|
|
3818
|
-
declare function useUniforms<T extends UniformInputRecord>(
|
|
3819
|
-
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3820
|
-
declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3821
|
-
declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3931
|
+
declare function useUniforms<T extends UniformInputRecord>(scope?: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3822
3932
|
/**
|
|
3823
3933
|
* Global rebuildUniforms function for HMR integration.
|
|
3824
3934
|
* Invalidates cached uniforms and increments _hmrVersion to trigger re-creation.
|
|
@@ -3849,47 +3959,28 @@ declare function clearRootUniforms(set: ReturnType<typeof useStore>['setState'])
|
|
|
3849
3959
|
|
|
3850
3960
|
/**
|
|
3851
3961
|
* Supported uniform value types:
|
|
3852
|
-
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix3, Matrix4
|
|
3962
|
+
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix2, Matrix3, Matrix4
|
|
3853
3963
|
* - String colors: '#ff0000', 'red', 'rgb(255,0,0)' (auto-converted to Color)
|
|
3854
3964
|
* - TSL nodes: color(), vec3(), float(), etc. (for type casting)
|
|
3855
3965
|
* - UniformNode: existing uniforms (reused as-is)
|
|
3856
3966
|
*/
|
|
3857
|
-
type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
|
|
3858
|
-
|
|
3859
|
-
|
|
3860
|
-
* - 0 → number
|
|
3861
|
-
* - true → boolean
|
|
3862
|
-
* - '#ff0000' → Color (string colors are converted to Color objects)
|
|
3863
|
-
* - Node → Node (TSL nodes passed through for uniform type casting)
|
|
3864
|
-
*/
|
|
3865
|
-
type Widen<T> = T extends number ? number : T extends boolean ? boolean : T extends string ? Color$2 : T;
|
|
3866
|
-
declare function useUniform<T extends UniformValue>(name: string): UniformNode<T>;
|
|
3867
|
-
declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNode<Widen<T>>;
|
|
3967
|
+
type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
|
|
3968
|
+
declare function useUniform<T extends UniformValue = UniformValue>(name: string): UniformNodeFor<T>;
|
|
3969
|
+
declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNodeFor<T>;
|
|
3868
3970
|
|
|
3869
3971
|
/**
|
|
3870
|
-
*
|
|
3871
|
-
*
|
|
3872
|
-
*
|
|
3873
|
-
*
|
|
3972
|
+
* Every node representation a creator may return. The definition lives with the store types as
|
|
3973
|
+
* `NodeLike`, so the shape creators return and the shape `state.nodes` holds are one type by
|
|
3974
|
+
* construction: three's real `Node`, the callable proxy `Fn()` returns, or the legacy structural
|
|
3975
|
+
* `{ uuid, nodeType }` shape.
|
|
3874
3976
|
*/
|
|
3875
|
-
|
|
3876
|
-
|
|
3877
|
-
|
|
3878
|
-
/** label method for chaining - sets the node's label and returns self */
|
|
3879
|
-
label?: ((label: string) => TSLNodeLike) | string;
|
|
3880
|
-
setName?: (name: string) => this;
|
|
3881
|
-
}
|
|
3882
|
-
/** TSL node type - alias for compatibility */
|
|
3977
|
+
type TSLNodeLike = NodeLike;
|
|
3978
|
+
|
|
3979
|
+
/** Backward-compatible alias covering every accepted node representation. */
|
|
3883
3980
|
type TSLNode = TSLNodeLike;
|
|
3884
|
-
/**
|
|
3885
|
-
* A record of TSL nodes - allows mixed node types (OperatorNode, ConstNode, etc.)
|
|
3886
|
-
* Uses TSLNodeLike for broader compatibility with Three.js's TSL type definitions.
|
|
3887
|
-
*/
|
|
3888
|
-
type NodeRecord<T extends TSLNodeLike = TSLNodeLike> = Record<string, T>;
|
|
3889
3981
|
/**
|
|
3890
3982
|
* Creator function that returns a record of nodes.
|
|
3891
|
-
*
|
|
3892
|
-
* (e.g., { n: OperatorNode; color: ConstNode<Color> }) to pass type checking.
|
|
3983
|
+
* Exact creator return inference is preserved within the compatible node constraint.
|
|
3893
3984
|
*/
|
|
3894
3985
|
type NodeCreator<T extends Record<string, TSLNodeLike>> = (state: CreatorState) => T;
|
|
3895
3986
|
/** Function signature for removeNodes util */
|
|
@@ -3899,15 +3990,17 @@ type ClearNodesFn = (scope?: string) => void;
|
|
|
3899
3990
|
/** Function signature for rebuildNodes util */
|
|
3900
3991
|
type RebuildNodesFn = (scope?: string) => void;
|
|
3901
3992
|
/** Return type with utils included */
|
|
3902
|
-
type NodesWithUtils<T extends Record<string,
|
|
3993
|
+
type NodesWithUtils<T extends Record<string, unknown> = NodeRecord> = T & {
|
|
3903
3994
|
removeNodes: RemoveNodesFn;
|
|
3904
3995
|
clearNodes: ClearNodesFn;
|
|
3905
3996
|
rebuildNodes: RebuildNodesFn;
|
|
3906
3997
|
};
|
|
3907
|
-
declare function useNodes(): NodesWithUtils<
|
|
3908
|
-
declare function useNodes(scope: string): NodesWithUtils<
|
|
3909
|
-
declare function useNodes<T extends
|
|
3910
|
-
declare function useNodes<T extends
|
|
3998
|
+
declare function useNodes(): NodesWithUtils<NodeStore>;
|
|
3999
|
+
declare function useNodes(scope: string): NodesWithUtils<NodeRecord>;
|
|
4000
|
+
declare function useNodes<T extends NodeRecord>(scope?: string): NodesWithUtils<T>;
|
|
4001
|
+
declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>): NodesWithUtils<T>;
|
|
4002
|
+
declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>, scope: string): NodesWithUtils<T>;
|
|
4003
|
+
declare function useNodes(creatorOrScope?: NodeCreator<NodeRecord> | string, scope?: string): NodesWithUtils<Record<string, unknown>>;
|
|
3911
4004
|
/**
|
|
3912
4005
|
* Global rebuildNodes function for HMR integration.
|
|
3913
4006
|
* Invalidates cached nodes and increments _hmrVersion to trigger re-creation.
|
|
@@ -3966,6 +4059,10 @@ type LocalNodeCreator<T extends Record<string, unknown>> = (state: CreatorState)
|
|
|
3966
4059
|
*/
|
|
3967
4060
|
declare function useLocalNodes<T extends Record<string, unknown>>(creator: LocalNodeCreator<T>): T;
|
|
3968
4061
|
|
|
4062
|
+
/**
|
|
4063
|
+
* A record of buffer-like values - allows mixed types (TypedArrays, BufferAttributes, TSL nodes)
|
|
4064
|
+
*/
|
|
4065
|
+
type BufferRecordType<T extends BufferLike = BufferLike> = Record<string, T>;
|
|
3969
4066
|
/**
|
|
3970
4067
|
* Creator function that returns a record of buffers.
|
|
3971
4068
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -3980,14 +4077,15 @@ type RebuildBuffersFn = (scope?: string) => void;
|
|
|
3980
4077
|
/** Function signature for disposeBuffers util - releases GPU resources */
|
|
3981
4078
|
type DisposeBuffersFn = (names: string | string[], scope?: string) => void;
|
|
3982
4079
|
/** Return type with utils included */
|
|
3983
|
-
type BuffersWithUtils<T extends
|
|
4080
|
+
type BuffersWithUtils<T extends BufferRecordType | BufferStore = BufferRecordType> = T & {
|
|
3984
4081
|
removeBuffers: RemoveBuffersFn;
|
|
3985
4082
|
clearBuffers: ClearBuffersFn;
|
|
3986
4083
|
rebuildBuffers: RebuildBuffersFn;
|
|
3987
4084
|
disposeBuffers: DisposeBuffersFn;
|
|
3988
4085
|
};
|
|
3989
|
-
declare function useBuffers(): BuffersWithUtils<
|
|
4086
|
+
declare function useBuffers(): BuffersWithUtils<BufferStore>;
|
|
3990
4087
|
declare function useBuffers(scope: string): BuffersWithUtils<Record<string, BufferLike>>;
|
|
4088
|
+
declare function useBuffers<T extends Record<string, BufferLike>>(scope?: string): BuffersWithUtils<T>;
|
|
3991
4089
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>): BuffersWithUtils<T>;
|
|
3992
4090
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>, scope: string): BuffersWithUtils<T>;
|
|
3993
4091
|
/**
|
|
@@ -4003,6 +4101,10 @@ declare function useBuffers<T extends Record<string, BufferLike>>(creator: Buffe
|
|
|
4003
4101
|
*/
|
|
4004
4102
|
declare function rebuildAllBuffers(store: ReturnType<typeof useStore>, scope?: string): void;
|
|
4005
4103
|
|
|
4104
|
+
/**
|
|
4105
|
+
* A record of storage-like values - allows mixed types (StorageTexture, Storage3DTexture, TSL nodes)
|
|
4106
|
+
*/
|
|
4107
|
+
type StorageRecordType<T extends StorageLike = StorageLike> = Record<string, T>;
|
|
4006
4108
|
/**
|
|
4007
4109
|
* Creator function that returns a record of GPU storage objects.
|
|
4008
4110
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -4017,14 +4119,15 @@ type RebuildStorageFn = (scope?: string) => void;
|
|
|
4017
4119
|
/** Function signature for disposeStorage util - releases GPU resources */
|
|
4018
4120
|
type DisposeStorageFn = (names: string | string[], scope?: string) => void;
|
|
4019
4121
|
/** Return type with utils included */
|
|
4020
|
-
type StorageWithUtils<T extends
|
|
4122
|
+
type StorageWithUtils<T extends StorageRecordType | StorageStore = StorageRecordType> = T & {
|
|
4021
4123
|
removeStorage: RemoveStorageFn;
|
|
4022
4124
|
clearStorage: ClearStorageFn;
|
|
4023
4125
|
rebuildStorage: RebuildStorageFn;
|
|
4024
4126
|
disposeStorage: DisposeStorageFn;
|
|
4025
4127
|
};
|
|
4026
|
-
declare function useGPUStorage(): StorageWithUtils<
|
|
4128
|
+
declare function useGPUStorage(): StorageWithUtils<StorageStore>;
|
|
4027
4129
|
declare function useGPUStorage(scope: string): StorageWithUtils<Record<string, StorageLike>>;
|
|
4130
|
+
declare function useGPUStorage<T extends Record<string, StorageLike>>(scope?: string): StorageWithUtils<T>;
|
|
4028
4131
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>): StorageWithUtils<T>;
|
|
4029
4132
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>, scope: string): StorageWithUtils<T>;
|
|
4030
4133
|
/**
|
|
@@ -4074,6 +4177,10 @@ declare function createTextureOperations(set: StoreApi<RootState>['setState']):
|
|
|
4074
4177
|
* - Callbacks receive full RootState for flexibility
|
|
4075
4178
|
* - No auto-cleanup on unmount - use reset() for explicit cleanup
|
|
4076
4179
|
* - Scene/camera changes trigger scenePass recreation
|
|
4180
|
+
* - A replaced scenePass is disposed once the new graph is installed, so rebuild() does not
|
|
4181
|
+
* strand its render target (and MRT attachments) on the GPU
|
|
4182
|
+
* - Any run that changes the output node sets RenderPipeline.needsUpdate, so rebuild() actually
|
|
4183
|
+
* recompiles instead of silently keeping the first compiled graph
|
|
4077
4184
|
*
|
|
4078
4185
|
* @param mainCB - Main callback to configure outputNode and create effect passes
|
|
4079
4186
|
* @param setupCB - Optional setup callback to configure MRT on scenePass
|
|
@@ -4151,5 +4258,32 @@ interface WebGPURootState extends Omit<RootState, 'renderer' | 'gl' | 'internal'
|
|
|
4151
4258
|
internal: WebGPUInternalState
|
|
4152
4259
|
}
|
|
4153
4260
|
|
|
4154
|
-
|
|
4155
|
-
|
|
4261
|
+
/**
|
|
4262
|
+
* @fileoverview WebGPU entry point - WebGPU only, no legacy WebGL
|
|
4263
|
+
*
|
|
4264
|
+
* This entry point is for apps that want to use ONLY WebGPURenderer.
|
|
4265
|
+
* Includes WebGPU-specific hooks (useUniforms, useNodes, useTextures).
|
|
4266
|
+
* Auto-extends THREE with WebGPU node materials (MeshBasicNodeMaterial, etc.)
|
|
4267
|
+
*
|
|
4268
|
+
* Usage:
|
|
4269
|
+
* import { Canvas, useFrame, useUniforms } from '@react-three/fiber/webgpu'
|
|
4270
|
+
*/
|
|
4271
|
+
|
|
4272
|
+
/** `useThree` narrowed to WebGPU state — `state.renderer` is a `WebGPURenderer`. */
|
|
4273
|
+
type UseThreeWebGPU = <T = WebGPURootState>(selector?: (state: WebGPURootState) => T, equalityFn?: <U>(state: U, newState: U) => boolean) => T;
|
|
4274
|
+
/** `useFrame` narrowed to WebGPU state — the callback's `state.renderer` is a `WebGPURenderer`. */
|
|
4275
|
+
type UseFrameWebGPU = (callback?: FrameCallback$1<WebGPURootState>, priorityOrOptions?: number | UseFrameNextOptions) => FrameNextControls;
|
|
4276
|
+
declare const useThree: UseThreeWebGPU;
|
|
4277
|
+
declare const useFrame: UseFrameWebGPU;
|
|
4278
|
+
|
|
4279
|
+
/** Canvas props on the WebGPU entry: `onCreated` receives `WebGPURootState`. */
|
|
4280
|
+
type WebGPUCanvasProps = Omit<CanvasProps, 'onCreated'> & {
|
|
4281
|
+
/** Callback after the canvas has rendered (but not yet committed); `state.renderer` is a `WebGPURenderer` */
|
|
4282
|
+
onCreated?: (state: WebGPURootState) => void;
|
|
4283
|
+
};
|
|
4284
|
+
|
|
4285
|
+
/** `Canvas` narrowed to WebGPU state — the same component, `onCreated` typed against `WebGPURootState`. */
|
|
4286
|
+
declare const Canvas: (props: WebGPUCanvasProps) => JSX.Element;
|
|
4287
|
+
|
|
4288
|
+
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, clearNodeScope, clearRootNodes, clearRootUniforms, clearScope, context, createEvents, createPointerEvents, createPortal, createRoot, createScopedStore, createStore, createTextureOperations, 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, rebuildAllBuffers, rebuildAllNodes, rebuildAllStorage, rebuildAllUniforms, reconciler, registerPrimary, registerRootExtension, removeInteractivity, removeNodes, removeUniforms, resolve, setRenderOverride, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useBuffers, useEnvironment, useFrame, useGPUStorage, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useLocalNodes, useMutableCallback, useNodes, useRenderPipeline, useRenderTarget, useStore, useTexture, useTextures, useThree, useUniform, useUniforms, waitForPrimary };
|
|
4289
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferCreator, BufferLike, BufferRecord, BufferStore, BuffersWithUtils, Camera, CameraProps, WebGPUCanvasProps as CanvasProps, CanvasSchedulerConfig, Catalogue, ClearBuffersFn, ClearNodesFn, ClearStorageFn, ClearUniformsFn, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, CreatorState, DefaultGLProps, DefaultRendererProps, Disposable, DisposeBuffersFn, DisposeOptions, DisposeStorageFn, 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, WebGPUInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, LocalNodeCreator, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeCreator, NodeLike, NodeProps, NodeRecord, NodeStore, NodesWithUtils, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, WebGPUR3FRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, RebuildBuffersFn, RebuildNodesFn, RebuildStorageFn, RebuildUniformsFn, ReconcilerRoot, RemoveBuffersFn, RemoveNodesFn, RemoveStorageFn, RemoveUniformsFn, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootExtension, WebGPURootState as RootState, RootStore, ScopedStoreType, SetBlock, Size, StorageCreator, StorageLike, StorageRecord, StorageStore, StorageWithUtils, Subscription, TSLNode, TSLNodeInput, TSLNodeLike, TextureEntry, TextureInput, TextureNode, TextureOperations, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UniformCreator, UniformValue, UniformsWithUtils, UseFrameWebGPU, UseTextureOptions, UseTexturesReturn, UseThreeWebGPU, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUCanvasProps, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager, XRPointerConfig };
|