@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/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 } from 'three/webgpu';
|
|
3
4
|
import * as THREE$1 from 'three';
|
|
4
5
|
import { WebGLCubeRenderTarget, WebGLRenderTarget, WebGLRenderer, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
|
|
5
6
|
import { WebGLRendererParameters } from 'three/src/renderers/WebGLRenderer.js';
|
|
@@ -12,23 +13,8 @@ import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFr
|
|
|
12
13
|
export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
|
|
13
14
|
import { Options } from 'react-use-measure';
|
|
14
15
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
15
|
-
import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
|
|
16
16
|
import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
|
|
17
17
|
|
|
18
|
-
function _mergeNamespaces(n, m) {
|
|
19
|
-
m.forEach(function (e) {
|
|
20
|
-
e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
|
|
21
|
-
if (k !== 'default' && !(k in n)) {
|
|
22
|
-
var d = Object.getOwnPropertyDescriptor(e, k);
|
|
23
|
-
Object.defineProperty(n, k, d.get ? d : {
|
|
24
|
-
enumerable: true,
|
|
25
|
-
get: function () { return e[k]; }
|
|
26
|
-
});
|
|
27
|
-
}
|
|
28
|
-
});
|
|
29
|
-
});
|
|
30
|
-
return Object.freeze(n);
|
|
31
|
-
}
|
|
32
18
|
|
|
33
19
|
/**
|
|
34
20
|
* @fileoverview Internal Three.js re-exports - DEFAULT ENTRY
|
|
@@ -48,19 +34,9 @@ function _mergeNamespaces(n, m) {
|
|
|
48
34
|
declare const R3F_BUILD_LEGACY = true;
|
|
49
35
|
declare const R3F_BUILD_WEBGPU = true;
|
|
50
36
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
CubeRenderTargetCompat: CubeRenderTarget,
|
|
55
|
-
Inspector: Inspector,
|
|
56
|
-
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
57
|
-
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
58
|
-
RenderTargetCompat: RenderTarget,
|
|
59
|
-
WebGLCubeRenderTarget: WebGLCubeRenderTarget,
|
|
60
|
-
WebGLRenderTarget: WebGLRenderTarget,
|
|
61
|
-
WebGLRenderer: WebGLRenderer,
|
|
62
|
-
WebGLRendererParameters: WebGLRendererParameters
|
|
63
|
-
}, [three_webgpu]);
|
|
37
|
+
/** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
|
|
38
|
+
declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
|
|
39
|
+
|
|
64
40
|
|
|
65
41
|
//* Utility Types ==============================
|
|
66
42
|
|
|
@@ -348,6 +324,7 @@ type BufferLike =
|
|
|
348
324
|
| Uint16Array
|
|
349
325
|
| Int16Array
|
|
350
326
|
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
327
|
+
| THREE$1.InterleavedBufferAttribute
|
|
351
328
|
| Node // TSL buffer nodes (instancedArray, storage)
|
|
352
329
|
|
|
353
330
|
/** Flat record of buffer-like values (no nested scopes) */
|
|
@@ -359,6 +336,25 @@ type BufferRecord = Record<string, BufferLike>
|
|
|
359
336
|
*/
|
|
360
337
|
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
361
338
|
|
|
339
|
+
//* Node Types (useNodes) ========================================
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
|
|
343
|
+
* the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
|
|
344
|
+
* code passes through. Creators are constrained to this same type, so the shape a creator returns
|
|
345
|
+
* and the shape the store holds are one type by construction.
|
|
346
|
+
*/
|
|
347
|
+
type NodeLike = TSLNodeType | LegacyTSLNodeLike
|
|
348
|
+
|
|
349
|
+
/** Flat record of TSL nodes (no nested scopes) */
|
|
350
|
+
type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
|
|
351
|
+
|
|
352
|
+
/**
|
|
353
|
+
* Node store that can contain both root-level nodes and scoped node objects.
|
|
354
|
+
* Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
|
|
355
|
+
*/
|
|
356
|
+
type NodeStore = Record<string, NodeLike | NodeRecord>
|
|
357
|
+
|
|
362
358
|
//* Storage Types (useGPUStorage) ========================================
|
|
363
359
|
|
|
364
360
|
/**
|
|
@@ -373,7 +369,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
|
373
369
|
* ```
|
|
374
370
|
*/
|
|
375
371
|
type StorageLike =
|
|
376
|
-
| StorageTexture // GPU storage texture
|
|
372
|
+
| StorageTexture // 2D GPU storage texture
|
|
373
|
+
| Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
|
|
374
|
+
| StorageArrayTexture // 2D-array GPU storage texture
|
|
377
375
|
| Data3DTexture // 3D texture (can be used as storage)
|
|
378
376
|
| Node // TSL storage texture nodes (storageTexture)
|
|
379
377
|
|
|
@@ -492,11 +490,28 @@ interface InternalState {
|
|
|
492
490
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
493
491
|
container?: THREE$1.Object3D
|
|
494
492
|
/**
|
|
495
|
-
* CanvasTarget
|
|
496
|
-
*
|
|
493
|
+
* The CanvasTarget this root sizes and renders through.
|
|
494
|
+
*
|
|
495
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
496
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
497
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
498
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
499
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
497
500
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
498
501
|
*/
|
|
499
502
|
canvasTarget?: CanvasTarget
|
|
503
|
+
/**
|
|
504
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
505
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
506
|
+
*
|
|
507
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
508
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
509
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
510
|
+
* invalidate some other canvas's descriptor instead.
|
|
511
|
+
*
|
|
512
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
513
|
+
*/
|
|
514
|
+
canvasTargetSizeDirty?: boolean
|
|
500
515
|
/**
|
|
501
516
|
* Whether multi-canvas rendering is active.
|
|
502
517
|
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
@@ -606,7 +621,7 @@ interface RootState {
|
|
|
606
621
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
607
622
|
uniforms: UniformStore
|
|
608
623
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
609
|
-
nodes:
|
|
624
|
+
nodes: NodeStore
|
|
610
625
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
611
626
|
buffers: BufferStore
|
|
612
627
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -618,7 +633,7 @@ interface RootState {
|
|
|
618
633
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
619
634
|
renderPipeline: ThreeRenderPipeline | null
|
|
620
635
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
621
|
-
passes:
|
|
636
|
+
passes: PassRecord
|
|
622
637
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
623
638
|
_hmrVersion: number
|
|
624
639
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -706,12 +721,19 @@ type DefaultRendererProps = {
|
|
|
706
721
|
*/
|
|
707
722
|
interface CanvasSchedulerConfig {
|
|
708
723
|
/**
|
|
709
|
-
*
|
|
710
|
-
* Pass the `id` of another canvas.
|
|
724
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
711
725
|
*/
|
|
712
|
-
|
|
726
|
+
before?: string | string[]
|
|
713
727
|
/**
|
|
714
|
-
*
|
|
728
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
729
|
+
*/
|
|
730
|
+
after?: string | string[]
|
|
731
|
+
/**
|
|
732
|
+
* Numeric root order. Lower values run first.
|
|
733
|
+
*/
|
|
734
|
+
order?: number
|
|
735
|
+
/**
|
|
736
|
+
* Limit this Canvas's default render job (frames per second).
|
|
715
737
|
*/
|
|
716
738
|
fps?: number
|
|
717
739
|
}
|
|
@@ -798,14 +820,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
798
820
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
799
821
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
800
822
|
dpr?: Dpr
|
|
801
|
-
/**
|
|
802
|
-
|
|
823
|
+
/**
|
|
824
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
825
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
826
|
+
*/
|
|
827
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
803
828
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
804
829
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
805
830
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
806
831
|
camera?: CameraProps
|
|
807
832
|
/** An R3F event manager to manage elements' pointer events */
|
|
808
|
-
events?: (store: RootStore) => EventManager<
|
|
833
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
809
834
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
810
835
|
onCreated?: (state: RootState) => void
|
|
811
836
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -894,7 +919,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
|
|
|
894
919
|
object?: T
|
|
895
920
|
dispose?: null
|
|
896
921
|
attach?: AttachType<T>
|
|
897
|
-
onUpdate?: (self: T) => void
|
|
898
922
|
}
|
|
899
923
|
|
|
900
924
|
interface Instance<O = any> {
|
|
@@ -1034,7 +1058,7 @@ interface CanvasProps
|
|
|
1034
1058
|
*/
|
|
1035
1059
|
resize?: Options
|
|
1036
1060
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1037
|
-
eventSource?:
|
|
1061
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1038
1062
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1039
1063
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1040
1064
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1142,81 +1166,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1142
1166
|
|
|
1143
1167
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1144
1168
|
|
|
1145
|
-
//* Global Types ==============================
|
|
1169
|
+
//* Global TSL Types ==============================
|
|
1146
1170
|
|
|
1147
1171
|
declare global {
|
|
1148
1172
|
/**
|
|
1149
|
-
*
|
|
1150
|
-
*
|
|
1151
|
-
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1152
|
-
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1153
|
-
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1154
|
-
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1155
|
-
* arity when three made `UniformNode` two-parameter.
|
|
1156
|
-
*
|
|
1157
|
-
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1158
|
-
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1159
|
-
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1160
|
-
* installed three instead of needing to be mirrored by hand.
|
|
1173
|
+
* Broad callable-node fallback for dynamic store readers.
|
|
1174
|
+
* Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
|
|
1161
1175
|
*/
|
|
1162
|
-
type
|
|
1176
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1177
|
+
readonly shaderNode: unknown
|
|
1178
|
+
readonly id: number
|
|
1179
|
+
}
|
|
1163
1180
|
|
|
1164
|
-
/**
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
* @example
|
|
1170
|
-
* ```tsx
|
|
1171
|
-
* // Define a shader function
|
|
1172
|
-
* const blendColorFn = Fn(([color1, color2, factor]) => {
|
|
1173
|
-
* return mix(color1, color2, factor)
|
|
1174
|
-
* })
|
|
1175
|
-
*
|
|
1176
|
-
* // Type when retrieving from nodes store
|
|
1177
|
-
* const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
|
|
1178
|
-
*
|
|
1179
|
-
* // Or with specific return type
|
|
1180
|
-
* const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
|
|
1181
|
-
* ```
|
|
1182
|
-
*/
|
|
1183
|
-
type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
|
|
1181
|
+
/** Legacy structural node accepted when at least one historical marker exists. */
|
|
1182
|
+
type LegacyTSLNodeLike = {
|
|
1183
|
+
label?: ((label: string) => unknown) | string
|
|
1184
|
+
setName?: (name: string) => unknown
|
|
1185
|
+
} & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
|
|
1184
1186
|
|
|
1185
|
-
/**
|
|
1186
|
-
|
|
1187
|
-
* This is the common return type for TSL operations (add, mul, sin, etc.)
|
|
1188
|
-
*
|
|
1189
|
-
* @example
|
|
1190
|
-
* ```tsx
|
|
1191
|
-
* const { wobble } = nodes as { wobble: ShaderNodeRef }
|
|
1192
|
-
* ```
|
|
1193
|
-
*/
|
|
1194
|
-
type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
|
|
1187
|
+
/** Node type accepted by broad dynamic node-store readers. */
|
|
1188
|
+
type TSLNodeType = three_webgpu.Node | CallableTSLNode
|
|
1195
1189
|
|
|
1196
1190
|
/**
|
|
1197
|
-
*
|
|
1198
|
-
*
|
|
1199
|
-
*
|
|
1200
|
-
*
|
|
1201
|
-
* - Node: base Three.js node type
|
|
1202
|
-
* - ShaderCallable: function nodes created with Fn()
|
|
1203
|
-
* - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
|
|
1204
|
-
*
|
|
1205
|
-
* @example
|
|
1206
|
-
* ```tsx
|
|
1207
|
-
* // In useLocalNodes, nodes are typed as TSLNodeType
|
|
1208
|
-
* const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
|
|
1209
|
-
* positionNode: nodes.myPosition, // Works - Node is in union
|
|
1210
|
-
* blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
|
|
1211
|
-
* }))
|
|
1212
|
-
*
|
|
1213
|
-
* // Can narrow with type guard or assertion when needed
|
|
1214
|
-
* if (typeof blendColorFn === 'function') {
|
|
1215
|
-
* blendColorFn(someColor, 0.5)
|
|
1216
|
-
* }
|
|
1217
|
-
* ```
|
|
1191
|
+
* Derive Three's shader node type from an existing node or a supported raw input.
|
|
1192
|
+
* Existing InputNode generics take precedence over structural value normalization.
|
|
1193
|
+
* Both generics must be inferred because Three's UniformNode intersects an unknown-typed
|
|
1194
|
+
* InputNode base with its concrete InputNode specialization.
|
|
1218
1195
|
*/
|
|
1219
|
-
type
|
|
1196
|
+
type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
|
|
1197
|
+
? TNodeType
|
|
1198
|
+
: T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
|
|
1199
|
+
? TNodeType
|
|
1200
|
+
: T extends number
|
|
1201
|
+
? 'float'
|
|
1202
|
+
: T extends boolean
|
|
1203
|
+
? 'bool'
|
|
1204
|
+
: T extends string | three_webgpu.Color | { r: number; g: number; b: number }
|
|
1205
|
+
? 'color'
|
|
1206
|
+
: T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
|
|
1207
|
+
? 'vec4'
|
|
1208
|
+
: T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
|
|
1209
|
+
? 'vec3'
|
|
1210
|
+
: T extends three_webgpu.Vector2 | { x: number; y: number }
|
|
1211
|
+
? 'vec2'
|
|
1212
|
+
: T extends three_webgpu.Matrix4
|
|
1213
|
+
? 'mat4'
|
|
1214
|
+
: T extends three_webgpu.Matrix3
|
|
1215
|
+
? 'mat3'
|
|
1216
|
+
: T extends three_webgpu.Matrix2
|
|
1217
|
+
? 'mat2'
|
|
1218
|
+
: unknown
|
|
1219
|
+
|
|
1220
|
+
/** Derive the normalized JavaScript value stored by a uniform node. */
|
|
1221
|
+
type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
|
|
1222
|
+
? TValue
|
|
1223
|
+
: T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
|
|
1224
|
+
? TValue
|
|
1225
|
+
: T extends string | { r: number; g: number; b: number }
|
|
1226
|
+
? three_webgpu.Color
|
|
1227
|
+
: T extends { x: number; y: number; z: number; w: number }
|
|
1228
|
+
? three_webgpu.Vector4
|
|
1229
|
+
: T extends { x: number; y: number; z: number }
|
|
1230
|
+
? three_webgpu.Vector3
|
|
1231
|
+
: T extends { x: number; y: number }
|
|
1232
|
+
? three_webgpu.Vector2
|
|
1233
|
+
: T extends number
|
|
1234
|
+
? number
|
|
1235
|
+
: T extends boolean
|
|
1236
|
+
? boolean
|
|
1237
|
+
: T
|
|
1238
|
+
|
|
1239
|
+
/** Three's exact UniformNode with shader and value generics derived from an input. */
|
|
1240
|
+
type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
|
|
1241
|
+
|
|
1242
|
+
/** Preserve every input key while mapping values to exact Three uniform nodes. */
|
|
1243
|
+
type UniformNodesFor<T extends UniformInputRecord> = {
|
|
1244
|
+
[K in keyof T]: UniformNodeFor<T[K]>
|
|
1245
|
+
}
|
|
1246
|
+
|
|
1247
|
+
/** Backward-compatible single-parameter uniform alias. */
|
|
1248
|
+
type UniformNode<T = unknown> = UniformNodeFor<T>
|
|
1220
1249
|
|
|
1221
1250
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1222
1251
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1241,7 +1270,7 @@ declare global {
|
|
|
1241
1270
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1242
1271
|
* Supports:
|
|
1243
1272
|
* - Primitives: number, string (color), boolean
|
|
1244
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1273
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1245
1274
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1246
1275
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1247
1276
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1254,88 +1283,124 @@ declare global {
|
|
|
1254
1283
|
| three_webgpu.Vector2
|
|
1255
1284
|
| three_webgpu.Vector3
|
|
1256
1285
|
| three_webgpu.Vector4
|
|
1286
|
+
| three_webgpu.Matrix2
|
|
1257
1287
|
| three_webgpu.Matrix3
|
|
1258
1288
|
| three_webgpu.Matrix4
|
|
1259
|
-
|
|
|
1260
|
-
|
|
|
1261
|
-
| { x: number; y
|
|
1289
|
+
| { x: number; y: number }
|
|
1290
|
+
| { x: number; y: number; z: number }
|
|
1291
|
+
| { x: number; y: number; z: number; w: number }
|
|
1262
1292
|
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1263
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1293
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1264
1294
|
| UniformNode
|
|
1265
1295
|
|
|
1266
1296
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1267
1297
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1268
1298
|
}
|
|
1269
1299
|
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
declare module 'three/tsl' {
|
|
1300
|
+
declare global {
|
|
1273
1301
|
/**
|
|
1274
|
-
*
|
|
1275
|
-
*
|
|
1302
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1303
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1304
|
+
* is r185, so the new name is the only one.
|
|
1276
1305
|
*/
|
|
1277
|
-
|
|
1278
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1279
|
-
): ShaderCallable<R>
|
|
1306
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1280
1307
|
|
|
1281
1308
|
/**
|
|
1282
|
-
*
|
|
1283
|
-
*
|
|
1309
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1310
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1311
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1284
1312
|
*/
|
|
1285
|
-
|
|
1286
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1287
|
-
): ShaderCallable<R>
|
|
1313
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1288
1314
|
|
|
1289
1315
|
/**
|
|
1290
|
-
*
|
|
1291
|
-
*
|
|
1316
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1317
|
+
*
|
|
1318
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1319
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1320
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1321
|
+
* {@link RenderPipelineCallbackState}.
|
|
1322
|
+
*
|
|
1323
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1324
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1325
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1326
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1327
|
+
*
|
|
1328
|
+
* The index signature admits `undefined` because a key may simply not be registered, and
|
|
1329
|
+
* because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
|
|
1330
|
+
* optional property whose type excludes `undefined` from the index signature is an error
|
|
1331
|
+
* (TS2411) for every consumer compiling these declarations.
|
|
1292
1332
|
*/
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1333
|
+
interface PassRecord {
|
|
1334
|
+
scenePass?: ScenePassNode
|
|
1335
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1336
|
+
}
|
|
1297
1337
|
|
|
1298
1338
|
/**
|
|
1299
|
-
*
|
|
1339
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1340
|
+
*
|
|
1341
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1342
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1343
|
+
*
|
|
1344
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1345
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1300
1346
|
*/
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1347
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1348
|
+
renderPipeline: ThreeRenderPipeline
|
|
1349
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1350
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1351
|
+
isLegacy: false
|
|
1352
|
+
}
|
|
1306
1353
|
|
|
1307
|
-
declare global {
|
|
1308
1354
|
/**
|
|
1309
|
-
*
|
|
1310
|
-
*
|
|
1311
|
-
* is
|
|
1355
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1356
|
+
*
|
|
1357
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1358
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1359
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1360
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1312
1361
|
*/
|
|
1313
|
-
type
|
|
1314
|
-
|
|
1315
|
-
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1316
|
-
type PassRecord = Record<string, any>
|
|
1362
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1317
1363
|
|
|
1318
1364
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1319
|
-
type RenderPipelineSetupCallback = (state:
|
|
1365
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1320
1366
|
|
|
1321
1367
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1322
|
-
type RenderPipelineMainCallback = (state:
|
|
1368
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1323
1369
|
|
|
1324
|
-
/**
|
|
1325
|
-
interface
|
|
1370
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1371
|
+
interface UseRenderPipelineActions {
|
|
1326
1372
|
/** Current passes from state */
|
|
1327
1373
|
passes: PassRecord
|
|
1328
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1329
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1330
1374
|
/** Clear all passes from state */
|
|
1331
1375
|
clearPasses: () => void
|
|
1332
1376
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1333
1377
|
reset: () => void
|
|
1334
1378
|
/** Re-run setup/main callbacks with current closure values */
|
|
1335
1379
|
rebuild: () => void
|
|
1336
|
-
/** True when RenderPipeline is configured and ready */
|
|
1337
|
-
isReady: boolean
|
|
1338
1380
|
}
|
|
1381
|
+
|
|
1382
|
+
/**
|
|
1383
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1384
|
+
*
|
|
1385
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1386
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1387
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1388
|
+
*/
|
|
1389
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1390
|
+
(
|
|
1391
|
+
| {
|
|
1392
|
+
/** True when RenderPipeline is configured and ready */
|
|
1393
|
+
isReady: true
|
|
1394
|
+
/** RenderPipeline instance */
|
|
1395
|
+
renderPipeline: ThreeRenderPipeline
|
|
1396
|
+
}
|
|
1397
|
+
| {
|
|
1398
|
+
/** False until the pipeline has been created */
|
|
1399
|
+
isReady: false
|
|
1400
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1401
|
+
renderPipeline: null
|
|
1402
|
+
}
|
|
1403
|
+
)
|
|
1339
1404
|
}
|
|
1340
1405
|
|
|
1341
1406
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -1414,10 +1479,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1414
1479
|
|
|
1415
1480
|
/**
|
|
1416
1481
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1417
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1482
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1483
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1418
1484
|
*/
|
|
1419
1485
|
type NodeProps<P> = {
|
|
1420
|
-
[K in keyof P as P[K] extends
|
|
1486
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1421
1487
|
}
|
|
1422
1488
|
|
|
1423
1489
|
interface ReactProps<P> {
|
|
@@ -1438,11 +1504,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1438
1504
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1439
1505
|
}
|
|
1440
1506
|
|
|
1507
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1508
|
+
type Object3DMethod = NonNullable<
|
|
1509
|
+
{
|
|
1510
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1511
|
+
}[keyof Object3D]
|
|
1512
|
+
>
|
|
1513
|
+
|
|
1441
1514
|
type ThreeExports = typeof import('three') & typeof import('three/webgpu')
|
|
1442
1515
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1443
1516
|
|
|
1444
1517
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1445
|
-
|
|
1518
|
+
/**
|
|
1519
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1520
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1521
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1522
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1523
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1524
|
+
*/
|
|
1525
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
|
|
1526
|
+
object: object
|
|
1527
|
+
ref?: React.Ref<any>
|
|
1528
|
+
[prop: string]: unknown
|
|
1529
|
+
}
|
|
1446
1530
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1447
1531
|
threeAudio: ThreeElementsImpl['audio']
|
|
1448
1532
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1483,6 +1567,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1483
1567
|
type three_d_Matrix4 = Matrix4;
|
|
1484
1568
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1485
1569
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1570
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1486
1571
|
type three_d_Quaternion = Quaternion;
|
|
1487
1572
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1488
1573
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1497,7 +1582,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1497
1582
|
type three_d_Vector4 = Vector4;
|
|
1498
1583
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1499
1584
|
declare namespace three_d {
|
|
1500
|
-
export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
|
|
1585
|
+
export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Object3DMethod as Object3DMethod, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
|
|
1501
1586
|
}
|
|
1502
1587
|
|
|
1503
1588
|
/**
|
|
@@ -1635,9 +1720,9 @@ type EnvironmentProps = {
|
|
|
1635
1720
|
blur?: number;
|
|
1636
1721
|
backgroundBlurriness?: number;
|
|
1637
1722
|
backgroundIntensity?: number;
|
|
1638
|
-
backgroundRotation?: Euler
|
|
1723
|
+
backgroundRotation?: Euler;
|
|
1639
1724
|
environmentIntensity?: number;
|
|
1640
|
-
environmentRotation?: Euler
|
|
1725
|
+
environmentRotation?: Euler;
|
|
1641
1726
|
map?: Texture$1;
|
|
1642
1727
|
preset?: PresetsType;
|
|
1643
1728
|
scene?: Scene | React$1.RefObject<Scene>;
|
|
@@ -1721,7 +1806,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
|
|
|
1721
1806
|
declare function EnvironmentPortal({ children, near, far, resolution, frames, map, background, blur, backgroundBlurriness, backgroundIntensity, backgroundRotation, environmentIntensity, environmentRotation, scene, files, path, preset, extensions, }: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
1722
1807
|
declare module '@react-three/fiber' {
|
|
1723
1808
|
interface ThreeElements {
|
|
1724
|
-
groundProjectedEnvImpl: ThreeElement
|
|
1809
|
+
groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
|
|
1725
1810
|
}
|
|
1726
1811
|
}
|
|
1727
1812
|
/**
|
|
@@ -1821,6 +1906,24 @@ declare module '@react-three/fiber' {
|
|
|
1821
1906
|
*/
|
|
1822
1907
|
declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
1823
1908
|
|
|
1909
|
+
/**
|
|
1910
|
+
* Moves every trace of interactivity from one object to its replacement, for reconstruction.
|
|
1911
|
+
*
|
|
1912
|
+
* When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
|
|
1913
|
+
* instance. Removing the old object from the interaction state and registering the new one from
|
|
1914
|
+
* scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
|
|
1915
|
+
* the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
|
|
1916
|
+
* is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
|
|
1917
|
+
* swap the user never asked to see (#3744).
|
|
1918
|
+
*
|
|
1919
|
+
* Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
|
|
1920
|
+
* left alone — releasing and re-acquiring it is precisely the glitch being avoided.
|
|
1921
|
+
*
|
|
1922
|
+
* Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
|
|
1923
|
+
* the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
|
|
1924
|
+
* cannot outlive the object it described.
|
|
1925
|
+
*/
|
|
1926
|
+
declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
|
|
1824
1927
|
declare function removeInteractivity(store: RootStore, object: Object3D): void;
|
|
1825
1928
|
declare function createEvents(store: RootStore): {
|
|
1826
1929
|
handlePointer: (name: string) => (event: DomEvent) => void;
|
|
@@ -1828,7 +1931,7 @@ declare function createEvents(store: RootStore): {
|
|
|
1828
1931
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1829
1932
|
};
|
|
1830
1933
|
/** Default R3F event manager for web */
|
|
1831
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1934
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1832
1935
|
|
|
1833
1936
|
/**
|
|
1834
1937
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -1861,7 +1964,7 @@ declare namespace useLoader {
|
|
|
1861
1964
|
*
|
|
1862
1965
|
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
1863
1966
|
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
1864
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
1967
|
+
* @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
|
|
1865
1968
|
*
|
|
1866
1969
|
* @example
|
|
1867
1970
|
* // Simple priority (backwards compat)
|
|
@@ -2157,7 +2260,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2157
2260
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2158
2261
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2159
2262
|
*
|
|
2160
|
-
*
|
|
2263
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
2264
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
2265
|
+
*
|
|
2266
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2161
2267
|
* @param frames - Number of frames to request (default: 1)
|
|
2162
2268
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2163
2269
|
*
|
|
@@ -2168,14 +2274,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2168
2274
|
* Advances the frameloop and runs render effects.
|
|
2169
2275
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2170
2276
|
*
|
|
2277
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2278
|
+
* registered root is stepped for backwards compatibility.
|
|
2279
|
+
*
|
|
2171
2280
|
* @param timestamp - The timestamp to use for this frame
|
|
2172
2281
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2173
|
-
* @param state -
|
|
2174
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2282
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2175
2283
|
*
|
|
2176
2284
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2177
2285
|
*/
|
|
2178
|
-
declare function advance(timestamp: number): void;
|
|
2286
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2179
2287
|
|
|
2180
2288
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2181
2289
|
declare function ReactReconciler<
|
|
@@ -3220,6 +3328,7 @@ declare namespace ReactReconciler {
|
|
|
3220
3328
|
|
|
3221
3329
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3222
3330
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3331
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3223
3332
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3224
3333
|
|
|
3225
3334
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3246,11 +3355,6 @@ declare function flushSync<R>(fn: () => R): R;
|
|
|
3246
3355
|
declare const context: React$1.Context<RootStore>;
|
|
3247
3356
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3248
3357
|
|
|
3249
|
-
/**
|
|
3250
|
-
* Safely flush async effects when testing, simulating a legacy root.
|
|
3251
|
-
* @deprecated Import from React instead. import { act } from 'react'
|
|
3252
|
-
*/
|
|
3253
|
-
declare const act: typeof React$1.act;
|
|
3254
3358
|
/**
|
|
3255
3359
|
* An SSR-friendly useLayoutEffect.
|
|
3256
3360
|
*
|
|
@@ -3502,7 +3606,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
|
|
|
3502
3606
|
declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
|
|
3503
3607
|
/**
|
|
3504
3608
|
* Triggers an update for an instance.
|
|
3505
|
-
*
|
|
3609
|
+
* Invalidates the frame if the root is in demand mode.
|
|
3506
3610
|
*
|
|
3507
3611
|
* @param instance - Instance to invalidate
|
|
3508
3612
|
*/
|
|
@@ -3668,29 +3772,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3668
3772
|
* Used to identify values that should be resolved from refs after mount.
|
|
3669
3773
|
*/
|
|
3670
3774
|
declare const FROM_REF: unique symbol;
|
|
3775
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3776
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3777
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3778
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3779
|
+
transform?: (value: T) => R;
|
|
3780
|
+
}
|
|
3671
3781
|
/**
|
|
3672
3782
|
* Defers prop application until the referenced object is available.
|
|
3673
3783
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3674
3784
|
*
|
|
3785
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3786
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3787
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3788
|
+
* what gets assigned.
|
|
3789
|
+
*
|
|
3675
3790
|
* @param ref - React ref object to resolve at mount time
|
|
3676
|
-
* @
|
|
3791
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3792
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
3677
3793
|
*
|
|
3678
3794
|
* @example
|
|
3679
3795
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3680
3796
|
*
|
|
3681
3797
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3682
3798
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3799
|
+
*
|
|
3800
|
+
* @example
|
|
3801
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3802
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
3683
3803
|
*/
|
|
3684
3804
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3805
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
3685
3806
|
/**
|
|
3686
3807
|
* Type guard to check if a value is a fromRef marker.
|
|
3687
3808
|
*
|
|
3688
3809
|
* @param value - Value to check
|
|
3689
3810
|
* @returns True if value is a fromRef marker
|
|
3690
3811
|
*/
|
|
3691
|
-
declare function isFromRef(value: unknown): value is
|
|
3692
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3693
|
-
};
|
|
3812
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3694
3813
|
|
|
3695
3814
|
/**
|
|
3696
3815
|
* Symbol marker for mount-only method calls.
|
|
@@ -3717,7 +3836,15 @@ declare const ONCE: unique symbol;
|
|
|
3717
3836
|
* // No arguments
|
|
3718
3837
|
* <geometry center={once()} />
|
|
3719
3838
|
*/
|
|
3720
|
-
declare function once<
|
|
3839
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3840
|
+
/**
|
|
3841
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3842
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3843
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3844
|
+
*
|
|
3845
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3846
|
+
*/
|
|
3847
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
3721
3848
|
/**
|
|
3722
3849
|
* Type guard to check if a value is a once marker.
|
|
3723
3850
|
*
|
|
@@ -3734,5 +3861,5 @@ declare function isOnce(value: unknown): value is {
|
|
|
3734
3861
|
*/
|
|
3735
3862
|
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3736
3863
|
|
|
3737
|
-
export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots,
|
|
3738
|
-
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|
|
3864
|
+
export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
|
|
3865
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, FromRefMarker, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeLike, NodeProps, NodeRecord, NodeStore, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|