@react-three/fiber 10.0.0-alpha.3 → 10.0.0-alpha.5
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 +143 -90
- package/dist/index.d.cts +288 -143
- package/dist/index.d.mts +288 -143
- package/dist/index.d.ts +286 -169
- package/dist/index.mjs +143 -90
- package/dist/legacy.cjs +141 -92
- package/dist/legacy.d.cts +291 -150
- package/dist/legacy.d.mts +291 -150
- package/dist/legacy.d.ts +289 -174
- package/dist/legacy.mjs +141 -92
- package/dist/webgpu/index.cjs +260 -182
- package/dist/webgpu/index.d.cts +368 -254
- package/dist/webgpu/index.d.mts +368 -254
- package/dist/webgpu/index.d.ts +366 -280
- package/dist/webgpu/index.mjs +260 -182
- package/package.json +2 -2
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';
|
|
@@ -14,20 +15,6 @@ import { Options } from 'react-use-measure';
|
|
|
14
15
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
15
16
|
import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
|
|
16
17
|
|
|
17
|
-
function _mergeNamespaces(n, m) {
|
|
18
|
-
m.forEach(function (e) {
|
|
19
|
-
e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
|
|
20
|
-
if (k !== 'default' && !(k in n)) {
|
|
21
|
-
var d = Object.getOwnPropertyDescriptor(e, k);
|
|
22
|
-
Object.defineProperty(n, k, d.get ? d : {
|
|
23
|
-
enumerable: true,
|
|
24
|
-
get: function () { return e[k]; }
|
|
25
|
-
});
|
|
26
|
-
}
|
|
27
|
-
});
|
|
28
|
-
});
|
|
29
|
-
return Object.freeze(n);
|
|
30
|
-
}
|
|
31
18
|
|
|
32
19
|
/**
|
|
33
20
|
* @fileoverview Internal Three.js re-exports - DEFAULT ENTRY
|
|
@@ -47,19 +34,9 @@ function _mergeNamespaces(n, m) {
|
|
|
47
34
|
declare const R3F_BUILD_LEGACY = true;
|
|
48
35
|
declare const R3F_BUILD_WEBGPU = true;
|
|
49
36
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
CubeRenderTargetCompat: CubeRenderTarget,
|
|
54
|
-
Inspector: Inspector,
|
|
55
|
-
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
56
|
-
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
57
|
-
RenderTargetCompat: RenderTarget,
|
|
58
|
-
WebGLCubeRenderTarget: WebGLCubeRenderTarget,
|
|
59
|
-
WebGLRenderTarget: WebGLRenderTarget,
|
|
60
|
-
WebGLRenderer: WebGLRenderer,
|
|
61
|
-
WebGLRendererParameters: WebGLRendererParameters
|
|
62
|
-
}, [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
|
+
|
|
63
40
|
|
|
64
41
|
//* Utility Types ==============================
|
|
65
42
|
|
|
@@ -347,6 +324,7 @@ type BufferLike =
|
|
|
347
324
|
| Uint16Array
|
|
348
325
|
| Int16Array
|
|
349
326
|
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
327
|
+
| THREE$1.InterleavedBufferAttribute
|
|
350
328
|
| Node // TSL buffer nodes (instancedArray, storage)
|
|
351
329
|
|
|
352
330
|
/** Flat record of buffer-like values (no nested scopes) */
|
|
@@ -358,6 +336,25 @@ type BufferRecord = Record<string, BufferLike>
|
|
|
358
336
|
*/
|
|
359
337
|
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
360
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
|
+
|
|
361
358
|
//* Storage Types (useGPUStorage) ========================================
|
|
362
359
|
|
|
363
360
|
/**
|
|
@@ -372,7 +369,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
|
372
369
|
* ```
|
|
373
370
|
*/
|
|
374
371
|
type StorageLike =
|
|
375
|
-
| 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
|
|
376
375
|
| Data3DTexture // 3D texture (can be used as storage)
|
|
377
376
|
| Node // TSL storage texture nodes (storageTexture)
|
|
378
377
|
|
|
@@ -491,11 +490,28 @@ interface InternalState {
|
|
|
491
490
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
492
491
|
container?: THREE$1.Object3D
|
|
493
492
|
/**
|
|
494
|
-
* CanvasTarget
|
|
495
|
-
*
|
|
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.
|
|
496
500
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
497
501
|
*/
|
|
498
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
|
|
499
515
|
/**
|
|
500
516
|
* Whether multi-canvas rendering is active.
|
|
501
517
|
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
@@ -605,7 +621,7 @@ interface RootState {
|
|
|
605
621
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
606
622
|
uniforms: UniformStore
|
|
607
623
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
608
|
-
nodes:
|
|
624
|
+
nodes: NodeStore
|
|
609
625
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
610
626
|
buffers: BufferStore
|
|
611
627
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -617,7 +633,7 @@ interface RootState {
|
|
|
617
633
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
618
634
|
renderPipeline: ThreeRenderPipeline | null
|
|
619
635
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
620
|
-
passes:
|
|
636
|
+
passes: PassRecord
|
|
621
637
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
622
638
|
_hmrVersion: number
|
|
623
639
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -705,12 +721,19 @@ type DefaultRendererProps = {
|
|
|
705
721
|
*/
|
|
706
722
|
interface CanvasSchedulerConfig {
|
|
707
723
|
/**
|
|
708
|
-
*
|
|
709
|
-
* Pass the `id` of another canvas.
|
|
724
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
710
725
|
*/
|
|
711
|
-
|
|
726
|
+
before?: string | string[]
|
|
712
727
|
/**
|
|
713
|
-
*
|
|
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).
|
|
714
737
|
*/
|
|
715
738
|
fps?: number
|
|
716
739
|
}
|
|
@@ -797,14 +820,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
797
820
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
798
821
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
799
822
|
dpr?: Dpr
|
|
800
|
-
/**
|
|
801
|
-
|
|
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> }
|
|
802
828
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
803
829
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
804
830
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
805
831
|
camera?: CameraProps
|
|
806
832
|
/** An R3F event manager to manage elements' pointer events */
|
|
807
|
-
events?: (store: RootStore) => EventManager<
|
|
833
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
808
834
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
809
835
|
onCreated?: (state: RootState) => void
|
|
810
836
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -1033,7 +1059,7 @@ interface CanvasProps
|
|
|
1033
1059
|
*/
|
|
1034
1060
|
resize?: Options
|
|
1035
1061
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1036
|
-
eventSource?:
|
|
1062
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1037
1063
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1038
1064
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1039
1065
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1141,81 +1167,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1141
1167
|
|
|
1142
1168
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1143
1169
|
|
|
1144
|
-
//* Global Types ==============================
|
|
1170
|
+
//* Global TSL Types ==============================
|
|
1145
1171
|
|
|
1146
1172
|
declare global {
|
|
1147
1173
|
/**
|
|
1148
|
-
*
|
|
1149
|
-
*
|
|
1150
|
-
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1151
|
-
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1152
|
-
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1153
|
-
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1154
|
-
* arity when three made `UniformNode` two-parameter.
|
|
1155
|
-
*
|
|
1156
|
-
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1157
|
-
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1158
|
-
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1159
|
-
* installed three instead of needing to be mirrored by hand.
|
|
1174
|
+
* Broad callable-node fallback for dynamic store readers.
|
|
1175
|
+
* Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
|
|
1160
1176
|
*/
|
|
1161
|
-
type
|
|
1177
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1178
|
+
readonly shaderNode: unknown
|
|
1179
|
+
readonly id: number
|
|
1180
|
+
}
|
|
1162
1181
|
|
|
1163
|
-
/**
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
* @example
|
|
1169
|
-
* ```tsx
|
|
1170
|
-
* // Define a shader function
|
|
1171
|
-
* const blendColorFn = Fn(([color1, color2, factor]) => {
|
|
1172
|
-
* return mix(color1, color2, factor)
|
|
1173
|
-
* })
|
|
1174
|
-
*
|
|
1175
|
-
* // Type when retrieving from nodes store
|
|
1176
|
-
* const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
|
|
1177
|
-
*
|
|
1178
|
-
* // Or with specific return type
|
|
1179
|
-
* const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
|
|
1180
|
-
* ```
|
|
1181
|
-
*/
|
|
1182
|
-
type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
|
|
1182
|
+
/** Legacy structural node accepted when at least one historical marker exists. */
|
|
1183
|
+
type LegacyTSLNodeLike = {
|
|
1184
|
+
label?: ((label: string) => unknown) | string
|
|
1185
|
+
setName?: (name: string) => unknown
|
|
1186
|
+
} & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
|
|
1183
1187
|
|
|
1184
|
-
/**
|
|
1185
|
-
|
|
1186
|
-
* This is the common return type for TSL operations (add, mul, sin, etc.)
|
|
1187
|
-
*
|
|
1188
|
-
* @example
|
|
1189
|
-
* ```tsx
|
|
1190
|
-
* const { wobble } = nodes as { wobble: ShaderNodeRef }
|
|
1191
|
-
* ```
|
|
1192
|
-
*/
|
|
1193
|
-
type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
|
|
1188
|
+
/** Node type accepted by broad dynamic node-store readers. */
|
|
1189
|
+
type TSLNodeType = three_webgpu.Node | CallableTSLNode
|
|
1194
1190
|
|
|
1195
1191
|
/**
|
|
1196
|
-
*
|
|
1197
|
-
*
|
|
1198
|
-
*
|
|
1199
|
-
*
|
|
1200
|
-
* - Node: base Three.js node type
|
|
1201
|
-
* - ShaderCallable: function nodes created with Fn()
|
|
1202
|
-
* - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
|
|
1203
|
-
*
|
|
1204
|
-
* @example
|
|
1205
|
-
* ```tsx
|
|
1206
|
-
* // In useLocalNodes, nodes are typed as TSLNodeType
|
|
1207
|
-
* const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
|
|
1208
|
-
* positionNode: nodes.myPosition, // Works - Node is in union
|
|
1209
|
-
* blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
|
|
1210
|
-
* }))
|
|
1211
|
-
*
|
|
1212
|
-
* // Can narrow with type guard or assertion when needed
|
|
1213
|
-
* if (typeof blendColorFn === 'function') {
|
|
1214
|
-
* blendColorFn(someColor, 0.5)
|
|
1215
|
-
* }
|
|
1216
|
-
* ```
|
|
1192
|
+
* Derive Three's shader node type from an existing node or a supported raw input.
|
|
1193
|
+
* Existing InputNode generics take precedence over structural value normalization.
|
|
1194
|
+
* Both generics must be inferred because Three's UniformNode intersects an unknown-typed
|
|
1195
|
+
* InputNode base with its concrete InputNode specialization.
|
|
1217
1196
|
*/
|
|
1218
|
-
type
|
|
1197
|
+
type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
|
|
1198
|
+
? TNodeType
|
|
1199
|
+
: T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
|
|
1200
|
+
? TNodeType
|
|
1201
|
+
: T extends number
|
|
1202
|
+
? 'float'
|
|
1203
|
+
: T extends boolean
|
|
1204
|
+
? 'bool'
|
|
1205
|
+
: T extends string | three_webgpu.Color | { r: number; g: number; b: number }
|
|
1206
|
+
? 'color'
|
|
1207
|
+
: T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
|
|
1208
|
+
? 'vec4'
|
|
1209
|
+
: T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
|
|
1210
|
+
? 'vec3'
|
|
1211
|
+
: T extends three_webgpu.Vector2 | { x: number; y: number }
|
|
1212
|
+
? 'vec2'
|
|
1213
|
+
: T extends three_webgpu.Matrix4
|
|
1214
|
+
? 'mat4'
|
|
1215
|
+
: T extends three_webgpu.Matrix3
|
|
1216
|
+
? 'mat3'
|
|
1217
|
+
: T extends three_webgpu.Matrix2
|
|
1218
|
+
? 'mat2'
|
|
1219
|
+
: unknown
|
|
1220
|
+
|
|
1221
|
+
/** Derive the normalized JavaScript value stored by a uniform node. */
|
|
1222
|
+
type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
|
|
1223
|
+
? TValue
|
|
1224
|
+
: T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
|
|
1225
|
+
? TValue
|
|
1226
|
+
: T extends string | { r: number; g: number; b: number }
|
|
1227
|
+
? three_webgpu.Color
|
|
1228
|
+
: T extends { x: number; y: number; z: number; w: number }
|
|
1229
|
+
? three_webgpu.Vector4
|
|
1230
|
+
: T extends { x: number; y: number; z: number }
|
|
1231
|
+
? three_webgpu.Vector3
|
|
1232
|
+
: T extends { x: number; y: number }
|
|
1233
|
+
? three_webgpu.Vector2
|
|
1234
|
+
: T extends number
|
|
1235
|
+
? number
|
|
1236
|
+
: T extends boolean
|
|
1237
|
+
? boolean
|
|
1238
|
+
: T
|
|
1239
|
+
|
|
1240
|
+
/** Three's exact UniformNode with shader and value generics derived from an input. */
|
|
1241
|
+
type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
|
|
1242
|
+
|
|
1243
|
+
/** Preserve every input key while mapping values to exact Three uniform nodes. */
|
|
1244
|
+
type UniformNodesFor<T extends UniformInputRecord> = {
|
|
1245
|
+
[K in keyof T]: UniformNodeFor<T[K]>
|
|
1246
|
+
}
|
|
1247
|
+
|
|
1248
|
+
/** Backward-compatible single-parameter uniform alias. */
|
|
1249
|
+
type UniformNode<T = unknown> = UniformNodeFor<T>
|
|
1219
1250
|
|
|
1220
1251
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1221
1252
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1240,7 +1271,7 @@ declare global {
|
|
|
1240
1271
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1241
1272
|
* Supports:
|
|
1242
1273
|
* - Primitives: number, string (color), boolean
|
|
1243
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1274
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1244
1275
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1245
1276
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1246
1277
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1253,88 +1284,124 @@ declare global {
|
|
|
1253
1284
|
| three_webgpu.Vector2
|
|
1254
1285
|
| three_webgpu.Vector3
|
|
1255
1286
|
| three_webgpu.Vector4
|
|
1287
|
+
| three_webgpu.Matrix2
|
|
1256
1288
|
| three_webgpu.Matrix3
|
|
1257
1289
|
| three_webgpu.Matrix4
|
|
1258
|
-
|
|
|
1259
|
-
|
|
|
1260
|
-
| { x: number; y
|
|
1290
|
+
| { x: number; y: number }
|
|
1291
|
+
| { x: number; y: number; z: number }
|
|
1292
|
+
| { x: number; y: number; z: number; w: number }
|
|
1261
1293
|
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1262
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1294
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1263
1295
|
| UniformNode
|
|
1264
1296
|
|
|
1265
1297
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1266
1298
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1267
1299
|
}
|
|
1268
1300
|
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
declare module 'three/tsl' {
|
|
1301
|
+
declare global {
|
|
1272
1302
|
/**
|
|
1273
|
-
*
|
|
1274
|
-
*
|
|
1303
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1304
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1305
|
+
* is r185, so the new name is the only one.
|
|
1275
1306
|
*/
|
|
1276
|
-
|
|
1277
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1278
|
-
): ShaderCallable<R>
|
|
1307
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1279
1308
|
|
|
1280
1309
|
/**
|
|
1281
|
-
*
|
|
1282
|
-
*
|
|
1310
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1311
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1312
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1283
1313
|
*/
|
|
1284
|
-
|
|
1285
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1286
|
-
): ShaderCallable<R>
|
|
1314
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1287
1315
|
|
|
1288
1316
|
/**
|
|
1289
|
-
*
|
|
1290
|
-
*
|
|
1317
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1318
|
+
*
|
|
1319
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1320
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1321
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1322
|
+
* {@link RenderPipelineCallbackState}.
|
|
1323
|
+
*
|
|
1324
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1325
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1326
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1327
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1328
|
+
*
|
|
1329
|
+
* The index signature admits `undefined` because a key may simply not be registered, and
|
|
1330
|
+
* because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
|
|
1331
|
+
* optional property whose type excludes `undefined` from the index signature is an error
|
|
1332
|
+
* (TS2411) for every consumer compiling these declarations.
|
|
1291
1333
|
*/
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1334
|
+
interface PassRecord {
|
|
1335
|
+
scenePass?: ScenePassNode
|
|
1336
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1337
|
+
}
|
|
1296
1338
|
|
|
1297
1339
|
/**
|
|
1298
|
-
*
|
|
1340
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1341
|
+
*
|
|
1342
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1343
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1344
|
+
*
|
|
1345
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1346
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1299
1347
|
*/
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1348
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1349
|
+
renderPipeline: ThreeRenderPipeline
|
|
1350
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1351
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1352
|
+
isLegacy: false
|
|
1353
|
+
}
|
|
1305
1354
|
|
|
1306
|
-
declare global {
|
|
1307
1355
|
/**
|
|
1308
|
-
*
|
|
1309
|
-
*
|
|
1310
|
-
* is
|
|
1356
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1357
|
+
*
|
|
1358
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1359
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1360
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1361
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1311
1362
|
*/
|
|
1312
|
-
type
|
|
1313
|
-
|
|
1314
|
-
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1315
|
-
type PassRecord = Record<string, any>
|
|
1363
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1316
1364
|
|
|
1317
1365
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1318
|
-
type RenderPipelineSetupCallback = (state:
|
|
1366
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1319
1367
|
|
|
1320
1368
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1321
|
-
type RenderPipelineMainCallback = (state:
|
|
1369
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1322
1370
|
|
|
1323
|
-
/**
|
|
1324
|
-
interface
|
|
1371
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1372
|
+
interface UseRenderPipelineActions {
|
|
1325
1373
|
/** Current passes from state */
|
|
1326
1374
|
passes: PassRecord
|
|
1327
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1328
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1329
1375
|
/** Clear all passes from state */
|
|
1330
1376
|
clearPasses: () => void
|
|
1331
1377
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1332
1378
|
reset: () => void
|
|
1333
1379
|
/** Re-run setup/main callbacks with current closure values */
|
|
1334
1380
|
rebuild: () => void
|
|
1335
|
-
/** True when RenderPipeline is configured and ready */
|
|
1336
|
-
isReady: boolean
|
|
1337
1381
|
}
|
|
1382
|
+
|
|
1383
|
+
/**
|
|
1384
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1385
|
+
*
|
|
1386
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1387
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1388
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1389
|
+
*/
|
|
1390
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1391
|
+
(
|
|
1392
|
+
| {
|
|
1393
|
+
/** True when RenderPipeline is configured and ready */
|
|
1394
|
+
isReady: true
|
|
1395
|
+
/** RenderPipeline instance */
|
|
1396
|
+
renderPipeline: ThreeRenderPipeline
|
|
1397
|
+
}
|
|
1398
|
+
| {
|
|
1399
|
+
/** False until the pipeline has been created */
|
|
1400
|
+
isReady: false
|
|
1401
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1402
|
+
renderPipeline: null
|
|
1403
|
+
}
|
|
1404
|
+
)
|
|
1338
1405
|
}
|
|
1339
1406
|
|
|
1340
1407
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -1413,10 +1480,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1413
1480
|
|
|
1414
1481
|
/**
|
|
1415
1482
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1416
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1483
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1484
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1417
1485
|
*/
|
|
1418
1486
|
type NodeProps<P> = {
|
|
1419
|
-
[K in keyof P as P[K] extends
|
|
1487
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1420
1488
|
}
|
|
1421
1489
|
|
|
1422
1490
|
interface ReactProps<P> {
|
|
@@ -1437,11 +1505,30 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1437
1505
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1438
1506
|
}
|
|
1439
1507
|
|
|
1508
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1509
|
+
type Object3DMethod = NonNullable<
|
|
1510
|
+
{
|
|
1511
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1512
|
+
}[keyof Object3D]
|
|
1513
|
+
>
|
|
1514
|
+
|
|
1440
1515
|
type ThreeExports = typeof import('three') & typeof import('three/webgpu')
|
|
1441
1516
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1442
1517
|
|
|
1443
1518
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1444
|
-
|
|
1519
|
+
/**
|
|
1520
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1521
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1522
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1523
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1524
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1525
|
+
*/
|
|
1526
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | 'onUpdate' | Object3DMethod> & {
|
|
1527
|
+
object: object
|
|
1528
|
+
ref?: React.Ref<any>
|
|
1529
|
+
onUpdate?: (self: any) => void
|
|
1530
|
+
[prop: string]: unknown
|
|
1531
|
+
}
|
|
1445
1532
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1446
1533
|
threeAudio: ThreeElementsImpl['audio']
|
|
1447
1534
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1482,6 +1569,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1482
1569
|
type three_d_Matrix4 = Matrix4;
|
|
1483
1570
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1484
1571
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1572
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1485
1573
|
type three_d_Quaternion = Quaternion;
|
|
1486
1574
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1487
1575
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1496,7 +1584,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1496
1584
|
type three_d_Vector4 = Vector4;
|
|
1497
1585
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1498
1586
|
declare namespace three_d {
|
|
1499
|
-
export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
|
|
1587
|
+
export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Object3DMethod as Object3DMethod, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
|
|
1500
1588
|
}
|
|
1501
1589
|
|
|
1502
1590
|
/**
|
|
@@ -1845,7 +1933,7 @@ declare function createEvents(store: RootStore): {
|
|
|
1845
1933
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1846
1934
|
};
|
|
1847
1935
|
/** Default R3F event manager for web */
|
|
1848
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1936
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1849
1937
|
|
|
1850
1938
|
/**
|
|
1851
1939
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -1878,7 +1966,7 @@ declare namespace useLoader {
|
|
|
1878
1966
|
*
|
|
1879
1967
|
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
1880
1968
|
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
1881
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
1969
|
+
* @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
|
|
1882
1970
|
*
|
|
1883
1971
|
* @example
|
|
1884
1972
|
* // Simple priority (backwards compat)
|
|
@@ -2174,7 +2262,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2174
2262
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2175
2263
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2176
2264
|
*
|
|
2177
|
-
*
|
|
2265
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
2266
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
2267
|
+
*
|
|
2268
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2178
2269
|
* @param frames - Number of frames to request (default: 1)
|
|
2179
2270
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2180
2271
|
*
|
|
@@ -2185,14 +2276,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2185
2276
|
* Advances the frameloop and runs render effects.
|
|
2186
2277
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2187
2278
|
*
|
|
2279
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2280
|
+
* registered root is stepped for backwards compatibility.
|
|
2281
|
+
*
|
|
2188
2282
|
* @param timestamp - The timestamp to use for this frame
|
|
2189
2283
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2190
|
-
* @param state -
|
|
2191
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2284
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2192
2285
|
*
|
|
2193
2286
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2194
2287
|
*/
|
|
2195
|
-
declare function advance(timestamp: number): void;
|
|
2288
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2196
2289
|
|
|
2197
2290
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2198
2291
|
declare function ReactReconciler<
|
|
@@ -3237,6 +3330,7 @@ declare namespace ReactReconciler {
|
|
|
3237
3330
|
|
|
3238
3331
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3239
3332
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3333
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3240
3334
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3241
3335
|
|
|
3242
3336
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3680,29 +3774,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3680
3774
|
* Used to identify values that should be resolved from refs after mount.
|
|
3681
3775
|
*/
|
|
3682
3776
|
declare const FROM_REF: unique symbol;
|
|
3777
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3778
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3779
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3780
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3781
|
+
transform?: (value: T) => R;
|
|
3782
|
+
}
|
|
3683
3783
|
/**
|
|
3684
3784
|
* Defers prop application until the referenced object is available.
|
|
3685
3785
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3686
3786
|
*
|
|
3787
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3788
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3789
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3790
|
+
* what gets assigned.
|
|
3791
|
+
*
|
|
3687
3792
|
* @param ref - React ref object to resolve at mount time
|
|
3688
|
-
* @
|
|
3793
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3794
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
3689
3795
|
*
|
|
3690
3796
|
* @example
|
|
3691
3797
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3692
3798
|
*
|
|
3693
3799
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3694
3800
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3801
|
+
*
|
|
3802
|
+
* @example
|
|
3803
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3804
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
3695
3805
|
*/
|
|
3696
3806
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3807
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
3697
3808
|
/**
|
|
3698
3809
|
* Type guard to check if a value is a fromRef marker.
|
|
3699
3810
|
*
|
|
3700
3811
|
* @param value - Value to check
|
|
3701
3812
|
* @returns True if value is a fromRef marker
|
|
3702
3813
|
*/
|
|
3703
|
-
declare function isFromRef(value: unknown): value is
|
|
3704
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3705
|
-
};
|
|
3814
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3706
3815
|
|
|
3707
3816
|
/**
|
|
3708
3817
|
* Symbol marker for mount-only method calls.
|
|
@@ -3729,7 +3838,15 @@ declare const ONCE: unique symbol;
|
|
|
3729
3838
|
* // No arguments
|
|
3730
3839
|
* <geometry center={once()} />
|
|
3731
3840
|
*/
|
|
3732
|
-
declare function once<
|
|
3841
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3842
|
+
/**
|
|
3843
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3844
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3845
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3846
|
+
*
|
|
3847
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3848
|
+
*/
|
|
3849
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
3733
3850
|
/**
|
|
3734
3851
|
* Type guard to check if a value is a once marker.
|
|
3735
3852
|
*
|
|
@@ -3747,4 +3864,4 @@ declare function isOnce(value: unknown): value is {
|
|
|
3747
3864
|
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3748
3865
|
|
|
3749
3866
|
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 };
|
|
3750
|
-
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 };
|
|
3867
|
+
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 };
|