@react-three/fiber 10.0.0-canary.76d2134 → 10.0.0-canary.777b94d
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/extension.cjs +278 -0
- package/dist/extension.d.cts +629 -0
- package/dist/extension.d.mts +629 -0
- package/dist/extension.d.ts +629 -0
- package/dist/extension.mjs +258 -0
- package/dist/index.cjs +2803 -2706
- package/dist/index.d.cts +168 -322
- package/dist/index.d.mts +168 -322
- package/dist/index.d.ts +165 -347
- package/dist/index.mjs +2575 -2480
- package/dist/legacy.cjs +2558 -2462
- package/dist/legacy.d.cts +187 -374
- package/dist/legacy.d.mts +187 -374
- package/dist/legacy.d.ts +185 -398
- package/dist/legacy.mjs +2825 -2731
- package/dist/webgpu/index.cjs +2595 -3321
- package/dist/webgpu/index.d.cts +189 -713
- package/dist/webgpu/index.d.mts +189 -713
- package/dist/webgpu/index.d.ts +186 -738
- package/dist/webgpu/index.mjs +2592 -3302
- package/package.json +9 -4
- package/readme.md +1 -1
- package/react-reconciler/constants.d.ts +0 -7
- package/react-reconciler/constants.js +0 -1
- package/react-reconciler/index.d.ts +0 -1044
- package/react-reconciler/index.js +0 -208
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import * as
|
|
2
|
-
import
|
|
1
|
+
import * as three_examples_jsm_inspector_Inspector_js from 'three/examples/jsm/inspector/Inspector.js';
|
|
2
|
+
import * as webgpu from 'three/webgpu';
|
|
3
|
+
import { CubeRenderTarget, RenderTarget, WebGPURenderer, 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
|
|
|
@@ -324,68 +300,6 @@ type FrameNextCallback = FrameCallback$1<RootState>
|
|
|
324
300
|
/** Alias for FrameNextCallback */
|
|
325
301
|
type FrameCallback = FrameNextCallback
|
|
326
302
|
|
|
327
|
-
//* Buffer Types (useBuffers) ========================================
|
|
328
|
-
|
|
329
|
-
/**
|
|
330
|
-
* Buffer-like types for GPU compute and storage operations.
|
|
331
|
-
* Includes raw CPU arrays, Three.js buffer attributes, and TSL buffer nodes.
|
|
332
|
-
*
|
|
333
|
-
* @example
|
|
334
|
-
* ```tsx
|
|
335
|
-
* const { positions, velocities } = useBuffers(() => ({
|
|
336
|
-
* positions: instancedArray(count, 'vec3'), // StorageBufferNode
|
|
337
|
-
* velocities: new Float32Array(count * 3), // TypedArray
|
|
338
|
-
* }), 'particles')
|
|
339
|
-
* ```
|
|
340
|
-
*/
|
|
341
|
-
type BufferLike =
|
|
342
|
-
| Float32Array
|
|
343
|
-
| Uint32Array
|
|
344
|
-
| Int32Array
|
|
345
|
-
| Float64Array
|
|
346
|
-
| Uint8Array
|
|
347
|
-
| Int8Array
|
|
348
|
-
| Uint16Array
|
|
349
|
-
| Int16Array
|
|
350
|
-
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
351
|
-
| Node // TSL buffer nodes (instancedArray, storage)
|
|
352
|
-
|
|
353
|
-
/** Flat record of buffer-like values (no nested scopes) */
|
|
354
|
-
type BufferRecord = Record<string, BufferLike>
|
|
355
|
-
|
|
356
|
-
/**
|
|
357
|
-
* Buffer store that can contain both root-level buffers and scoped buffer objects.
|
|
358
|
-
* Structure: { positions: Float32Array, particles: { vel: StorageBufferNode } }
|
|
359
|
-
*/
|
|
360
|
-
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
361
|
-
|
|
362
|
-
//* Storage Types (useGPUStorage) ========================================
|
|
363
|
-
|
|
364
|
-
/**
|
|
365
|
-
* GPU storage types for texture-based storage operations.
|
|
366
|
-
* Includes Three.js storage textures and TSL storage texture nodes.
|
|
367
|
-
*
|
|
368
|
-
* @example
|
|
369
|
-
* ```tsx
|
|
370
|
-
* const { heightMap } = useGPUStorage(() => ({
|
|
371
|
-
* heightMap: new StorageTexture(512, 512),
|
|
372
|
-
* }), 'terrain')
|
|
373
|
-
* ```
|
|
374
|
-
*/
|
|
375
|
-
type StorageLike =
|
|
376
|
-
| StorageTexture // GPU storage texture
|
|
377
|
-
| Data3DTexture // 3D texture (can be used as storage)
|
|
378
|
-
| Node // TSL storage texture nodes (storageTexture)
|
|
379
|
-
|
|
380
|
-
/** Flat record of storage-like values (no nested scopes) */
|
|
381
|
-
type StorageRecord = Record<string, StorageLike>
|
|
382
|
-
|
|
383
|
-
/**
|
|
384
|
-
* Storage store that can contain both root-level storage and scoped storage objects.
|
|
385
|
-
* Structure: { heightMap: StorageTexture, terrain: { normal: StorageTextureNode } }
|
|
386
|
-
*/
|
|
387
|
-
type StorageStore = Record<string, StorageLike | StorageRecord>
|
|
388
|
-
|
|
389
303
|
//* Renderer Types ========================================
|
|
390
304
|
|
|
391
305
|
/** Default renderer type - union of WebGL and WebGPU renderers */
|
|
@@ -485,6 +399,12 @@ interface InternalState {
|
|
|
485
399
|
actualRenderer: R3FRenderer
|
|
486
400
|
/** Global scheduler reference (for useFrame hook) */
|
|
487
401
|
scheduler: SchedulerApi | null
|
|
402
|
+
/**
|
|
403
|
+
* Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
|
|
404
|
+
* `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
|
|
405
|
+
* render-phase takeover. Used by `useRenderPipeline`.
|
|
406
|
+
*/
|
|
407
|
+
renderOverride?: (() => void) | null
|
|
488
408
|
/** This root's unique ID in the global scheduler */
|
|
489
409
|
rootId?: string
|
|
490
410
|
/** Function to unregister this root from the global scheduler */
|
|
@@ -492,11 +412,28 @@ interface InternalState {
|
|
|
492
412
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
493
413
|
container?: THREE$1.Object3D
|
|
494
414
|
/**
|
|
495
|
-
* CanvasTarget
|
|
496
|
-
*
|
|
415
|
+
* The CanvasTarget this root sizes and renders through.
|
|
416
|
+
*
|
|
417
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
418
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
419
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
420
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
421
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
497
422
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
498
423
|
*/
|
|
499
424
|
canvasTarget?: CanvasTarget
|
|
425
|
+
/**
|
|
426
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
427
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
428
|
+
*
|
|
429
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
430
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
431
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
432
|
+
* invalidate some other canvas's descriptor instead.
|
|
433
|
+
*
|
|
434
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
435
|
+
*/
|
|
436
|
+
canvasTargetSizeDirty?: boolean
|
|
500
437
|
/**
|
|
501
438
|
* Whether multi-canvas rendering is active.
|
|
502
439
|
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
@@ -535,12 +472,13 @@ interface RootState {
|
|
|
535
472
|
/** Get current state */
|
|
536
473
|
get: StoreApi<RootState>['getState']
|
|
537
474
|
/**
|
|
538
|
-
*
|
|
475
|
+
* The store of the canvas that owns this root's renderer.
|
|
539
476
|
* - For primary/independent canvases: points to its own store (self-reference)
|
|
540
477
|
* - For secondary canvases: points to the primary canvas's store
|
|
478
|
+
* - Portals copy it from their parent
|
|
541
479
|
*
|
|
542
|
-
*
|
|
543
|
-
*
|
|
480
|
+
* Anything shared per renderer rather than per canvas (e.g. @react-three/tsl's resources)
|
|
481
|
+
* resolves through it.
|
|
544
482
|
*/
|
|
545
483
|
primaryStore: RootStore
|
|
546
484
|
/** @deprecated Use `renderer` instead. The instance of the renderer (typed as WebGLRenderer for backwards compat) */
|
|
@@ -603,24 +541,10 @@ interface RootState {
|
|
|
603
541
|
setError: (error: Error | null) => void
|
|
604
542
|
/** Current error state (null when no error) */
|
|
605
543
|
error: Error | null
|
|
606
|
-
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
607
|
-
uniforms: UniformStore
|
|
608
|
-
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
609
|
-
nodes: Record<string, any>
|
|
610
|
-
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
611
|
-
buffers: BufferStore
|
|
612
|
-
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
613
|
-
gpuStorage: StorageStore
|
|
614
544
|
/** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
|
|
615
545
|
textures: Map<string, THREE$1.Texture>
|
|
616
546
|
/** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
|
|
617
547
|
_textureRefs: Map<string, number>
|
|
618
|
-
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
619
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
620
|
-
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
621
|
-
passes: Record<string, any>
|
|
622
|
-
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
623
|
-
_hmrVersion: number
|
|
624
548
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
625
549
|
_sizeImperative: boolean
|
|
626
550
|
/** Internal: stored size props from Canvas for reset functionality */
|
|
@@ -706,12 +630,19 @@ type DefaultRendererProps = {
|
|
|
706
630
|
*/
|
|
707
631
|
interface CanvasSchedulerConfig {
|
|
708
632
|
/**
|
|
709
|
-
*
|
|
710
|
-
* Pass the `id` of another canvas.
|
|
633
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
711
634
|
*/
|
|
712
|
-
|
|
635
|
+
before?: string | string[]
|
|
713
636
|
/**
|
|
714
|
-
*
|
|
637
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
638
|
+
*/
|
|
639
|
+
after?: string | string[]
|
|
640
|
+
/**
|
|
641
|
+
* Numeric root order. Lower values run first.
|
|
642
|
+
*/
|
|
643
|
+
order?: number
|
|
644
|
+
/**
|
|
645
|
+
* Limit this Canvas's default render job (frames per second).
|
|
715
646
|
*/
|
|
716
647
|
fps?: number
|
|
717
648
|
}
|
|
@@ -798,14 +729,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
798
729
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
799
730
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
800
731
|
dpr?: Dpr
|
|
801
|
-
/**
|
|
802
|
-
|
|
732
|
+
/**
|
|
733
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
734
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
735
|
+
*/
|
|
736
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
803
737
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
804
738
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
805
739
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
806
740
|
camera?: CameraProps
|
|
807
741
|
/** An R3F event manager to manage elements' pointer events */
|
|
808
|
-
events?: (store: RootStore) => EventManager<
|
|
742
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
809
743
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
810
744
|
onCreated?: (state: RootState) => void
|
|
811
745
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -894,7 +828,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
|
|
|
894
828
|
object?: T
|
|
895
829
|
dispose?: null
|
|
896
830
|
attach?: AttachType<T>
|
|
897
|
-
onUpdate?: (self: T) => void
|
|
898
831
|
}
|
|
899
832
|
|
|
900
833
|
interface Instance<O = any> {
|
|
@@ -1034,7 +967,7 @@ interface CanvasProps
|
|
|
1034
967
|
*/
|
|
1035
968
|
resize?: Options
|
|
1036
969
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1037
|
-
eventSource?:
|
|
970
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1038
971
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1039
972
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1040
973
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1142,202 +1075,6 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1142
1075
|
|
|
1143
1076
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1144
1077
|
|
|
1145
|
-
//* Global Types ==============================
|
|
1146
|
-
|
|
1147
|
-
declare global {
|
|
1148
|
-
/**
|
|
1149
|
-
* Uniform node type.
|
|
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.
|
|
1161
|
-
*/
|
|
1162
|
-
type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
|
|
1163
|
-
|
|
1164
|
-
/**
|
|
1165
|
-
* ShaderCallable - the return type of Fn()
|
|
1166
|
-
* A callable shader function node that can be invoked with parameters.
|
|
1167
|
-
* The function returns a ShaderNodeObject when called.
|
|
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
|
|
1184
|
-
|
|
1185
|
-
/**
|
|
1186
|
-
* ShaderNodeRef - a ShaderNodeObject wrapper around a Node
|
|
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>
|
|
1195
|
-
|
|
1196
|
-
/**
|
|
1197
|
-
* TSLNodeType - Union of all common TSL node types
|
|
1198
|
-
* Used by ScopedStore to properly type node access from the store.
|
|
1199
|
-
*
|
|
1200
|
-
* Includes:
|
|
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
|
-
* ```
|
|
1218
|
-
*/
|
|
1219
|
-
type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
|
|
1220
|
-
|
|
1221
|
-
/** Flat record of uniform nodes (no nested scopes) */
|
|
1222
|
-
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
1223
|
-
|
|
1224
|
-
/**
|
|
1225
|
-
* Uniform store that can contain both root-level uniforms and scoped uniform objects
|
|
1226
|
-
* Used by state.uniforms which has structure like:
|
|
1227
|
-
* { uTime: UniformNode, player: { uHealth: UniformNode }, enemy: { uHealth: UniformNode } }
|
|
1228
|
-
*/
|
|
1229
|
-
type UniformStore = Record<string, UniformNode | UniformRecord>
|
|
1230
|
-
|
|
1231
|
-
/**
|
|
1232
|
-
* Helper to safely access a uniform node from the store.
|
|
1233
|
-
* Use this when accessing state.uniforms to get proper typing.
|
|
1234
|
-
* @example
|
|
1235
|
-
* const uTime = uniforms.uTime as UniformNode<number>
|
|
1236
|
-
* const uColor = uniforms.uColor as UniformNode<import('three/webgpu').Color>
|
|
1237
|
-
*/
|
|
1238
|
-
type GetUniform<T = unknown> = UniformNode<T>
|
|
1239
|
-
|
|
1240
|
-
/**
|
|
1241
|
-
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1242
|
-
* Supports:
|
|
1243
|
-
* - Primitives: number, string (color), boolean
|
|
1244
|
-
* - Three.js types: Color, Vector2/3/4, Matrix3/4, Euler, Quaternion
|
|
1245
|
-
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1246
|
-
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1247
|
-
* - UniformNode: existing uniforms (reused as-is)
|
|
1248
|
-
*/
|
|
1249
|
-
type UniformValue =
|
|
1250
|
-
| number
|
|
1251
|
-
| string
|
|
1252
|
-
| boolean
|
|
1253
|
-
| three_webgpu.Color
|
|
1254
|
-
| three_webgpu.Vector2
|
|
1255
|
-
| three_webgpu.Vector3
|
|
1256
|
-
| three_webgpu.Vector4
|
|
1257
|
-
| three_webgpu.Matrix3
|
|
1258
|
-
| three_webgpu.Matrix4
|
|
1259
|
-
| three_webgpu.Euler
|
|
1260
|
-
| three_webgpu.Quaternion
|
|
1261
|
-
| { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
|
|
1262
|
-
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1263
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1264
|
-
| UniformNode
|
|
1265
|
-
|
|
1266
|
-
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1267
|
-
type UniformInputRecord = Record<string, UniformValue>
|
|
1268
|
-
}
|
|
1269
|
-
|
|
1270
|
-
//* Module Augmentation ==============================
|
|
1271
|
-
|
|
1272
|
-
declare module 'three/tsl' {
|
|
1273
|
-
/**
|
|
1274
|
-
* Fn with array parameter destructuring
|
|
1275
|
-
* @example Fn(([uv, skew]) => { ... })
|
|
1276
|
-
*/
|
|
1277
|
-
export function Fn<R extends Node = Node>(
|
|
1278
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1279
|
-
): ShaderCallable<R>
|
|
1280
|
-
|
|
1281
|
-
/**
|
|
1282
|
-
* Fn with object parameter destructuring
|
|
1283
|
-
* @example Fn(({ color, intensity }) => { ... })
|
|
1284
|
-
*/
|
|
1285
|
-
export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
|
|
1286
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1287
|
-
): ShaderCallable<R>
|
|
1288
|
-
|
|
1289
|
-
/**
|
|
1290
|
-
* Fn with array params + layout
|
|
1291
|
-
* @example Fn(([a, b]) => { ... }, { layout: [...] })
|
|
1292
|
-
*/
|
|
1293
|
-
export function Fn<R extends Node = Node>(
|
|
1294
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1295
|
-
layout: { layout?: unknown },
|
|
1296
|
-
): ShaderCallable<R>
|
|
1297
|
-
|
|
1298
|
-
/**
|
|
1299
|
-
* Fn with object params + layout
|
|
1300
|
-
*/
|
|
1301
|
-
export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
|
|
1302
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1303
|
-
layout: { layout?: unknown },
|
|
1304
|
-
): ShaderCallable<R>
|
|
1305
|
-
}
|
|
1306
|
-
|
|
1307
|
-
declare global {
|
|
1308
|
-
/**
|
|
1309
|
-
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1310
|
-
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1311
|
-
* is r185, so the new name is the only one.
|
|
1312
|
-
*/
|
|
1313
|
-
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1314
|
-
|
|
1315
|
-
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1316
|
-
type PassRecord = Record<string, any>
|
|
1317
|
-
|
|
1318
|
-
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1319
|
-
type RenderPipelineSetupCallback = (state: RootState) => PassRecord | void
|
|
1320
|
-
|
|
1321
|
-
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1322
|
-
type RenderPipelineMainCallback = (state: RootState) => PassRecord | void
|
|
1323
|
-
|
|
1324
|
-
/** Return type for useRenderPipeline hook */
|
|
1325
|
-
interface UseRenderPipelineReturn {
|
|
1326
|
-
/** Current passes from state */
|
|
1327
|
-
passes: PassRecord
|
|
1328
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1329
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1330
|
-
/** Clear all passes from state */
|
|
1331
|
-
clearPasses: () => void
|
|
1332
|
-
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1333
|
-
reset: () => void
|
|
1334
|
-
/** Re-run setup/main callbacks with current closure values */
|
|
1335
|
-
rebuild: () => void
|
|
1336
|
-
/** True when RenderPipeline is configured and ready */
|
|
1337
|
-
isReady: boolean
|
|
1338
|
-
}
|
|
1339
|
-
}
|
|
1340
|
-
|
|
1341
1078
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
1342
1079
|
|
|
1343
1080
|
interface MathRepresentation {
|
|
@@ -1414,10 +1151,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1414
1151
|
|
|
1415
1152
|
/**
|
|
1416
1153
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1417
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1154
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1155
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1418
1156
|
*/
|
|
1419
1157
|
type NodeProps<P> = {
|
|
1420
|
-
[K in keyof P as P[K] extends
|
|
1158
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1421
1159
|
}
|
|
1422
1160
|
|
|
1423
1161
|
interface ReactProps<P> {
|
|
@@ -1438,11 +1176,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1438
1176
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1439
1177
|
}
|
|
1440
1178
|
|
|
1179
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1180
|
+
type Object3DMethod = NonNullable<
|
|
1181
|
+
{
|
|
1182
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1183
|
+
}[keyof Object3D]
|
|
1184
|
+
>
|
|
1185
|
+
|
|
1441
1186
|
type ThreeExports = typeof import('three') & typeof import('three/webgpu')
|
|
1442
1187
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1443
1188
|
|
|
1444
1189
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1445
|
-
|
|
1190
|
+
/**
|
|
1191
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1192
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1193
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1194
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1195
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1196
|
+
*/
|
|
1197
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
|
|
1198
|
+
object: object
|
|
1199
|
+
ref?: React.Ref<any>
|
|
1200
|
+
[prop: string]: unknown
|
|
1201
|
+
}
|
|
1446
1202
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1447
1203
|
threeAudio: ThreeElementsImpl['audio']
|
|
1448
1204
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1483,6 +1239,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1483
1239
|
type three_d_Matrix4 = Matrix4;
|
|
1484
1240
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1485
1241
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1242
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1486
1243
|
type three_d_Quaternion = Quaternion;
|
|
1487
1244
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1488
1245
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1497,7 +1254,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1497
1254
|
type three_d_Vector4 = Vector4;
|
|
1498
1255
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1499
1256
|
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 };
|
|
1257
|
+
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
1258
|
}
|
|
1502
1259
|
|
|
1503
1260
|
/**
|
|
@@ -1635,9 +1392,9 @@ type EnvironmentProps = {
|
|
|
1635
1392
|
blur?: number;
|
|
1636
1393
|
backgroundBlurriness?: number;
|
|
1637
1394
|
backgroundIntensity?: number;
|
|
1638
|
-
backgroundRotation?: Euler
|
|
1395
|
+
backgroundRotation?: Euler;
|
|
1639
1396
|
environmentIntensity?: number;
|
|
1640
|
-
environmentRotation?: Euler
|
|
1397
|
+
environmentRotation?: Euler;
|
|
1641
1398
|
map?: Texture$1;
|
|
1642
1399
|
preset?: PresetsType;
|
|
1643
1400
|
scene?: Scene | React$1.RefObject<Scene>;
|
|
@@ -1721,7 +1478,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
|
|
|
1721
1478
|
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
1479
|
declare module '@react-three/fiber' {
|
|
1723
1480
|
interface ThreeElements {
|
|
1724
|
-
groundProjectedEnvImpl: ThreeElement
|
|
1481
|
+
groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
|
|
1725
1482
|
}
|
|
1726
1483
|
}
|
|
1727
1484
|
/**
|
|
@@ -1846,7 +1603,48 @@ declare function createEvents(store: RootStore): {
|
|
|
1846
1603
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1847
1604
|
};
|
|
1848
1605
|
/** Default R3F event manager for web */
|
|
1849
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1606
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1607
|
+
|
|
1608
|
+
interface RootExtension {
|
|
1609
|
+
/** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
|
|
1610
|
+
* set up are not set up a second time, but get the new entry's dispose and hmr. */
|
|
1611
|
+
name: string;
|
|
1612
|
+
/**
|
|
1613
|
+
* Called once per root, after its renderer exists and before `onCreated` and the first frame.
|
|
1614
|
+
* `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
|
|
1615
|
+
* to the primary canvas. Return fields to merge into the root's state, or nothing.
|
|
1616
|
+
*/
|
|
1617
|
+
setup?(store: RootStore): Partial<RootState> | void;
|
|
1618
|
+
/** Called when a root this extension set up unmounts. */
|
|
1619
|
+
dispose?(store: RootStore): void;
|
|
1620
|
+
/** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
|
|
1621
|
+
hmr?(store: RootStore): void;
|
|
1622
|
+
}
|
|
1623
|
+
/**
|
|
1624
|
+
* Register an extension. It is set up on every live root immediately, and on every root created
|
|
1625
|
+
* afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
|
|
1626
|
+
* it already set up keep its state and still get its dispose when they unmount.
|
|
1627
|
+
*/
|
|
1628
|
+
declare function registerRootExtension(extension: RootExtension): () => void;
|
|
1629
|
+
/**
|
|
1630
|
+
* Point a root's default render job at a different render function, or back at
|
|
1631
|
+
* `renderer.render(scene, camera)` with `null`.
|
|
1632
|
+
*
|
|
1633
|
+
* The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
|
|
1634
|
+
* boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
|
|
1635
|
+
*/
|
|
1636
|
+
declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
|
|
1637
|
+
|
|
1638
|
+
/**
|
|
1639
|
+
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
1640
|
+
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
1641
|
+
*/
|
|
1642
|
+
declare function useStore(): RootStore;
|
|
1643
|
+
/**
|
|
1644
|
+
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
1645
|
+
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
1646
|
+
*/
|
|
1647
|
+
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
1850
1648
|
|
|
1851
1649
|
/**
|
|
1852
1650
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -1879,7 +1677,7 @@ declare namespace useLoader {
|
|
|
1879
1677
|
*
|
|
1880
1678
|
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
1881
1679
|
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
1882
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
1680
|
+
* @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
|
|
1883
1681
|
*
|
|
1884
1682
|
* @example
|
|
1885
1683
|
* // Simple priority (backwards compat)
|
|
@@ -2090,16 +1888,6 @@ declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
|
|
|
2090
1888
|
declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
|
|
2091
1889
|
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
|
|
2092
1890
|
|
|
2093
|
-
/**
|
|
2094
|
-
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
2095
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2096
|
-
*/
|
|
2097
|
-
declare function useStore(): RootStore;
|
|
2098
|
-
/**
|
|
2099
|
-
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
2100
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
2101
|
-
*/
|
|
2102
|
-
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
2103
1891
|
/**
|
|
2104
1892
|
* Exposes an object's {@link Instance}.
|
|
2105
1893
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2175,7 +1963,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2175
1963
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2176
1964
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2177
1965
|
*
|
|
2178
|
-
*
|
|
1966
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
1967
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
1968
|
+
*
|
|
1969
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2179
1970
|
* @param frames - Number of frames to request (default: 1)
|
|
2180
1971
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2181
1972
|
*
|
|
@@ -2186,14 +1977,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2186
1977
|
* Advances the frameloop and runs render effects.
|
|
2187
1978
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2188
1979
|
*
|
|
1980
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
1981
|
+
* registered root is stepped for backwards compatibility.
|
|
1982
|
+
*
|
|
2189
1983
|
* @param timestamp - The timestamp to use for this frame
|
|
2190
1984
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2191
|
-
* @param state -
|
|
2192
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
1985
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2193
1986
|
*
|
|
2194
1987
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2195
1988
|
*/
|
|
2196
|
-
declare function advance(timestamp: number): void;
|
|
1989
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2197
1990
|
|
|
2198
1991
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2199
1992
|
declare function ReactReconciler<
|
|
@@ -3238,6 +3031,7 @@ declare namespace ReactReconciler {
|
|
|
3238
3031
|
|
|
3239
3032
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3240
3033
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3034
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3241
3035
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3242
3036
|
|
|
3243
3037
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3262,6 +3056,7 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
|
|
|
3262
3056
|
declare function flushSync<R>(fn: () => R): R;
|
|
3263
3057
|
|
|
3264
3058
|
declare const context: React$1.Context<RootStore>;
|
|
3059
|
+
|
|
3265
3060
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3266
3061
|
|
|
3267
3062
|
/**
|
|
@@ -3515,7 +3310,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
|
|
|
3515
3310
|
declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
|
|
3516
3311
|
/**
|
|
3517
3312
|
* Triggers an update for an instance.
|
|
3518
|
-
*
|
|
3313
|
+
* Invalidates the frame if the root is in demand mode.
|
|
3519
3314
|
*
|
|
3520
3315
|
* @param instance - Instance to invalidate
|
|
3521
3316
|
*/
|
|
@@ -3681,29 +3476,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3681
3476
|
* Used to identify values that should be resolved from refs after mount.
|
|
3682
3477
|
*/
|
|
3683
3478
|
declare const FROM_REF: unique symbol;
|
|
3479
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3480
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3481
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3482
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3483
|
+
transform?: (value: T) => R;
|
|
3484
|
+
}
|
|
3684
3485
|
/**
|
|
3685
3486
|
* Defers prop application until the referenced object is available.
|
|
3686
3487
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3687
3488
|
*
|
|
3489
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3490
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3491
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3492
|
+
* what gets assigned.
|
|
3493
|
+
*
|
|
3688
3494
|
* @param ref - React ref object to resolve at mount time
|
|
3689
|
-
* @
|
|
3495
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3496
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
3690
3497
|
*
|
|
3691
3498
|
* @example
|
|
3692
3499
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3693
3500
|
*
|
|
3694
3501
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3695
3502
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3503
|
+
*
|
|
3504
|
+
* @example
|
|
3505
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3506
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
3696
3507
|
*/
|
|
3697
3508
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3509
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
3698
3510
|
/**
|
|
3699
3511
|
* Type guard to check if a value is a fromRef marker.
|
|
3700
3512
|
*
|
|
3701
3513
|
* @param value - Value to check
|
|
3702
3514
|
* @returns True if value is a fromRef marker
|
|
3703
3515
|
*/
|
|
3704
|
-
declare function isFromRef(value: unknown): value is
|
|
3705
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3706
|
-
};
|
|
3516
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3707
3517
|
|
|
3708
3518
|
/**
|
|
3709
3519
|
* Symbol marker for mount-only method calls.
|
|
@@ -3730,7 +3540,15 @@ declare const ONCE: unique symbol;
|
|
|
3730
3540
|
* // No arguments
|
|
3731
3541
|
* <geometry center={once()} />
|
|
3732
3542
|
*/
|
|
3733
|
-
declare function once<
|
|
3543
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3544
|
+
/**
|
|
3545
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3546
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3547
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3548
|
+
*
|
|
3549
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3550
|
+
*/
|
|
3551
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
3734
3552
|
/**
|
|
3735
3553
|
* Type guard to check if a value is a once marker.
|
|
3736
3554
|
*
|
|
@@ -3747,5 +3565,5 @@ declare function isOnce(value: unknown): value is {
|
|
|
3747
3565
|
*/
|
|
3748
3566
|
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3749
3567
|
|
|
3750
|
-
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 };
|
|
3751
|
-
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge,
|
|
3568
|
+
export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, registerRootExtension, removeInteractivity, resolve, setRenderOverride, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
|
|
3569
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, 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, NodeProps, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootExtension, RootState, RootStore, SetBlock, Size, 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 };
|