@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/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';
|
|
@@ -13,20 +14,6 @@ import { Options } from 'react-use-measure';
|
|
|
13
14
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
14
15
|
import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
|
|
15
16
|
|
|
16
|
-
function _mergeNamespaces(n, m) {
|
|
17
|
-
m.forEach(function (e) {
|
|
18
|
-
e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
|
|
19
|
-
if (k !== 'default' && !(k in n)) {
|
|
20
|
-
var d = Object.getOwnPropertyDescriptor(e, k);
|
|
21
|
-
Object.defineProperty(n, k, d.get ? d : {
|
|
22
|
-
enumerable: true,
|
|
23
|
-
get: function () { return e[k]; }
|
|
24
|
-
});
|
|
25
|
-
}
|
|
26
|
-
});
|
|
27
|
-
});
|
|
28
|
-
return Object.freeze(n);
|
|
29
|
-
}
|
|
30
17
|
|
|
31
18
|
/**
|
|
32
19
|
* @fileoverview Internal Three.js re-exports - WEBGPU ONLY ENTRY
|
|
@@ -40,6 +27,8 @@ function _mergeNamespaces(n, m) {
|
|
|
40
27
|
declare const R3F_BUILD_LEGACY = false;
|
|
41
28
|
declare const R3F_BUILD_WEBGPU = true;
|
|
42
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>;
|
|
43
32
|
declare const WebGLRenderer: {
|
|
44
33
|
new (): {};
|
|
45
34
|
};
|
|
@@ -50,19 +39,6 @@ declare const WebGLRenderTarget: any;
|
|
|
50
39
|
|
|
51
40
|
declare const WebGLCubeRenderTarget: any;
|
|
52
41
|
|
|
53
|
-
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
54
|
-
__proto__: null,
|
|
55
|
-
CubeRenderTargetCompat: CubeRenderTarget,
|
|
56
|
-
Inspector: Inspector,
|
|
57
|
-
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
58
|
-
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
59
|
-
RenderTargetCompat: RenderTarget,
|
|
60
|
-
WebGLCubeRenderTarget: WebGLCubeRenderTarget,
|
|
61
|
-
WebGLRenderTarget: WebGLRenderTarget,
|
|
62
|
-
WebGLRenderer: WebGLRenderer,
|
|
63
|
-
WebGLRendererParameters: WebGLRendererParameters,
|
|
64
|
-
WebGLShadowMap: WebGLShadowMap
|
|
65
|
-
}, [three_webgpu]);
|
|
66
42
|
|
|
67
43
|
//* Utility Types ==============================
|
|
68
44
|
|
|
@@ -350,6 +326,7 @@ type BufferLike =
|
|
|
350
326
|
| Uint16Array
|
|
351
327
|
| Int16Array
|
|
352
328
|
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
329
|
+
| THREE$1.InterleavedBufferAttribute
|
|
353
330
|
| Node // TSL buffer nodes (instancedArray, storage)
|
|
354
331
|
|
|
355
332
|
/** Flat record of buffer-like values (no nested scopes) */
|
|
@@ -361,6 +338,25 @@ type BufferRecord = Record<string, BufferLike>
|
|
|
361
338
|
*/
|
|
362
339
|
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
363
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
|
+
|
|
364
360
|
//* Storage Types (useGPUStorage) ========================================
|
|
365
361
|
|
|
366
362
|
/**
|
|
@@ -375,7 +371,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
|
375
371
|
* ```
|
|
376
372
|
*/
|
|
377
373
|
type StorageLike =
|
|
378
|
-
| 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
|
|
379
377
|
| Data3DTexture // 3D texture (can be used as storage)
|
|
380
378
|
| Node // TSL storage texture nodes (storageTexture)
|
|
381
379
|
|
|
@@ -487,6 +485,12 @@ interface InternalState {
|
|
|
487
485
|
actualRenderer: R3FRenderer
|
|
488
486
|
/** Global scheduler reference (for useFrame hook) */
|
|
489
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
|
|
490
494
|
/** This root's unique ID in the global scheduler */
|
|
491
495
|
rootId?: string
|
|
492
496
|
/** Function to unregister this root from the global scheduler */
|
|
@@ -494,11 +498,28 @@ interface InternalState {
|
|
|
494
498
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
495
499
|
container?: THREE$1.Object3D
|
|
496
500
|
/**
|
|
497
|
-
* CanvasTarget
|
|
498
|
-
*
|
|
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.
|
|
499
508
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
500
509
|
*/
|
|
501
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
|
|
502
523
|
/**
|
|
503
524
|
* Whether multi-canvas rendering is active.
|
|
504
525
|
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
@@ -608,7 +629,7 @@ interface RootState {
|
|
|
608
629
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
609
630
|
uniforms: UniformStore
|
|
610
631
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
611
|
-
nodes:
|
|
632
|
+
nodes: NodeStore
|
|
612
633
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
613
634
|
buffers: BufferStore
|
|
614
635
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -620,7 +641,7 @@ interface RootState {
|
|
|
620
641
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
621
642
|
renderPipeline: ThreeRenderPipeline | null
|
|
622
643
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
623
|
-
passes:
|
|
644
|
+
passes: PassRecord
|
|
624
645
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
625
646
|
_hmrVersion: number
|
|
626
647
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -708,12 +729,19 @@ type DefaultRendererProps = {
|
|
|
708
729
|
*/
|
|
709
730
|
interface CanvasSchedulerConfig {
|
|
710
731
|
/**
|
|
711
|
-
*
|
|
712
|
-
|
|
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).
|
|
713
737
|
*/
|
|
714
|
-
after?: string
|
|
738
|
+
after?: string | string[]
|
|
715
739
|
/**
|
|
716
|
-
*
|
|
740
|
+
* Numeric root order. Lower values run first.
|
|
741
|
+
*/
|
|
742
|
+
order?: number
|
|
743
|
+
/**
|
|
744
|
+
* Limit this Canvas's default render job (frames per second).
|
|
717
745
|
*/
|
|
718
746
|
fps?: number
|
|
719
747
|
}
|
|
@@ -800,14 +828,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
800
828
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
801
829
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
802
830
|
dpr?: Dpr
|
|
803
|
-
/**
|
|
804
|
-
|
|
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> }
|
|
805
836
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
806
837
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
807
838
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
808
839
|
camera?: CameraProps
|
|
809
840
|
/** An R3F event manager to manage elements' pointer events */
|
|
810
|
-
events?: (store: RootStore) => EventManager<
|
|
841
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
811
842
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
812
843
|
onCreated?: (state: RootState) => void
|
|
813
844
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -896,7 +927,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
|
|
|
896
927
|
object?: T
|
|
897
928
|
dispose?: null
|
|
898
929
|
attach?: AttachType<T>
|
|
899
|
-
onUpdate?: (self: T) => void
|
|
900
930
|
}
|
|
901
931
|
|
|
902
932
|
interface Instance<O = any> {
|
|
@@ -1036,7 +1066,7 @@ interface CanvasProps
|
|
|
1036
1066
|
*/
|
|
1037
1067
|
resize?: Options
|
|
1038
1068
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1039
|
-
eventSource?:
|
|
1069
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1040
1070
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1041
1071
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1042
1072
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1144,81 +1174,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1144
1174
|
|
|
1145
1175
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1146
1176
|
|
|
1147
|
-
//* Global Types ==============================
|
|
1177
|
+
//* Global TSL Types ==============================
|
|
1148
1178
|
|
|
1149
1179
|
declare global {
|
|
1150
1180
|
/**
|
|
1151
|
-
*
|
|
1152
|
-
*
|
|
1153
|
-
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1154
|
-
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1155
|
-
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1156
|
-
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1157
|
-
* arity when three made `UniformNode` two-parameter.
|
|
1158
|
-
*
|
|
1159
|
-
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1160
|
-
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1161
|
-
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1162
|
-
* 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`.
|
|
1163
1183
|
*/
|
|
1164
|
-
type
|
|
1184
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1185
|
+
readonly shaderNode: unknown
|
|
1186
|
+
readonly id: number
|
|
1187
|
+
}
|
|
1165
1188
|
|
|
1166
|
-
/**
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
* @example
|
|
1172
|
-
* ```tsx
|
|
1173
|
-
* // Define a shader function
|
|
1174
|
-
* const blendColorFn = Fn(([color1, color2, factor]) => {
|
|
1175
|
-
* return mix(color1, color2, factor)
|
|
1176
|
-
* })
|
|
1177
|
-
*
|
|
1178
|
-
* // Type when retrieving from nodes store
|
|
1179
|
-
* const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
|
|
1180
|
-
*
|
|
1181
|
-
* // Or with specific return type
|
|
1182
|
-
* const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
|
|
1183
|
-
* ```
|
|
1184
|
-
*/
|
|
1185
|
-
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 })
|
|
1186
1194
|
|
|
1187
|
-
/**
|
|
1188
|
-
|
|
1189
|
-
* This is the common return type for TSL operations (add, mul, sin, etc.)
|
|
1190
|
-
*
|
|
1191
|
-
* @example
|
|
1192
|
-
* ```tsx
|
|
1193
|
-
* const { wobble } = nodes as { wobble: ShaderNodeRef }
|
|
1194
|
-
* ```
|
|
1195
|
-
*/
|
|
1196
|
-
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
|
|
1197
1197
|
|
|
1198
1198
|
/**
|
|
1199
|
-
*
|
|
1200
|
-
*
|
|
1201
|
-
*
|
|
1202
|
-
*
|
|
1203
|
-
* - Node: base Three.js node type
|
|
1204
|
-
* - ShaderCallable: function nodes created with Fn()
|
|
1205
|
-
* - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
|
|
1206
|
-
*
|
|
1207
|
-
* @example
|
|
1208
|
-
* ```tsx
|
|
1209
|
-
* // In useLocalNodes, nodes are typed as TSLNodeType
|
|
1210
|
-
* const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
|
|
1211
|
-
* positionNode: nodes.myPosition, // Works - Node is in union
|
|
1212
|
-
* blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
|
|
1213
|
-
* }))
|
|
1214
|
-
*
|
|
1215
|
-
* // Can narrow with type guard or assertion when needed
|
|
1216
|
-
* if (typeof blendColorFn === 'function') {
|
|
1217
|
-
* blendColorFn(someColor, 0.5)
|
|
1218
|
-
* }
|
|
1219
|
-
* ```
|
|
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.
|
|
1220
1203
|
*/
|
|
1221
|
-
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>
|
|
1222
1257
|
|
|
1223
1258
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1224
1259
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1243,7 +1278,7 @@ declare global {
|
|
|
1243
1278
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1244
1279
|
* Supports:
|
|
1245
1280
|
* - Primitives: number, string (color), boolean
|
|
1246
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1281
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1247
1282
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1248
1283
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1249
1284
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1256,88 +1291,124 @@ declare global {
|
|
|
1256
1291
|
| three_webgpu.Vector2
|
|
1257
1292
|
| three_webgpu.Vector3
|
|
1258
1293
|
| three_webgpu.Vector4
|
|
1294
|
+
| three_webgpu.Matrix2
|
|
1259
1295
|
| three_webgpu.Matrix3
|
|
1260
1296
|
| three_webgpu.Matrix4
|
|
1261
|
-
|
|
|
1262
|
-
|
|
|
1263
|
-
| { x: number; y
|
|
1297
|
+
| { x: number; y: number }
|
|
1298
|
+
| { x: number; y: number; z: number }
|
|
1299
|
+
| { x: number; y: number; z: number; w: number }
|
|
1264
1300
|
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1265
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1301
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1266
1302
|
| UniformNode
|
|
1267
1303
|
|
|
1268
1304
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1269
1305
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1270
1306
|
}
|
|
1271
1307
|
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
declare module 'three/tsl' {
|
|
1308
|
+
declare global {
|
|
1275
1309
|
/**
|
|
1276
|
-
*
|
|
1277
|
-
*
|
|
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.
|
|
1278
1313
|
*/
|
|
1279
|
-
|
|
1280
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1281
|
-
): ShaderCallable<R>
|
|
1314
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1282
1315
|
|
|
1283
1316
|
/**
|
|
1284
|
-
*
|
|
1285
|
-
*
|
|
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.
|
|
1286
1320
|
*/
|
|
1287
|
-
|
|
1288
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1289
|
-
): ShaderCallable<R>
|
|
1321
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1290
1322
|
|
|
1291
1323
|
/**
|
|
1292
|
-
*
|
|
1293
|
-
*
|
|
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.
|
|
1294
1340
|
*/
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1341
|
+
interface PassRecord {
|
|
1342
|
+
scenePass?: ScenePassNode
|
|
1343
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1344
|
+
}
|
|
1299
1345
|
|
|
1300
1346
|
/**
|
|
1301
|
-
*
|
|
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.
|
|
1302
1354
|
*/
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1355
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1356
|
+
renderPipeline: ThreeRenderPipeline
|
|
1357
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1358
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1359
|
+
isLegacy: false
|
|
1360
|
+
}
|
|
1308
1361
|
|
|
1309
|
-
declare global {
|
|
1310
1362
|
/**
|
|
1311
|
-
*
|
|
1312
|
-
*
|
|
1313
|
-
* 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.
|
|
1314
1369
|
*/
|
|
1315
|
-
type
|
|
1316
|
-
|
|
1317
|
-
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1318
|
-
type PassRecord = Record<string, any>
|
|
1370
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1319
1371
|
|
|
1320
1372
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1321
|
-
type RenderPipelineSetupCallback = (state:
|
|
1373
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1322
1374
|
|
|
1323
1375
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1324
|
-
type RenderPipelineMainCallback = (state:
|
|
1376
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1325
1377
|
|
|
1326
|
-
/**
|
|
1327
|
-
interface
|
|
1378
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1379
|
+
interface UseRenderPipelineActions {
|
|
1328
1380
|
/** Current passes from state */
|
|
1329
1381
|
passes: PassRecord
|
|
1330
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1331
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1332
1382
|
/** Clear all passes from state */
|
|
1333
1383
|
clearPasses: () => void
|
|
1334
1384
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1335
1385
|
reset: () => void
|
|
1336
1386
|
/** Re-run setup/main callbacks with current closure values */
|
|
1337
1387
|
rebuild: () => void
|
|
1338
|
-
/** True when RenderPipeline is configured and ready */
|
|
1339
|
-
isReady: boolean
|
|
1340
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
|
+
)
|
|
1341
1412
|
}
|
|
1342
1413
|
|
|
1343
1414
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -1416,10 +1487,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1416
1487
|
|
|
1417
1488
|
/**
|
|
1418
1489
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1419
|
-
* 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.
|
|
1420
1492
|
*/
|
|
1421
1493
|
type NodeProps<P> = {
|
|
1422
|
-
[K in keyof P as P[K] extends
|
|
1494
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1423
1495
|
}
|
|
1424
1496
|
|
|
1425
1497
|
interface ReactProps<P> {
|
|
@@ -1440,11 +1512,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1440
1512
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1441
1513
|
}
|
|
1442
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
|
+
|
|
1443
1522
|
type ThreeExports = typeof import('three/webgpu')
|
|
1444
1523
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1445
1524
|
|
|
1446
1525
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1447
|
-
|
|
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
|
+
}
|
|
1448
1538
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1449
1539
|
threeAudio: ThreeElementsImpl['audio']
|
|
1450
1540
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1485,6 +1575,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1485
1575
|
type three_d_Matrix4 = Matrix4;
|
|
1486
1576
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1487
1577
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1578
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1488
1579
|
type three_d_Quaternion = Quaternion;
|
|
1489
1580
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1490
1581
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1499,7 +1590,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1499
1590
|
type three_d_Vector4 = Vector4;
|
|
1500
1591
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1501
1592
|
declare namespace three_d {
|
|
1502
|
-
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 };
|
|
1503
1594
|
}
|
|
1504
1595
|
|
|
1505
1596
|
/**
|
|
@@ -1848,7 +1939,43 @@ declare function createEvents(store: RootStore): {
|
|
|
1848
1939
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1849
1940
|
};
|
|
1850
1941
|
/** Default R3F event manager for web */
|
|
1851
|
-
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;
|
|
1852
1979
|
|
|
1853
1980
|
/**
|
|
1854
1981
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -1868,50 +1995,6 @@ declare namespace useLoader {
|
|
|
1868
1995
|
var loader: typeof getLoader;
|
|
1869
1996
|
}
|
|
1870
1997
|
|
|
1871
|
-
/**
|
|
1872
|
-
* Frame hook with phase-based ordering, priority, and FPS throttling.
|
|
1873
|
-
*
|
|
1874
|
-
* Always delivers full RootState — works both inside and outside Canvas context:
|
|
1875
|
-
* - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
|
|
1876
|
-
* - Outside Canvas: The job registers immediately but the callback is held until a
|
|
1877
|
-
* Canvas adopts it, then runs with full RootState. For hostless / standalone
|
|
1878
|
-
* frame loops with no Canvas, use `@pmndrs/scheduler` directly.
|
|
1879
|
-
*
|
|
1880
|
-
* Returns a controls object for manual stepping, pausing, and resuming.
|
|
1881
|
-
*
|
|
1882
|
-
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
1883
|
-
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
1884
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
1885
|
-
*
|
|
1886
|
-
* @example
|
|
1887
|
-
* // Simple priority (backwards compat)
|
|
1888
|
-
* useFrame((state, delta) => { ... }, 5)
|
|
1889
|
-
*
|
|
1890
|
-
* @example
|
|
1891
|
-
* // With phase-based ordering
|
|
1892
|
-
* useFrame((state, delta) => { ... }, { phase: 'physics' })
|
|
1893
|
-
*
|
|
1894
|
-
* @example
|
|
1895
|
-
* // Outside Canvas - callback waits for a Canvas, then always has full state
|
|
1896
|
-
* function UI() {
|
|
1897
|
-
* useFrame((state, delta) => { syncUI(state.camera) });
|
|
1898
|
-
* return <button>...</button>;
|
|
1899
|
-
* }
|
|
1900
|
-
*
|
|
1901
|
-
* @example
|
|
1902
|
-
* // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
|
|
1903
|
-
* import { getScheduler } from '@pmndrs/scheduler'
|
|
1904
|
-
* getScheduler().register((state, delta) => { updateGame(delta) })
|
|
1905
|
-
*
|
|
1906
|
-
* @example
|
|
1907
|
-
* // Scheduler-only access (no callback)
|
|
1908
|
-
* const { scheduler } = useFrame()
|
|
1909
|
-
* scheduler.pauseJob('some-job-id')
|
|
1910
|
-
*
|
|
1911
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
|
|
1912
|
-
*/
|
|
1913
|
-
declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
|
|
1914
|
-
|
|
1915
1998
|
declare const IsObject: (url: unknown) => url is Record<string, string>;
|
|
1916
1999
|
type TextureArray<T> = T extends string[] ? Texture$1[] : never;
|
|
1917
2000
|
type TextureRecord<T> = T extends Record<string, string> ? {
|
|
@@ -2092,16 +2175,6 @@ declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
|
|
|
2092
2175
|
declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
|
|
2093
2176
|
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
|
|
2094
2177
|
|
|
2095
|
-
/**
|
|
2096
|
-
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
2097
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2098
|
-
*/
|
|
2099
|
-
declare function useStore(): RootStore;
|
|
2100
|
-
/**
|
|
2101
|
-
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
2102
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
2103
|
-
*/
|
|
2104
|
-
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
2105
2178
|
/**
|
|
2106
2179
|
* Exposes an object's {@link Instance}.
|
|
2107
2180
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2177,7 +2250,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2177
2250
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2178
2251
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2179
2252
|
*
|
|
2180
|
-
*
|
|
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
|
|
2181
2257
|
* @param frames - Number of frames to request (default: 1)
|
|
2182
2258
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2183
2259
|
*
|
|
@@ -2188,14 +2264,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2188
2264
|
* Advances the frameloop and runs render effects.
|
|
2189
2265
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2190
2266
|
*
|
|
2267
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2268
|
+
* registered root is stepped for backwards compatibility.
|
|
2269
|
+
*
|
|
2191
2270
|
* @param timestamp - The timestamp to use for this frame
|
|
2192
2271
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2193
|
-
* @param state -
|
|
2194
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2272
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2195
2273
|
*
|
|
2196
2274
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2197
2275
|
*/
|
|
2198
|
-
declare function advance(timestamp: number): void;
|
|
2276
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2199
2277
|
|
|
2200
2278
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2201
2279
|
declare function ReactReconciler<
|
|
@@ -3240,6 +3318,7 @@ declare namespace ReactReconciler {
|
|
|
3240
3318
|
|
|
3241
3319
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3242
3320
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3321
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3243
3322
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3244
3323
|
|
|
3245
3324
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3264,6 +3343,7 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
|
|
|
3264
3343
|
declare function flushSync<R>(fn: () => R): R;
|
|
3265
3344
|
|
|
3266
3345
|
declare const context: React$1.Context<RootStore>;
|
|
3346
|
+
|
|
3267
3347
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3268
3348
|
|
|
3269
3349
|
/**
|
|
@@ -3517,7 +3597,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
|
|
|
3517
3597
|
declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
|
|
3518
3598
|
/**
|
|
3519
3599
|
* Triggers an update for an instance.
|
|
3520
|
-
*
|
|
3600
|
+
* Invalidates the frame if the root is in demand mode.
|
|
3521
3601
|
*
|
|
3522
3602
|
* @param instance - Instance to invalidate
|
|
3523
3603
|
*/
|
|
@@ -3683,29 +3763,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3683
3763
|
* Used to identify values that should be resolved from refs after mount.
|
|
3684
3764
|
*/
|
|
3685
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
|
+
}
|
|
3686
3772
|
/**
|
|
3687
3773
|
* Defers prop application until the referenced object is available.
|
|
3688
3774
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3689
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
|
+
*
|
|
3690
3781
|
* @param ref - React ref object to resolve at mount time
|
|
3691
|
-
* @
|
|
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
|
|
3692
3784
|
*
|
|
3693
3785
|
* @example
|
|
3694
3786
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3695
3787
|
*
|
|
3696
3788
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3697
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]))} />
|
|
3698
3794
|
*/
|
|
3699
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;
|
|
3700
3797
|
/**
|
|
3701
3798
|
* Type guard to check if a value is a fromRef marker.
|
|
3702
3799
|
*
|
|
3703
3800
|
* @param value - Value to check
|
|
3704
3801
|
* @returns True if value is a fromRef marker
|
|
3705
3802
|
*/
|
|
3706
|
-
declare function isFromRef(value: unknown): value is
|
|
3707
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3708
|
-
};
|
|
3803
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3709
3804
|
|
|
3710
3805
|
/**
|
|
3711
3806
|
* Symbol marker for mount-only method calls.
|
|
@@ -3732,7 +3827,15 @@ declare const ONCE: unique symbol;
|
|
|
3732
3827
|
* // No arguments
|
|
3733
3828
|
* <geometry center={once()} />
|
|
3734
3829
|
*/
|
|
3735
|
-
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;
|
|
3736
3839
|
/**
|
|
3737
3840
|
* Type guard to check if a value is a once marker.
|
|
3738
3841
|
*
|
|
@@ -3743,11 +3846,8 @@ declare function isOnce(value: unknown): value is {
|
|
|
3743
3846
|
[ONCE]: any[] | true;
|
|
3744
3847
|
};
|
|
3745
3848
|
|
|
3746
|
-
/**
|
|
3747
|
-
|
|
3748
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/canvas
|
|
3749
|
-
*/
|
|
3750
|
-
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;
|
|
3751
3851
|
|
|
3752
3852
|
/**
|
|
3753
3853
|
* ScopedStore - Type-safe wrapper for nested stores (uniforms, nodes)
|
|
@@ -3769,33 +3869,30 @@ declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
|
3769
3869
|
* ```
|
|
3770
3870
|
*/
|
|
3771
3871
|
|
|
3772
|
-
/** Keys reserved for methods (excluded from index signature) */
|
|
3773
|
-
type MethodKeys = 'scope' | 'has' | 'keys';
|
|
3774
3872
|
/**
|
|
3775
3873
|
* Type-safe wrapper interface for accessing nested store data.
|
|
3776
3874
|
* Property access returns `T` (assumes leaf node).
|
|
3777
3875
|
* Use `.scope(key)` for nested object access.
|
|
3778
3876
|
*
|
|
3779
|
-
* Uses mapped type with key filtering to exclude method names from index signature,
|
|
3780
|
-
* allowing methods to have their correct return types.
|
|
3781
3877
|
*/
|
|
3782
|
-
type
|
|
3783
|
-
/** Direct property access returns the leaf type T (method keys excluded) */
|
|
3784
|
-
readonly [K in string as K extends MethodKeys ? never : K]: T;
|
|
3785
|
-
} & {
|
|
3878
|
+
type ScopedStoreMethods<TLeaf> = {
|
|
3786
3879
|
/** Access a nested scope by key. Returns empty wrapper if scope doesn't exist. */
|
|
3787
|
-
scope(key: string): ScopedStoreType<
|
|
3880
|
+
scope<TScope extends Record<string, TLeaf> = Record<string, TLeaf>>(key: string): ScopedStoreType<TLeaf, TScope>;
|
|
3788
3881
|
/** Check if a key exists in the store */
|
|
3789
3882
|
has(key: string): boolean;
|
|
3790
3883
|
/** Get all keys in the store */
|
|
3791
3884
|
keys(): string[];
|
|
3792
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
|
+
}
|
|
3793
3890
|
/**
|
|
3794
3891
|
* Create a type-safe ScopedStore wrapper around store data.
|
|
3795
3892
|
* @param data - The raw store data (uniforms or nodes from RootState)
|
|
3796
3893
|
* @returns A ScopedStoreType wrapper with type-safe access
|
|
3797
3894
|
*/
|
|
3798
|
-
declare function createScopedStore<
|
|
3895
|
+
declare function createScopedStore<TLeaf>(data: ScopedStoreData<TLeaf>, isLeaf: ResourceLeafGuard<TLeaf>): ScopedStoreType<TLeaf>;
|
|
3799
3896
|
/**
|
|
3800
3897
|
* State type passed to creator functions with ScopedStore wrappers.
|
|
3801
3898
|
* Provides type-safe access to uniforms, nodes, buffers, and gpuStorage without manual casting.
|
|
@@ -3803,8 +3900,8 @@ declare function createScopedStore<T>(data: Record<string, any>): ScopedStoreTyp
|
|
|
3803
3900
|
type CreatorState = Omit<RootState, 'uniforms' | 'nodes' | 'buffers' | 'gpuStorage'> & {
|
|
3804
3901
|
/** Type-safe uniform access - property access returns UniformNode */
|
|
3805
3902
|
uniforms: ScopedStoreType<UniformNode>;
|
|
3806
|
-
/** Type-safe node access
|
|
3807
|
-
nodes: ScopedStoreType<
|
|
3903
|
+
/** Type-safe node access for real, callable, and legacy structural nodes */
|
|
3904
|
+
nodes: ScopedStoreType<NodeLike>;
|
|
3808
3905
|
/** Type-safe buffer access - property access returns BufferLike (TypedArrays, BufferAttributes, TSL nodes) */
|
|
3809
3906
|
buffers: ScopedStoreType<BufferLike>;
|
|
3810
3907
|
/** Type-safe GPU storage access - property access returns StorageLike (StorageTexture, TSL nodes) */
|
|
@@ -3820,17 +3917,18 @@ type ClearUniformsFn = (scope?: string) => void;
|
|
|
3820
3917
|
/** Function signature for rebuildUniforms util */
|
|
3821
3918
|
type RebuildUniformsFn = (scope?: string) => void;
|
|
3822
3919
|
/** Return type with utils included */
|
|
3823
|
-
type UniformsWithUtils<T extends UniformRecord = UniformRecord> = T & {
|
|
3920
|
+
type UniformsWithUtils<T extends UniformRecord | UniformStore = UniformRecord> = T & {
|
|
3824
3921
|
removeUniforms: RemoveUniformsFn;
|
|
3825
3922
|
clearUniforms: ClearUniformsFn;
|
|
3826
3923
|
rebuildUniforms: RebuildUniformsFn;
|
|
3827
3924
|
};
|
|
3828
|
-
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>;
|
|
3829
3930
|
declare function useUniforms(scope: string): UniformsWithUtils;
|
|
3830
|
-
declare function useUniforms<T extends UniformInputRecord>(
|
|
3831
|
-
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3832
|
-
declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3833
|
-
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>>;
|
|
3834
3932
|
/**
|
|
3835
3933
|
* Global rebuildUniforms function for HMR integration.
|
|
3836
3934
|
* Invalidates cached uniforms and increments _hmrVersion to trigger re-creation.
|
|
@@ -3861,47 +3959,28 @@ declare function clearRootUniforms(set: ReturnType<typeof useStore>['setState'])
|
|
|
3861
3959
|
|
|
3862
3960
|
/**
|
|
3863
3961
|
* Supported uniform value types:
|
|
3864
|
-
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix3, Matrix4
|
|
3962
|
+
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix2, Matrix3, Matrix4
|
|
3865
3963
|
* - String colors: '#ff0000', 'red', 'rgb(255,0,0)' (auto-converted to Color)
|
|
3866
3964
|
* - TSL nodes: color(), vec3(), float(), etc. (for type casting)
|
|
3867
3965
|
* - UniformNode: existing uniforms (reused as-is)
|
|
3868
3966
|
*/
|
|
3869
|
-
type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
|
|
3870
|
-
|
|
3871
|
-
|
|
3872
|
-
* - 0 → number
|
|
3873
|
-
* - true → boolean
|
|
3874
|
-
* - '#ff0000' → Color (string colors are converted to Color objects)
|
|
3875
|
-
* - Node → Node (TSL nodes passed through for uniform type casting)
|
|
3876
|
-
*/
|
|
3877
|
-
type Widen<T> = T extends number ? number : T extends boolean ? boolean : T extends string ? Color$2 : T;
|
|
3878
|
-
declare function useUniform<T extends UniformValue>(name: string): UniformNode<T>;
|
|
3879
|
-
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>;
|
|
3880
3970
|
|
|
3881
3971
|
/**
|
|
3882
|
-
*
|
|
3883
|
-
*
|
|
3884
|
-
*
|
|
3885
|
-
*
|
|
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.
|
|
3886
3976
|
*/
|
|
3887
|
-
|
|
3888
|
-
|
|
3889
|
-
|
|
3890
|
-
/** label method for chaining - sets the node's label and returns self */
|
|
3891
|
-
label?: ((label: string) => TSLNodeLike) | string;
|
|
3892
|
-
setName?: (name: string) => this;
|
|
3893
|
-
}
|
|
3894
|
-
/** TSL node type - alias for compatibility */
|
|
3977
|
+
type TSLNodeLike = NodeLike;
|
|
3978
|
+
|
|
3979
|
+
/** Backward-compatible alias covering every accepted node representation. */
|
|
3895
3980
|
type TSLNode = TSLNodeLike;
|
|
3896
|
-
/**
|
|
3897
|
-
* A record of TSL nodes - allows mixed node types (OperatorNode, ConstNode, etc.)
|
|
3898
|
-
* Uses TSLNodeLike for broader compatibility with Three.js's TSL type definitions.
|
|
3899
|
-
*/
|
|
3900
|
-
type NodeRecord<T extends TSLNodeLike = TSLNodeLike> = Record<string, T>;
|
|
3901
3981
|
/**
|
|
3902
3982
|
* Creator function that returns a record of nodes.
|
|
3903
|
-
*
|
|
3904
|
-
* (e.g., { n: OperatorNode; color: ConstNode<Color> }) to pass type checking.
|
|
3983
|
+
* Exact creator return inference is preserved within the compatible node constraint.
|
|
3905
3984
|
*/
|
|
3906
3985
|
type NodeCreator<T extends Record<string, TSLNodeLike>> = (state: CreatorState) => T;
|
|
3907
3986
|
/** Function signature for removeNodes util */
|
|
@@ -3911,15 +3990,17 @@ type ClearNodesFn = (scope?: string) => void;
|
|
|
3911
3990
|
/** Function signature for rebuildNodes util */
|
|
3912
3991
|
type RebuildNodesFn = (scope?: string) => void;
|
|
3913
3992
|
/** Return type with utils included */
|
|
3914
|
-
type NodesWithUtils<T extends Record<string,
|
|
3993
|
+
type NodesWithUtils<T extends Record<string, unknown> = NodeRecord> = T & {
|
|
3915
3994
|
removeNodes: RemoveNodesFn;
|
|
3916
3995
|
clearNodes: ClearNodesFn;
|
|
3917
3996
|
rebuildNodes: RebuildNodesFn;
|
|
3918
3997
|
};
|
|
3919
|
-
declare function useNodes(): NodesWithUtils<
|
|
3920
|
-
declare function useNodes(scope: string): NodesWithUtils<
|
|
3921
|
-
declare function useNodes<T extends
|
|
3922
|
-
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>>;
|
|
3923
4004
|
/**
|
|
3924
4005
|
* Global rebuildNodes function for HMR integration.
|
|
3925
4006
|
* Invalidates cached nodes and increments _hmrVersion to trigger re-creation.
|
|
@@ -3978,6 +4059,10 @@ type LocalNodeCreator<T extends Record<string, unknown>> = (state: CreatorState)
|
|
|
3978
4059
|
*/
|
|
3979
4060
|
declare function useLocalNodes<T extends Record<string, unknown>>(creator: LocalNodeCreator<T>): T;
|
|
3980
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>;
|
|
3981
4066
|
/**
|
|
3982
4067
|
* Creator function that returns a record of buffers.
|
|
3983
4068
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -3992,14 +4077,15 @@ type RebuildBuffersFn = (scope?: string) => void;
|
|
|
3992
4077
|
/** Function signature for disposeBuffers util - releases GPU resources */
|
|
3993
4078
|
type DisposeBuffersFn = (names: string | string[], scope?: string) => void;
|
|
3994
4079
|
/** Return type with utils included */
|
|
3995
|
-
type BuffersWithUtils<T extends
|
|
4080
|
+
type BuffersWithUtils<T extends BufferRecordType | BufferStore = BufferRecordType> = T & {
|
|
3996
4081
|
removeBuffers: RemoveBuffersFn;
|
|
3997
4082
|
clearBuffers: ClearBuffersFn;
|
|
3998
4083
|
rebuildBuffers: RebuildBuffersFn;
|
|
3999
4084
|
disposeBuffers: DisposeBuffersFn;
|
|
4000
4085
|
};
|
|
4001
|
-
declare function useBuffers(): BuffersWithUtils<
|
|
4086
|
+
declare function useBuffers(): BuffersWithUtils<BufferStore>;
|
|
4002
4087
|
declare function useBuffers(scope: string): BuffersWithUtils<Record<string, BufferLike>>;
|
|
4088
|
+
declare function useBuffers<T extends Record<string, BufferLike>>(scope?: string): BuffersWithUtils<T>;
|
|
4003
4089
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>): BuffersWithUtils<T>;
|
|
4004
4090
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>, scope: string): BuffersWithUtils<T>;
|
|
4005
4091
|
/**
|
|
@@ -4015,6 +4101,10 @@ declare function useBuffers<T extends Record<string, BufferLike>>(creator: Buffe
|
|
|
4015
4101
|
*/
|
|
4016
4102
|
declare function rebuildAllBuffers(store: ReturnType<typeof useStore>, scope?: string): void;
|
|
4017
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>;
|
|
4018
4108
|
/**
|
|
4019
4109
|
* Creator function that returns a record of GPU storage objects.
|
|
4020
4110
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -4029,14 +4119,15 @@ type RebuildStorageFn = (scope?: string) => void;
|
|
|
4029
4119
|
/** Function signature for disposeStorage util - releases GPU resources */
|
|
4030
4120
|
type DisposeStorageFn = (names: string | string[], scope?: string) => void;
|
|
4031
4121
|
/** Return type with utils included */
|
|
4032
|
-
type StorageWithUtils<T extends
|
|
4122
|
+
type StorageWithUtils<T extends StorageRecordType | StorageStore = StorageRecordType> = T & {
|
|
4033
4123
|
removeStorage: RemoveStorageFn;
|
|
4034
4124
|
clearStorage: ClearStorageFn;
|
|
4035
4125
|
rebuildStorage: RebuildStorageFn;
|
|
4036
4126
|
disposeStorage: DisposeStorageFn;
|
|
4037
4127
|
};
|
|
4038
|
-
declare function useGPUStorage(): StorageWithUtils<
|
|
4128
|
+
declare function useGPUStorage(): StorageWithUtils<StorageStore>;
|
|
4039
4129
|
declare function useGPUStorage(scope: string): StorageWithUtils<Record<string, StorageLike>>;
|
|
4130
|
+
declare function useGPUStorage<T extends Record<string, StorageLike>>(scope?: string): StorageWithUtils<T>;
|
|
4040
4131
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>): StorageWithUtils<T>;
|
|
4041
4132
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>, scope: string): StorageWithUtils<T>;
|
|
4042
4133
|
/**
|
|
@@ -4086,6 +4177,10 @@ declare function createTextureOperations(set: StoreApi<RootState>['setState']):
|
|
|
4086
4177
|
* - Callbacks receive full RootState for flexibility
|
|
4087
4178
|
* - No auto-cleanup on unmount - use reset() for explicit cleanup
|
|
4088
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
|
|
4089
4184
|
*
|
|
4090
4185
|
* @param mainCB - Main callback to configure outputNode and create effect passes
|
|
4091
4186
|
* @param setupCB - Optional setup callback to configure MRT on scenePass
|
|
@@ -4163,5 +4258,32 @@ interface WebGPURootState extends Omit<RootState, 'renderer' | 'gl' | 'internal'
|
|
|
4163
4258
|
internal: WebGPUInternalState
|
|
4164
4259
|
}
|
|
4165
4260
|
|
|
4166
|
-
|
|
4167
|
-
|
|
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 };
|