@react-three/fiber 10.0.0-canary.e881a4a → 10.0.0-canary.ea31ccd
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +2050 -1856
- package/dist/index.d.cts +310 -155
- package/dist/index.d.mts +310 -155
- package/dist/index.d.ts +308 -181
- package/dist/index.mjs +2052 -1858
- package/dist/legacy.cjs +2617 -2427
- package/dist/legacy.d.cts +313 -162
- package/dist/legacy.d.mts +313 -162
- package/dist/legacy.d.ts +311 -186
- package/dist/legacy.mjs +2619 -2429
- package/dist/webgpu/index.cjs +2161 -1942
- package/dist/webgpu/index.d.cts +390 -266
- package/dist/webgpu/index.d.mts +390 -266
- package/dist/webgpu/index.d.ts +388 -292
- package/dist/webgpu/index.mjs +2001 -1782
- package/package.json +4 -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
|
|
|
@@ -495,11 +492,28 @@ interface InternalState {
|
|
|
495
492
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
496
493
|
container?: THREE$1.Object3D
|
|
497
494
|
/**
|
|
498
|
-
* CanvasTarget
|
|
499
|
-
*
|
|
495
|
+
* The CanvasTarget this root sizes and renders through.
|
|
496
|
+
*
|
|
497
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
498
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
499
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
500
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
501
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
500
502
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
501
503
|
*/
|
|
502
504
|
canvasTarget?: CanvasTarget
|
|
505
|
+
/**
|
|
506
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
507
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
508
|
+
*
|
|
509
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
510
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
511
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
512
|
+
* invalidate some other canvas's descriptor instead.
|
|
513
|
+
*
|
|
514
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
515
|
+
*/
|
|
516
|
+
canvasTargetSizeDirty?: boolean
|
|
503
517
|
/**
|
|
504
518
|
* Whether multi-canvas rendering is active.
|
|
505
519
|
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
@@ -609,7 +623,7 @@ interface RootState {
|
|
|
609
623
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
610
624
|
uniforms: UniformStore
|
|
611
625
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
612
|
-
nodes:
|
|
626
|
+
nodes: NodeStore
|
|
613
627
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
614
628
|
buffers: BufferStore
|
|
615
629
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -621,7 +635,7 @@ interface RootState {
|
|
|
621
635
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
622
636
|
renderPipeline: ThreeRenderPipeline | null
|
|
623
637
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
624
|
-
passes:
|
|
638
|
+
passes: PassRecord
|
|
625
639
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
626
640
|
_hmrVersion: number
|
|
627
641
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -709,12 +723,19 @@ type DefaultRendererProps = {
|
|
|
709
723
|
*/
|
|
710
724
|
interface CanvasSchedulerConfig {
|
|
711
725
|
/**
|
|
712
|
-
*
|
|
713
|
-
|
|
726
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
727
|
+
*/
|
|
728
|
+
before?: string | string[]
|
|
729
|
+
/**
|
|
730
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
714
731
|
*/
|
|
715
|
-
after?: string
|
|
732
|
+
after?: string | string[]
|
|
716
733
|
/**
|
|
717
|
-
*
|
|
734
|
+
* Numeric root order. Lower values run first.
|
|
735
|
+
*/
|
|
736
|
+
order?: number
|
|
737
|
+
/**
|
|
738
|
+
* Limit this Canvas's default render job (frames per second).
|
|
718
739
|
*/
|
|
719
740
|
fps?: number
|
|
720
741
|
}
|
|
@@ -801,14 +822,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
801
822
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
802
823
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
803
824
|
dpr?: Dpr
|
|
804
|
-
/**
|
|
805
|
-
|
|
825
|
+
/**
|
|
826
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
827
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
828
|
+
*/
|
|
829
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
806
830
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
807
831
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
808
832
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
809
833
|
camera?: CameraProps
|
|
810
834
|
/** An R3F event manager to manage elements' pointer events */
|
|
811
|
-
events?: (store: RootStore) => EventManager<
|
|
835
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
812
836
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
813
837
|
onCreated?: (state: RootState) => void
|
|
814
838
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -897,7 +921,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
|
|
|
897
921
|
object?: T
|
|
898
922
|
dispose?: null
|
|
899
923
|
attach?: AttachType<T>
|
|
900
|
-
onUpdate?: (self: T) => void
|
|
901
924
|
}
|
|
902
925
|
|
|
903
926
|
interface Instance<O = any> {
|
|
@@ -1037,7 +1060,7 @@ interface CanvasProps
|
|
|
1037
1060
|
*/
|
|
1038
1061
|
resize?: Options
|
|
1039
1062
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1040
|
-
eventSource?:
|
|
1063
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1041
1064
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1042
1065
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1043
1066
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1145,81 +1168,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1145
1168
|
|
|
1146
1169
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1147
1170
|
|
|
1148
|
-
//* Global Types ==============================
|
|
1171
|
+
//* Global TSL Types ==============================
|
|
1149
1172
|
|
|
1150
1173
|
declare global {
|
|
1151
1174
|
/**
|
|
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.
|
|
1175
|
+
* Broad callable-node fallback for dynamic store readers.
|
|
1176
|
+
* Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
|
|
1164
1177
|
*/
|
|
1165
|
-
type
|
|
1178
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1179
|
+
readonly shaderNode: unknown
|
|
1180
|
+
readonly id: number
|
|
1181
|
+
}
|
|
1166
1182
|
|
|
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
|
|
1183
|
+
/** Legacy structural node accepted when at least one historical marker exists. */
|
|
1184
|
+
type LegacyTSLNodeLike = {
|
|
1185
|
+
label?: ((label: string) => unknown) | string
|
|
1186
|
+
setName?: (name: string) => unknown
|
|
1187
|
+
} & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
|
|
1187
1188
|
|
|
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>
|
|
1189
|
+
/** Node type accepted by broad dynamic node-store readers. */
|
|
1190
|
+
type TSLNodeType = three_webgpu.Node | CallableTSLNode
|
|
1198
1191
|
|
|
1199
1192
|
/**
|
|
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
|
-
* ```
|
|
1193
|
+
* Derive Three's shader node type from an existing node or a supported raw input.
|
|
1194
|
+
* Existing InputNode generics take precedence over structural value normalization.
|
|
1195
|
+
* Both generics must be inferred because Three's UniformNode intersects an unknown-typed
|
|
1196
|
+
* InputNode base with its concrete InputNode specialization.
|
|
1221
1197
|
*/
|
|
1222
|
-
type
|
|
1198
|
+
type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
|
|
1199
|
+
? TNodeType
|
|
1200
|
+
: T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
|
|
1201
|
+
? TNodeType
|
|
1202
|
+
: T extends number
|
|
1203
|
+
? 'float'
|
|
1204
|
+
: T extends boolean
|
|
1205
|
+
? 'bool'
|
|
1206
|
+
: T extends string | three_webgpu.Color | { r: number; g: number; b: number }
|
|
1207
|
+
? 'color'
|
|
1208
|
+
: T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
|
|
1209
|
+
? 'vec4'
|
|
1210
|
+
: T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
|
|
1211
|
+
? 'vec3'
|
|
1212
|
+
: T extends three_webgpu.Vector2 | { x: number; y: number }
|
|
1213
|
+
? 'vec2'
|
|
1214
|
+
: T extends three_webgpu.Matrix4
|
|
1215
|
+
? 'mat4'
|
|
1216
|
+
: T extends three_webgpu.Matrix3
|
|
1217
|
+
? 'mat3'
|
|
1218
|
+
: T extends three_webgpu.Matrix2
|
|
1219
|
+
? 'mat2'
|
|
1220
|
+
: unknown
|
|
1221
|
+
|
|
1222
|
+
/** Derive the normalized JavaScript value stored by a uniform node. */
|
|
1223
|
+
type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
|
|
1224
|
+
? TValue
|
|
1225
|
+
: T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
|
|
1226
|
+
? TValue
|
|
1227
|
+
: T extends string | { r: number; g: number; b: number }
|
|
1228
|
+
? three_webgpu.Color
|
|
1229
|
+
: T extends { x: number; y: number; z: number; w: number }
|
|
1230
|
+
? three_webgpu.Vector4
|
|
1231
|
+
: T extends { x: number; y: number; z: number }
|
|
1232
|
+
? three_webgpu.Vector3
|
|
1233
|
+
: T extends { x: number; y: number }
|
|
1234
|
+
? three_webgpu.Vector2
|
|
1235
|
+
: T extends number
|
|
1236
|
+
? number
|
|
1237
|
+
: T extends boolean
|
|
1238
|
+
? boolean
|
|
1239
|
+
: T
|
|
1240
|
+
|
|
1241
|
+
/** Three's exact UniformNode with shader and value generics derived from an input. */
|
|
1242
|
+
type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
|
|
1243
|
+
|
|
1244
|
+
/** Preserve every input key while mapping values to exact Three uniform nodes. */
|
|
1245
|
+
type UniformNodesFor<T extends UniformInputRecord> = {
|
|
1246
|
+
[K in keyof T]: UniformNodeFor<T[K]>
|
|
1247
|
+
}
|
|
1248
|
+
|
|
1249
|
+
/** Backward-compatible single-parameter uniform alias. */
|
|
1250
|
+
type UniformNode<T = unknown> = UniformNodeFor<T>
|
|
1223
1251
|
|
|
1224
1252
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1225
1253
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1244,7 +1272,7 @@ declare global {
|
|
|
1244
1272
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1245
1273
|
* Supports:
|
|
1246
1274
|
* - Primitives: number, string (color), boolean
|
|
1247
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1275
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1248
1276
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1249
1277
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1250
1278
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1257,88 +1285,124 @@ declare global {
|
|
|
1257
1285
|
| three_webgpu.Vector2
|
|
1258
1286
|
| three_webgpu.Vector3
|
|
1259
1287
|
| three_webgpu.Vector4
|
|
1288
|
+
| three_webgpu.Matrix2
|
|
1260
1289
|
| three_webgpu.Matrix3
|
|
1261
1290
|
| three_webgpu.Matrix4
|
|
1262
|
-
|
|
|
1263
|
-
|
|
|
1264
|
-
| { x: number; y
|
|
1291
|
+
| { x: number; y: number }
|
|
1292
|
+
| { x: number; y: number; z: number }
|
|
1293
|
+
| { x: number; y: number; z: number; w: number }
|
|
1265
1294
|
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1266
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1295
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1267
1296
|
| UniformNode
|
|
1268
1297
|
|
|
1269
1298
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1270
1299
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1271
1300
|
}
|
|
1272
1301
|
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
declare module 'three/tsl' {
|
|
1302
|
+
declare global {
|
|
1276
1303
|
/**
|
|
1277
|
-
*
|
|
1278
|
-
*
|
|
1304
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1305
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1306
|
+
* is r185, so the new name is the only one.
|
|
1279
1307
|
*/
|
|
1280
|
-
|
|
1281
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1282
|
-
): ShaderCallable<R>
|
|
1308
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1283
1309
|
|
|
1284
1310
|
/**
|
|
1285
|
-
*
|
|
1286
|
-
*
|
|
1311
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1312
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1313
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1287
1314
|
*/
|
|
1288
|
-
|
|
1289
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1290
|
-
): ShaderCallable<R>
|
|
1315
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1291
1316
|
|
|
1292
1317
|
/**
|
|
1293
|
-
*
|
|
1294
|
-
*
|
|
1318
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1319
|
+
*
|
|
1320
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1321
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1322
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1323
|
+
* {@link RenderPipelineCallbackState}.
|
|
1324
|
+
*
|
|
1325
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1326
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1327
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1328
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1329
|
+
*
|
|
1330
|
+
* The index signature admits `undefined` because a key may simply not be registered, and
|
|
1331
|
+
* because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
|
|
1332
|
+
* optional property whose type excludes `undefined` from the index signature is an error
|
|
1333
|
+
* (TS2411) for every consumer compiling these declarations.
|
|
1295
1334
|
*/
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1335
|
+
interface PassRecord {
|
|
1336
|
+
scenePass?: ScenePassNode
|
|
1337
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1338
|
+
}
|
|
1300
1339
|
|
|
1301
1340
|
/**
|
|
1302
|
-
*
|
|
1341
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1342
|
+
*
|
|
1343
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1344
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1345
|
+
*
|
|
1346
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1347
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1303
1348
|
*/
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1349
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1350
|
+
renderPipeline: ThreeRenderPipeline
|
|
1351
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1352
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1353
|
+
isLegacy: false
|
|
1354
|
+
}
|
|
1309
1355
|
|
|
1310
|
-
declare global {
|
|
1311
1356
|
/**
|
|
1312
|
-
*
|
|
1313
|
-
*
|
|
1314
|
-
* is
|
|
1357
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1358
|
+
*
|
|
1359
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1360
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1361
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1362
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1315
1363
|
*/
|
|
1316
|
-
type
|
|
1317
|
-
|
|
1318
|
-
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1319
|
-
type PassRecord = Record<string, any>
|
|
1364
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1320
1365
|
|
|
1321
1366
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1322
|
-
type RenderPipelineSetupCallback = (state:
|
|
1367
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1323
1368
|
|
|
1324
1369
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1325
|
-
type RenderPipelineMainCallback = (state:
|
|
1370
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1326
1371
|
|
|
1327
|
-
/**
|
|
1328
|
-
interface
|
|
1372
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1373
|
+
interface UseRenderPipelineActions {
|
|
1329
1374
|
/** Current passes from state */
|
|
1330
1375
|
passes: PassRecord
|
|
1331
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1332
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1333
1376
|
/** Clear all passes from state */
|
|
1334
1377
|
clearPasses: () => void
|
|
1335
1378
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1336
1379
|
reset: () => void
|
|
1337
1380
|
/** Re-run setup/main callbacks with current closure values */
|
|
1338
1381
|
rebuild: () => void
|
|
1339
|
-
/** True when RenderPipeline is configured and ready */
|
|
1340
|
-
isReady: boolean
|
|
1341
1382
|
}
|
|
1383
|
+
|
|
1384
|
+
/**
|
|
1385
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1386
|
+
*
|
|
1387
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1388
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1389
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1390
|
+
*/
|
|
1391
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1392
|
+
(
|
|
1393
|
+
| {
|
|
1394
|
+
/** True when RenderPipeline is configured and ready */
|
|
1395
|
+
isReady: true
|
|
1396
|
+
/** RenderPipeline instance */
|
|
1397
|
+
renderPipeline: ThreeRenderPipeline
|
|
1398
|
+
}
|
|
1399
|
+
| {
|
|
1400
|
+
/** False until the pipeline has been created */
|
|
1401
|
+
isReady: false
|
|
1402
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1403
|
+
renderPipeline: null
|
|
1404
|
+
}
|
|
1405
|
+
)
|
|
1342
1406
|
}
|
|
1343
1407
|
|
|
1344
1408
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -1417,10 +1481,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1417
1481
|
|
|
1418
1482
|
/**
|
|
1419
1483
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1420
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1484
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1485
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1421
1486
|
*/
|
|
1422
1487
|
type NodeProps<P> = {
|
|
1423
|
-
[K in keyof P as P[K] extends
|
|
1488
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1424
1489
|
}
|
|
1425
1490
|
|
|
1426
1491
|
interface ReactProps<P> {
|
|
@@ -1441,11 +1506,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1441
1506
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1442
1507
|
}
|
|
1443
1508
|
|
|
1509
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1510
|
+
type Object3DMethod = NonNullable<
|
|
1511
|
+
{
|
|
1512
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1513
|
+
}[keyof Object3D]
|
|
1514
|
+
>
|
|
1515
|
+
|
|
1444
1516
|
type ThreeExports = typeof import('three/webgpu')
|
|
1445
1517
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1446
1518
|
|
|
1447
1519
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1448
|
-
|
|
1520
|
+
/**
|
|
1521
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1522
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1523
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1524
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1525
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1526
|
+
*/
|
|
1527
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
|
|
1528
|
+
object: object
|
|
1529
|
+
ref?: React.Ref<any>
|
|
1530
|
+
[prop: string]: unknown
|
|
1531
|
+
}
|
|
1449
1532
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1450
1533
|
threeAudio: ThreeElementsImpl['audio']
|
|
1451
1534
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1486,6 +1569,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1486
1569
|
type three_d_Matrix4 = Matrix4;
|
|
1487
1570
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1488
1571
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1572
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1489
1573
|
type three_d_Quaternion = Quaternion;
|
|
1490
1574
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1491
1575
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1500,7 +1584,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1500
1584
|
type three_d_Vector4 = Vector4;
|
|
1501
1585
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1502
1586
|
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 };
|
|
1587
|
+
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
1588
|
}
|
|
1505
1589
|
|
|
1506
1590
|
/**
|
|
@@ -1638,9 +1722,9 @@ type EnvironmentProps = {
|
|
|
1638
1722
|
blur?: number;
|
|
1639
1723
|
backgroundBlurriness?: number;
|
|
1640
1724
|
backgroundIntensity?: number;
|
|
1641
|
-
backgroundRotation?: Euler
|
|
1725
|
+
backgroundRotation?: Euler;
|
|
1642
1726
|
environmentIntensity?: number;
|
|
1643
|
-
environmentRotation?: Euler
|
|
1727
|
+
environmentRotation?: Euler;
|
|
1644
1728
|
map?: Texture$1;
|
|
1645
1729
|
preset?: PresetsType;
|
|
1646
1730
|
scene?: Scene | React$1.RefObject<Scene>;
|
|
@@ -1724,7 +1808,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
|
|
|
1724
1808
|
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
1809
|
declare module '@react-three/fiber' {
|
|
1726
1810
|
interface ThreeElements {
|
|
1727
|
-
groundProjectedEnvImpl: ThreeElement
|
|
1811
|
+
groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
|
|
1728
1812
|
}
|
|
1729
1813
|
}
|
|
1730
1814
|
/**
|
|
@@ -1824,6 +1908,24 @@ declare module '@react-three/fiber' {
|
|
|
1824
1908
|
*/
|
|
1825
1909
|
declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
1826
1910
|
|
|
1911
|
+
/**
|
|
1912
|
+
* Moves every trace of interactivity from one object to its replacement, for reconstruction.
|
|
1913
|
+
*
|
|
1914
|
+
* When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
|
|
1915
|
+
* instance. Removing the old object from the interaction state and registering the new one from
|
|
1916
|
+
* scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
|
|
1917
|
+
* the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
|
|
1918
|
+
* is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
|
|
1919
|
+
* swap the user never asked to see (#3744).
|
|
1920
|
+
*
|
|
1921
|
+
* Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
|
|
1922
|
+
* left alone — releasing and re-acquiring it is precisely the glitch being avoided.
|
|
1923
|
+
*
|
|
1924
|
+
* Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
|
|
1925
|
+
* the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
|
|
1926
|
+
* cannot outlive the object it described.
|
|
1927
|
+
*/
|
|
1928
|
+
declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
|
|
1827
1929
|
declare function removeInteractivity(store: RootStore, object: Object3D): void;
|
|
1828
1930
|
declare function createEvents(store: RootStore): {
|
|
1829
1931
|
handlePointer: (name: string) => (event: DomEvent) => void;
|
|
@@ -1831,7 +1933,7 @@ declare function createEvents(store: RootStore): {
|
|
|
1831
1933
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1832
1934
|
};
|
|
1833
1935
|
/** Default R3F event manager for web */
|
|
1834
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1936
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1835
1937
|
|
|
1836
1938
|
/**
|
|
1837
1939
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -1851,50 +1953,6 @@ declare namespace useLoader {
|
|
|
1851
1953
|
var loader: typeof getLoader;
|
|
1852
1954
|
}
|
|
1853
1955
|
|
|
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
1956
|
declare const IsObject: (url: unknown) => url is Record<string, string>;
|
|
1899
1957
|
type TextureArray<T> = T extends string[] ? Texture$1[] : never;
|
|
1900
1958
|
type TextureRecord<T> = T extends Record<string, string> ? {
|
|
@@ -2080,11 +2138,6 @@ declare function useRenderTarget(width: number, height: number, options?: Render
|
|
|
2080
2138
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2081
2139
|
*/
|
|
2082
2140
|
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
2141
|
/**
|
|
2089
2142
|
* Exposes an object's {@link Instance}.
|
|
2090
2143
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2160,7 +2213,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2160
2213
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2161
2214
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2162
2215
|
*
|
|
2163
|
-
*
|
|
2216
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
2217
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
2218
|
+
*
|
|
2219
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2164
2220
|
* @param frames - Number of frames to request (default: 1)
|
|
2165
2221
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2166
2222
|
*
|
|
@@ -2171,14 +2227,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2171
2227
|
* Advances the frameloop and runs render effects.
|
|
2172
2228
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2173
2229
|
*
|
|
2230
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2231
|
+
* registered root is stepped for backwards compatibility.
|
|
2232
|
+
*
|
|
2174
2233
|
* @param timestamp - The timestamp to use for this frame
|
|
2175
2234
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2176
|
-
* @param state -
|
|
2177
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2235
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2178
2236
|
*
|
|
2179
2237
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2180
2238
|
*/
|
|
2181
|
-
declare function advance(timestamp: number): void;
|
|
2239
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2182
2240
|
|
|
2183
2241
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2184
2242
|
declare function ReactReconciler<
|
|
@@ -3223,6 +3281,7 @@ declare namespace ReactReconciler {
|
|
|
3223
3281
|
|
|
3224
3282
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3225
3283
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3284
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3226
3285
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3227
3286
|
|
|
3228
3287
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3249,11 +3308,6 @@ declare function flushSync<R>(fn: () => R): R;
|
|
|
3249
3308
|
declare const context: React$1.Context<RootStore>;
|
|
3250
3309
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3251
3310
|
|
|
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
3311
|
/**
|
|
3258
3312
|
* An SSR-friendly useLayoutEffect.
|
|
3259
3313
|
*
|
|
@@ -3505,7 +3559,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
|
|
|
3505
3559
|
declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
|
|
3506
3560
|
/**
|
|
3507
3561
|
* Triggers an update for an instance.
|
|
3508
|
-
*
|
|
3562
|
+
* Invalidates the frame if the root is in demand mode.
|
|
3509
3563
|
*
|
|
3510
3564
|
* @param instance - Instance to invalidate
|
|
3511
3565
|
*/
|
|
@@ -3671,29 +3725,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3671
3725
|
* Used to identify values that should be resolved from refs after mount.
|
|
3672
3726
|
*/
|
|
3673
3727
|
declare const FROM_REF: unique symbol;
|
|
3728
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3729
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3730
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3731
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3732
|
+
transform?: (value: T) => R;
|
|
3733
|
+
}
|
|
3674
3734
|
/**
|
|
3675
3735
|
* Defers prop application until the referenced object is available.
|
|
3676
3736
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3677
3737
|
*
|
|
3738
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3739
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3740
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3741
|
+
* what gets assigned.
|
|
3742
|
+
*
|
|
3678
3743
|
* @param ref - React ref object to resolve at mount time
|
|
3679
|
-
* @
|
|
3744
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3745
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
3680
3746
|
*
|
|
3681
3747
|
* @example
|
|
3682
3748
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3683
3749
|
*
|
|
3684
3750
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3685
3751
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3752
|
+
*
|
|
3753
|
+
* @example
|
|
3754
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3755
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
3686
3756
|
*/
|
|
3687
3757
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3758
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
3688
3759
|
/**
|
|
3689
3760
|
* Type guard to check if a value is a fromRef marker.
|
|
3690
3761
|
*
|
|
3691
3762
|
* @param value - Value to check
|
|
3692
3763
|
* @returns True if value is a fromRef marker
|
|
3693
3764
|
*/
|
|
3694
|
-
declare function isFromRef(value: unknown): value is
|
|
3695
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3696
|
-
};
|
|
3765
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3697
3766
|
|
|
3698
3767
|
/**
|
|
3699
3768
|
* Symbol marker for mount-only method calls.
|
|
@@ -3720,7 +3789,15 @@ declare const ONCE: unique symbol;
|
|
|
3720
3789
|
* // No arguments
|
|
3721
3790
|
* <geometry center={once()} />
|
|
3722
3791
|
*/
|
|
3723
|
-
declare function once<
|
|
3792
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3793
|
+
/**
|
|
3794
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3795
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3796
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3797
|
+
*
|
|
3798
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3799
|
+
*/
|
|
3800
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
3724
3801
|
/**
|
|
3725
3802
|
* Type guard to check if a value is a once marker.
|
|
3726
3803
|
*
|
|
@@ -3731,11 +3808,8 @@ declare function isOnce(value: unknown): value is {
|
|
|
3731
3808
|
[ONCE]: any[] | true;
|
|
3732
3809
|
};
|
|
3733
3810
|
|
|
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;
|
|
3811
|
+
/** Distinguishes a resource leaf from a nested resource scope. */
|
|
3812
|
+
type ResourceLeafGuard<T> = (value: unknown) => value is T;
|
|
3739
3813
|
|
|
3740
3814
|
/**
|
|
3741
3815
|
* ScopedStore - Type-safe wrapper for nested stores (uniforms, nodes)
|
|
@@ -3757,33 +3831,30 @@ declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
|
3757
3831
|
* ```
|
|
3758
3832
|
*/
|
|
3759
3833
|
|
|
3760
|
-
/** Keys reserved for methods (excluded from index signature) */
|
|
3761
|
-
type MethodKeys = 'scope' | 'has' | 'keys';
|
|
3762
3834
|
/**
|
|
3763
3835
|
* Type-safe wrapper interface for accessing nested store data.
|
|
3764
3836
|
* Property access returns `T` (assumes leaf node).
|
|
3765
3837
|
* Use `.scope(key)` for nested object access.
|
|
3766
3838
|
*
|
|
3767
|
-
* Uses mapped type with key filtering to exclude method names from index signature,
|
|
3768
|
-
* allowing methods to have their correct return types.
|
|
3769
3839
|
*/
|
|
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
|
-
} & {
|
|
3840
|
+
type ScopedStoreMethods<TLeaf> = {
|
|
3774
3841
|
/** Access a nested scope by key. Returns empty wrapper if scope doesn't exist. */
|
|
3775
|
-
scope(key: string): ScopedStoreType<
|
|
3842
|
+
scope<TScope extends Record<string, TLeaf> = Record<string, TLeaf>>(key: string): ScopedStoreType<TLeaf, TScope>;
|
|
3776
3843
|
/** Check if a key exists in the store */
|
|
3777
3844
|
has(key: string): boolean;
|
|
3778
3845
|
/** Get all keys in the store */
|
|
3779
3846
|
keys(): string[];
|
|
3780
3847
|
};
|
|
3848
|
+
type ScopedStoreType<TLeaf, TEntries extends Record<string, TLeaf> = Record<string, TLeaf>> = Readonly<TEntries> & ScopedStoreMethods<TLeaf>;
|
|
3849
|
+
interface ScopedStoreData<TLeaf> {
|
|
3850
|
+
[key: string]: TLeaf | ScopedStoreData<TLeaf>;
|
|
3851
|
+
}
|
|
3781
3852
|
/**
|
|
3782
3853
|
* Create a type-safe ScopedStore wrapper around store data.
|
|
3783
3854
|
* @param data - The raw store data (uniforms or nodes from RootState)
|
|
3784
3855
|
* @returns A ScopedStoreType wrapper with type-safe access
|
|
3785
3856
|
*/
|
|
3786
|
-
declare function createScopedStore<
|
|
3857
|
+
declare function createScopedStore<TLeaf>(data: ScopedStoreData<TLeaf>, isLeaf: ResourceLeafGuard<TLeaf>): ScopedStoreType<TLeaf>;
|
|
3787
3858
|
/**
|
|
3788
3859
|
* State type passed to creator functions with ScopedStore wrappers.
|
|
3789
3860
|
* Provides type-safe access to uniforms, nodes, buffers, and gpuStorage without manual casting.
|
|
@@ -3791,8 +3862,8 @@ declare function createScopedStore<T>(data: Record<string, any>): ScopedStoreTyp
|
|
|
3791
3862
|
type CreatorState = Omit<RootState, 'uniforms' | 'nodes' | 'buffers' | 'gpuStorage'> & {
|
|
3792
3863
|
/** Type-safe uniform access - property access returns UniformNode */
|
|
3793
3864
|
uniforms: ScopedStoreType<UniformNode>;
|
|
3794
|
-
/** Type-safe node access
|
|
3795
|
-
nodes: ScopedStoreType<
|
|
3865
|
+
/** Type-safe node access for real, callable, and legacy structural nodes */
|
|
3866
|
+
nodes: ScopedStoreType<NodeLike>;
|
|
3796
3867
|
/** Type-safe buffer access - property access returns BufferLike (TypedArrays, BufferAttributes, TSL nodes) */
|
|
3797
3868
|
buffers: ScopedStoreType<BufferLike>;
|
|
3798
3869
|
/** Type-safe GPU storage access - property access returns StorageLike (StorageTexture, TSL nodes) */
|
|
@@ -3808,17 +3879,18 @@ type ClearUniformsFn = (scope?: string) => void;
|
|
|
3808
3879
|
/** Function signature for rebuildUniforms util */
|
|
3809
3880
|
type RebuildUniformsFn = (scope?: string) => void;
|
|
3810
3881
|
/** Return type with utils included */
|
|
3811
|
-
type UniformsWithUtils<T extends UniformRecord = UniformRecord> = T & {
|
|
3882
|
+
type UniformsWithUtils<T extends UniformRecord | UniformStore = UniformRecord> = T & {
|
|
3812
3883
|
removeUniforms: RemoveUniformsFn;
|
|
3813
3884
|
clearUniforms: ClearUniformsFn;
|
|
3814
3885
|
rebuildUniforms: RebuildUniformsFn;
|
|
3815
3886
|
};
|
|
3816
|
-
declare function useUniforms(): UniformsWithUtils<
|
|
3887
|
+
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3888
|
+
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3889
|
+
declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3890
|
+
declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3891
|
+
declare function useUniforms(): UniformsWithUtils<UniformStore>;
|
|
3817
3892
|
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>>;
|
|
3893
|
+
declare function useUniforms<T extends UniformInputRecord>(scope?: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3822
3894
|
/**
|
|
3823
3895
|
* Global rebuildUniforms function for HMR integration.
|
|
3824
3896
|
* Invalidates cached uniforms and increments _hmrVersion to trigger re-creation.
|
|
@@ -3849,47 +3921,28 @@ declare function clearRootUniforms(set: ReturnType<typeof useStore>['setState'])
|
|
|
3849
3921
|
|
|
3850
3922
|
/**
|
|
3851
3923
|
* Supported uniform value types:
|
|
3852
|
-
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix3, Matrix4
|
|
3924
|
+
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix2, Matrix3, Matrix4
|
|
3853
3925
|
* - String colors: '#ff0000', 'red', 'rgb(255,0,0)' (auto-converted to Color)
|
|
3854
3926
|
* - TSL nodes: color(), vec3(), float(), etc. (for type casting)
|
|
3855
3927
|
* - UniformNode: existing uniforms (reused as-is)
|
|
3856
3928
|
*/
|
|
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>>;
|
|
3929
|
+
type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
|
|
3930
|
+
declare function useUniform<T extends UniformValue = UniformValue>(name: string): UniformNodeFor<T>;
|
|
3931
|
+
declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNodeFor<T>;
|
|
3868
3932
|
|
|
3869
3933
|
/**
|
|
3870
|
-
*
|
|
3871
|
-
*
|
|
3872
|
-
*
|
|
3873
|
-
*
|
|
3934
|
+
* Every node representation a creator may return. The definition lives with the store types as
|
|
3935
|
+
* `NodeLike`, so the shape creators return and the shape `state.nodes` holds are one type by
|
|
3936
|
+
* construction: three's real `Node`, the callable proxy `Fn()` returns, or the legacy structural
|
|
3937
|
+
* `{ uuid, nodeType }` shape.
|
|
3874
3938
|
*/
|
|
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 */
|
|
3939
|
+
type TSLNodeLike = NodeLike;
|
|
3940
|
+
|
|
3941
|
+
/** Backward-compatible alias covering every accepted node representation. */
|
|
3883
3942
|
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
3943
|
/**
|
|
3890
3944
|
* Creator function that returns a record of nodes.
|
|
3891
|
-
*
|
|
3892
|
-
* (e.g., { n: OperatorNode; color: ConstNode<Color> }) to pass type checking.
|
|
3945
|
+
* Exact creator return inference is preserved within the compatible node constraint.
|
|
3893
3946
|
*/
|
|
3894
3947
|
type NodeCreator<T extends Record<string, TSLNodeLike>> = (state: CreatorState) => T;
|
|
3895
3948
|
/** Function signature for removeNodes util */
|
|
@@ -3899,15 +3952,17 @@ type ClearNodesFn = (scope?: string) => void;
|
|
|
3899
3952
|
/** Function signature for rebuildNodes util */
|
|
3900
3953
|
type RebuildNodesFn = (scope?: string) => void;
|
|
3901
3954
|
/** Return type with utils included */
|
|
3902
|
-
type NodesWithUtils<T extends Record<string,
|
|
3955
|
+
type NodesWithUtils<T extends Record<string, unknown> = NodeRecord> = T & {
|
|
3903
3956
|
removeNodes: RemoveNodesFn;
|
|
3904
3957
|
clearNodes: ClearNodesFn;
|
|
3905
3958
|
rebuildNodes: RebuildNodesFn;
|
|
3906
3959
|
};
|
|
3907
|
-
declare function useNodes(): NodesWithUtils<
|
|
3908
|
-
declare function useNodes(scope: string): NodesWithUtils<
|
|
3909
|
-
declare function useNodes<T extends
|
|
3910
|
-
declare function useNodes<T extends
|
|
3960
|
+
declare function useNodes(): NodesWithUtils<NodeStore>;
|
|
3961
|
+
declare function useNodes(scope: string): NodesWithUtils<NodeRecord>;
|
|
3962
|
+
declare function useNodes<T extends NodeRecord>(scope?: string): NodesWithUtils<T>;
|
|
3963
|
+
declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>): NodesWithUtils<T>;
|
|
3964
|
+
declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>, scope: string): NodesWithUtils<T>;
|
|
3965
|
+
declare function useNodes(creatorOrScope?: NodeCreator<NodeRecord> | string, scope?: string): NodesWithUtils<Record<string, unknown>>;
|
|
3911
3966
|
/**
|
|
3912
3967
|
* Global rebuildNodes function for HMR integration.
|
|
3913
3968
|
* Invalidates cached nodes and increments _hmrVersion to trigger re-creation.
|
|
@@ -3966,6 +4021,10 @@ type LocalNodeCreator<T extends Record<string, unknown>> = (state: CreatorState)
|
|
|
3966
4021
|
*/
|
|
3967
4022
|
declare function useLocalNodes<T extends Record<string, unknown>>(creator: LocalNodeCreator<T>): T;
|
|
3968
4023
|
|
|
4024
|
+
/**
|
|
4025
|
+
* A record of buffer-like values - allows mixed types (TypedArrays, BufferAttributes, TSL nodes)
|
|
4026
|
+
*/
|
|
4027
|
+
type BufferRecordType<T extends BufferLike = BufferLike> = Record<string, T>;
|
|
3969
4028
|
/**
|
|
3970
4029
|
* Creator function that returns a record of buffers.
|
|
3971
4030
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -3980,14 +4039,15 @@ type RebuildBuffersFn = (scope?: string) => void;
|
|
|
3980
4039
|
/** Function signature for disposeBuffers util - releases GPU resources */
|
|
3981
4040
|
type DisposeBuffersFn = (names: string | string[], scope?: string) => void;
|
|
3982
4041
|
/** Return type with utils included */
|
|
3983
|
-
type BuffersWithUtils<T extends
|
|
4042
|
+
type BuffersWithUtils<T extends BufferRecordType | BufferStore = BufferRecordType> = T & {
|
|
3984
4043
|
removeBuffers: RemoveBuffersFn;
|
|
3985
4044
|
clearBuffers: ClearBuffersFn;
|
|
3986
4045
|
rebuildBuffers: RebuildBuffersFn;
|
|
3987
4046
|
disposeBuffers: DisposeBuffersFn;
|
|
3988
4047
|
};
|
|
3989
|
-
declare function useBuffers(): BuffersWithUtils<
|
|
4048
|
+
declare function useBuffers(): BuffersWithUtils<BufferStore>;
|
|
3990
4049
|
declare function useBuffers(scope: string): BuffersWithUtils<Record<string, BufferLike>>;
|
|
4050
|
+
declare function useBuffers<T extends Record<string, BufferLike>>(scope?: string): BuffersWithUtils<T>;
|
|
3991
4051
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>): BuffersWithUtils<T>;
|
|
3992
4052
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>, scope: string): BuffersWithUtils<T>;
|
|
3993
4053
|
/**
|
|
@@ -4003,6 +4063,10 @@ declare function useBuffers<T extends Record<string, BufferLike>>(creator: Buffe
|
|
|
4003
4063
|
*/
|
|
4004
4064
|
declare function rebuildAllBuffers(store: ReturnType<typeof useStore>, scope?: string): void;
|
|
4005
4065
|
|
|
4066
|
+
/**
|
|
4067
|
+
* A record of storage-like values - allows mixed types (StorageTexture, Storage3DTexture, TSL nodes)
|
|
4068
|
+
*/
|
|
4069
|
+
type StorageRecordType<T extends StorageLike = StorageLike> = Record<string, T>;
|
|
4006
4070
|
/**
|
|
4007
4071
|
* Creator function that returns a record of GPU storage objects.
|
|
4008
4072
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -4017,14 +4081,15 @@ type RebuildStorageFn = (scope?: string) => void;
|
|
|
4017
4081
|
/** Function signature for disposeStorage util - releases GPU resources */
|
|
4018
4082
|
type DisposeStorageFn = (names: string | string[], scope?: string) => void;
|
|
4019
4083
|
/** Return type with utils included */
|
|
4020
|
-
type StorageWithUtils<T extends
|
|
4084
|
+
type StorageWithUtils<T extends StorageRecordType | StorageStore = StorageRecordType> = T & {
|
|
4021
4085
|
removeStorage: RemoveStorageFn;
|
|
4022
4086
|
clearStorage: ClearStorageFn;
|
|
4023
4087
|
rebuildStorage: RebuildStorageFn;
|
|
4024
4088
|
disposeStorage: DisposeStorageFn;
|
|
4025
4089
|
};
|
|
4026
|
-
declare function useGPUStorage(): StorageWithUtils<
|
|
4090
|
+
declare function useGPUStorage(): StorageWithUtils<StorageStore>;
|
|
4027
4091
|
declare function useGPUStorage(scope: string): StorageWithUtils<Record<string, StorageLike>>;
|
|
4092
|
+
declare function useGPUStorage<T extends Record<string, StorageLike>>(scope?: string): StorageWithUtils<T>;
|
|
4028
4093
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>): StorageWithUtils<T>;
|
|
4029
4094
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>, scope: string): StorageWithUtils<T>;
|
|
4030
4095
|
/**
|
|
@@ -4074,6 +4139,10 @@ declare function createTextureOperations(set: StoreApi<RootState>['setState']):
|
|
|
4074
4139
|
* - Callbacks receive full RootState for flexibility
|
|
4075
4140
|
* - No auto-cleanup on unmount - use reset() for explicit cleanup
|
|
4076
4141
|
* - Scene/camera changes trigger scenePass recreation
|
|
4142
|
+
* - A replaced scenePass is disposed once the new graph is installed, so rebuild() does not
|
|
4143
|
+
* strand its render target (and MRT attachments) on the GPU
|
|
4144
|
+
* - Any run that changes the output node sets RenderPipeline.needsUpdate, so rebuild() actually
|
|
4145
|
+
* recompiles instead of silently keeping the first compiled graph
|
|
4077
4146
|
*
|
|
4078
4147
|
* @param mainCB - Main callback to configure outputNode and create effect passes
|
|
4079
4148
|
* @param setupCB - Optional setup callback to configure MRT on scenePass
|
|
@@ -4151,5 +4220,32 @@ interface WebGPURootState extends Omit<RootState, 'renderer' | 'gl' | 'internal'
|
|
|
4151
4220
|
internal: WebGPUInternalState
|
|
4152
4221
|
}
|
|
4153
4222
|
|
|
4154
|
-
|
|
4155
|
-
|
|
4223
|
+
/**
|
|
4224
|
+
* @fileoverview WebGPU entry point - WebGPU only, no legacy WebGL
|
|
4225
|
+
*
|
|
4226
|
+
* This entry point is for apps that want to use ONLY WebGPURenderer.
|
|
4227
|
+
* Includes WebGPU-specific hooks (useUniforms, useNodes, useTextures).
|
|
4228
|
+
* Auto-extends THREE with WebGPU node materials (MeshBasicNodeMaterial, etc.)
|
|
4229
|
+
*
|
|
4230
|
+
* Usage:
|
|
4231
|
+
* import { Canvas, useFrame, useUniforms } from '@react-three/fiber/webgpu'
|
|
4232
|
+
*/
|
|
4233
|
+
|
|
4234
|
+
/** `useThree` narrowed to WebGPU state — `state.renderer` is a `WebGPURenderer`. */
|
|
4235
|
+
type UseThreeWebGPU = <T = WebGPURootState>(selector?: (state: WebGPURootState) => T, equalityFn?: <U>(state: U, newState: U) => boolean) => T;
|
|
4236
|
+
/** `useFrame` narrowed to WebGPU state — the callback's `state.renderer` is a `WebGPURenderer`. */
|
|
4237
|
+
type UseFrameWebGPU = (callback?: FrameCallback$1<WebGPURootState>, priorityOrOptions?: number | UseFrameNextOptions) => FrameNextControls;
|
|
4238
|
+
declare const useThree: UseThreeWebGPU;
|
|
4239
|
+
declare const useFrame: UseFrameWebGPU;
|
|
4240
|
+
|
|
4241
|
+
/** Canvas props on the WebGPU entry: `onCreated` receives `WebGPURootState`. */
|
|
4242
|
+
type WebGPUCanvasProps = Omit<CanvasProps, 'onCreated'> & {
|
|
4243
|
+
/** Callback after the canvas has rendered (but not yet committed); `state.renderer` is a `WebGPURenderer` */
|
|
4244
|
+
onCreated?: (state: WebGPURootState) => void;
|
|
4245
|
+
};
|
|
4246
|
+
|
|
4247
|
+
/** `Canvas` narrowed to WebGPU state — the same component, `onCreated` typed against `WebGPURootState`. */
|
|
4248
|
+
declare const Canvas: (props: WebGPUCanvasProps) => JSX.Element;
|
|
4249
|
+
|
|
4250
|
+
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, removeInteractivity, removeNodes, removeUniforms, resolve, 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 };
|
|
4251
|
+
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, 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 };
|