@react-three/fiber 10.0.0-canary.dbbe704 → 10.0.0-canary.eb6c14f
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 +2706 -3186
- package/dist/index.d.cts +561 -919
- package/dist/index.d.mts +561 -919
- package/dist/index.d.ts +556 -942
- package/dist/index.mjs +2694 -3173
- package/dist/legacy.cjs +2888 -3378
- package/dist/legacy.d.cts +564 -925
- package/dist/legacy.d.mts +564 -925
- package/dist/legacy.d.ts +560 -947
- package/dist/legacy.mjs +2576 -3065
- package/dist/webgpu/index.cjs +3146 -3460
- package/dist/webgpu/index.d.cts +743 -1030
- package/dist/webgpu/index.d.mts +743 -1030
- package/dist/webgpu/index.d.ts +739 -1054
- package/dist/webgpu/index.mjs +2849 -3166
- package/package.json +6 -5
- package/readme.md +3 -4
- 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/legacy.d.ts
CHANGED
|
@@ -1,30 +1,17 @@
|
|
|
1
1
|
import * as THREE$1 from 'three';
|
|
2
|
-
import { WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1,
|
|
2
|
+
import { WebGLCubeRenderTarget, WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$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, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Frustum, OrthographicCamera } from 'three';
|
|
3
3
|
import * as React$1 from 'react';
|
|
4
4
|
import { ReactNode, Component, RefObject, JSX } from 'react';
|
|
5
5
|
import * as three_webgpu from 'three/webgpu';
|
|
6
|
-
import { WebGPURenderer as WebGPURenderer$1,
|
|
6
|
+
import { WebGPURenderer as WebGPURenderer$1, Node, StorageTexture, Storage3DTexture, StorageArrayTexture, Data3DTexture, CanvasTarget } from 'three/webgpu';
|
|
7
7
|
import { StoreApi } from 'zustand';
|
|
8
8
|
import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
|
|
9
|
+
import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
|
|
10
|
+
export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
|
|
9
11
|
import { Options } from 'react-use-measure';
|
|
10
12
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
11
|
-
import { ThreeElement as ThreeElement$1, Euler as Euler$2 } from '@react-three/fiber';
|
|
12
13
|
import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
|
|
13
14
|
|
|
14
|
-
function _mergeNamespaces(n, m) {
|
|
15
|
-
m.forEach(function (e) {
|
|
16
|
-
e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
|
|
17
|
-
if (k !== 'default' && !(k in n)) {
|
|
18
|
-
var d = Object.getOwnPropertyDescriptor(e, k);
|
|
19
|
-
Object.defineProperty(n, k, d.get ? d : {
|
|
20
|
-
enumerable: true,
|
|
21
|
-
get: function () { return e[k]; }
|
|
22
|
-
});
|
|
23
|
-
}
|
|
24
|
-
});
|
|
25
|
-
});
|
|
26
|
-
return Object.freeze(n);
|
|
27
|
-
}
|
|
28
15
|
|
|
29
16
|
/**
|
|
30
17
|
* @fileoverview Internal Three.js re-exports - LEGACY ENTRY
|
|
@@ -37,24 +24,17 @@ function _mergeNamespaces(n, m) {
|
|
|
37
24
|
declare const R3F_BUILD_LEGACY = true;
|
|
38
25
|
declare const R3F_BUILD_WEBGPU = false;
|
|
39
26
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
declare
|
|
44
|
-
|
|
45
|
-
}
|
|
27
|
+
type Inspector = never;
|
|
28
|
+
/** Not available on the legacy (WebGL-only) entry. */
|
|
29
|
+
declare function loadInspector(): Promise<never>;
|
|
30
|
+
declare class WebGPURenderer {
|
|
31
|
+
constructor();
|
|
32
|
+
}
|
|
46
33
|
|
|
47
34
|
declare const RenderTarget: any;
|
|
48
35
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
Inspector: Inspector,
|
|
52
|
-
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
53
|
-
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
54
|
-
RenderTarget: RenderTarget,
|
|
55
|
-
RenderTargetCompat: WebGLRenderTarget,
|
|
56
|
-
WebGPURenderer: WebGPURenderer
|
|
57
|
-
}, [THREE$1]);
|
|
36
|
+
declare const CubeRenderTarget: any;
|
|
37
|
+
|
|
58
38
|
|
|
59
39
|
//* Utility Types ==============================
|
|
60
40
|
|
|
@@ -148,6 +128,8 @@ interface IntersectionEvent<TSourceEvent> extends Intersection {
|
|
|
148
128
|
unprojectedPoint: THREE$1.Vector3
|
|
149
129
|
/** Normalized event coordinates */
|
|
150
130
|
pointer: THREE$1.Vector2
|
|
131
|
+
/** pointerId of the original event for multiple pointer events */
|
|
132
|
+
pointerId: number
|
|
151
133
|
/** Delta between first click and this event */
|
|
152
134
|
delta: number
|
|
153
135
|
/** The ray that pierced it */
|
|
@@ -224,6 +206,18 @@ interface EventHandlers {
|
|
|
224
206
|
type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
|
|
225
207
|
type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
|
|
226
208
|
|
|
209
|
+
/** Configuration for XR pointer registration (controllers/hands) */
|
|
210
|
+
interface XRPointerConfig {
|
|
211
|
+
/** Ray origin (updated each frame by XR system) */
|
|
212
|
+
ray: THREE$1.Ray
|
|
213
|
+
/** Optional: custom compute function for this pointer */
|
|
214
|
+
compute?: (state: RootState) => void
|
|
215
|
+
/** Pointer type identifier */
|
|
216
|
+
type: 'controller' | 'hand' | 'gaze'
|
|
217
|
+
/** Which hand (for controller/hand types) */
|
|
218
|
+
handedness?: 'left' | 'right'
|
|
219
|
+
}
|
|
220
|
+
|
|
227
221
|
interface EventManager<TTarget> {
|
|
228
222
|
/** Determines if the event layer is active */
|
|
229
223
|
enabled: boolean
|
|
@@ -243,8 +237,21 @@ interface EventManager<TTarget> {
|
|
|
243
237
|
disconnect?: () => void
|
|
244
238
|
/** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
|
|
245
239
|
* explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
|
|
240
|
+
* @param pointerId - Optional pointer ID to update specific pointer only
|
|
246
241
|
*/
|
|
247
|
-
update?: () => void
|
|
242
|
+
update?: (pointerId?: number) => void
|
|
243
|
+
/** Defer pointer move raycasting to frame start (default: true) */
|
|
244
|
+
frameTimedRaycasts?: boolean
|
|
245
|
+
/** Always fire raycaster immediately on scroll events (default: true) */
|
|
246
|
+
alwaysFireOnScroll?: boolean
|
|
247
|
+
/** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
|
|
248
|
+
updateOnFrame?: boolean
|
|
249
|
+
/** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
|
|
250
|
+
flush?: () => void
|
|
251
|
+
/** Register an XR pointer (controller/hand). Returns assigned pointerId */
|
|
252
|
+
registerPointer?: (config: XRPointerConfig) => number
|
|
253
|
+
/** Unregister an XR pointer */
|
|
254
|
+
unregisterPointer?: (pointerId: number) => void
|
|
248
255
|
}
|
|
249
256
|
|
|
250
257
|
interface PointerCaptureTarget {
|
|
@@ -264,227 +271,116 @@ interface VisibilityEntry {
|
|
|
264
271
|
}
|
|
265
272
|
|
|
266
273
|
//* Scheduler Types (useFrame) ==============================
|
|
274
|
+
//
|
|
275
|
+
// The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
|
|
276
|
+
// This file re-exports them and layers r3f's RootState-aware frame state on top,
|
|
277
|
+
// so existing `#types` imports across the codebase keep resolving unchanged.
|
|
267
278
|
|
|
268
279
|
|
|
269
280
|
|
|
270
|
-
//
|
|
281
|
+
// Frame State (r3f-specific) --------------------------------
|
|
271
282
|
|
|
272
283
|
/**
|
|
273
|
-
*
|
|
284
|
+
* State passed to useFrame callbacks (extends RootState with timing).
|
|
274
285
|
*/
|
|
275
|
-
interface
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
phase?: string
|
|
280
|
-
/** Run before this phase or job id */
|
|
281
|
-
before?: string | string[]
|
|
282
|
-
/** Run after this phase or job id */
|
|
283
|
-
after?: string | string[]
|
|
284
|
-
/** Priority within phase. Higher runs first. Default: 0 */
|
|
285
|
-
priority?: number
|
|
286
|
-
/** Max frames per second for this job */
|
|
287
|
-
fps?: number
|
|
288
|
-
/** If true, skip frames when behind. If false, try to catch up. Default: true */
|
|
289
|
-
drop?: boolean
|
|
290
|
-
/** Enable/disable without unregistering. Default: true */
|
|
291
|
-
enabled?: boolean
|
|
292
|
-
}
|
|
286
|
+
interface FrameNextState extends RootState, FrameTimingState {}
|
|
287
|
+
|
|
288
|
+
/** Alias for FrameNextState */
|
|
289
|
+
type FrameState = FrameNextState
|
|
293
290
|
|
|
294
|
-
|
|
295
|
-
type UseFrameOptions = UseFrameNextOptions
|
|
291
|
+
// Callback Types (r3f-specific) --------------------------------
|
|
296
292
|
|
|
297
293
|
/**
|
|
298
|
-
*
|
|
294
|
+
* Callback function for useFrame. Receives the full r3f RootState plus timing.
|
|
299
295
|
*/
|
|
300
|
-
|
|
301
|
-
/** Insert this phase before the specified phase */
|
|
302
|
-
before?: string
|
|
303
|
-
/** Insert this phase after the specified phase */
|
|
304
|
-
after?: string
|
|
305
|
-
}
|
|
296
|
+
type FrameNextCallback = FrameCallback$1<RootState>
|
|
306
297
|
|
|
307
|
-
|
|
298
|
+
/** Alias for FrameNextCallback */
|
|
299
|
+
type FrameCallback = FrameNextCallback
|
|
300
|
+
|
|
301
|
+
//* Buffer Types (useBuffers) ========================================
|
|
308
302
|
|
|
309
303
|
/**
|
|
310
|
-
*
|
|
304
|
+
* Buffer-like types for GPU compute and storage operations.
|
|
305
|
+
* Includes raw CPU arrays, Three.js buffer attributes, and TSL buffer nodes.
|
|
306
|
+
*
|
|
307
|
+
* @example
|
|
308
|
+
* ```tsx
|
|
309
|
+
* const { positions, velocities } = useBuffers(() => ({
|
|
310
|
+
* positions: instancedArray(count, 'vec3'), // StorageBufferNode
|
|
311
|
+
* velocities: new Float32Array(count * 3), // TypedArray
|
|
312
|
+
* }), 'particles')
|
|
313
|
+
* ```
|
|
311
314
|
*/
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
315
|
+
type BufferLike =
|
|
316
|
+
| Float32Array
|
|
317
|
+
| Uint32Array
|
|
318
|
+
| Int32Array
|
|
319
|
+
| Float64Array
|
|
320
|
+
| Uint8Array
|
|
321
|
+
| Int8Array
|
|
322
|
+
| Uint16Array
|
|
323
|
+
| Int16Array
|
|
324
|
+
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
325
|
+
| THREE$1.InterleavedBufferAttribute
|
|
326
|
+
| Node // TSL buffer nodes (instancedArray, storage)
|
|
327
|
+
|
|
328
|
+
/** Flat record of buffer-like values (no nested scopes) */
|
|
329
|
+
type BufferRecord = Record<string, BufferLike>
|
|
322
330
|
|
|
323
331
|
/**
|
|
324
|
-
*
|
|
332
|
+
* Buffer store that can contain both root-level buffers and scoped buffer objects.
|
|
333
|
+
* Structure: { positions: Float32Array, particles: { vel: StorageBufferNode } }
|
|
325
334
|
*/
|
|
326
|
-
|
|
335
|
+
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
327
336
|
|
|
328
|
-
|
|
329
|
-
type FrameState = FrameNextState
|
|
330
|
-
|
|
331
|
-
// Root Options --------------------------------
|
|
337
|
+
//* Node Types (useNodes) ========================================
|
|
332
338
|
|
|
333
339
|
/**
|
|
334
|
-
*
|
|
340
|
+
* Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
|
|
341
|
+
* the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
|
|
342
|
+
* code passes through. Creators are constrained to this same type, so the shape a creator returns
|
|
343
|
+
* and the shape the store holds are one type by construction.
|
|
335
344
|
*/
|
|
336
|
-
|
|
337
|
-
/** State provider for callbacks. Optional in independent mode. */
|
|
338
|
-
getState?: () => any
|
|
339
|
-
/** Error handler for job errors. Falls back to console.error if not provided. */
|
|
340
|
-
onError?: (error: Error) => void
|
|
341
|
-
}
|
|
345
|
+
type NodeLike = TSLNodeType | LegacyTSLNodeLike
|
|
342
346
|
|
|
343
|
-
|
|
347
|
+
/** Flat record of TSL nodes (no nested scopes) */
|
|
348
|
+
type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
|
|
344
349
|
|
|
345
350
|
/**
|
|
346
|
-
*
|
|
351
|
+
* Node store that can contain both root-level nodes and scoped node objects.
|
|
352
|
+
* Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
|
|
347
353
|
*/
|
|
348
|
-
type
|
|
354
|
+
type NodeStore = Record<string, NodeLike | NodeRecord>
|
|
349
355
|
|
|
350
|
-
|
|
351
|
-
type FrameCallback = FrameNextCallback
|
|
352
|
-
|
|
353
|
-
// Controls returned from useFrame --------------------------------
|
|
356
|
+
//* Storage Types (useGPUStorage) ========================================
|
|
354
357
|
|
|
355
358
|
/**
|
|
356
|
-
*
|
|
359
|
+
* GPU storage types for texture-based storage operations.
|
|
360
|
+
* Includes Three.js storage textures and TSL storage texture nodes.
|
|
361
|
+
*
|
|
362
|
+
* @example
|
|
363
|
+
* ```tsx
|
|
364
|
+
* const { heightMap } = useGPUStorage(() => ({
|
|
365
|
+
* heightMap: new StorageTexture(512, 512),
|
|
366
|
+
* }), 'terrain')
|
|
367
|
+
* ```
|
|
357
368
|
*/
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
step(timestamp?: number): void
|
|
365
|
-
/** Manually step ALL jobs in the scheduler */
|
|
366
|
-
stepAll(timestamp?: number): void
|
|
367
|
-
/** Pause this job (set enabled=false) */
|
|
368
|
-
pause(): void
|
|
369
|
-
/** Resume this job (set enabled=true) */
|
|
370
|
-
resume(): void
|
|
371
|
-
/** Reactive paused state - automatically triggers re-render when changed */
|
|
372
|
-
isPaused: boolean
|
|
373
|
-
}
|
|
374
|
-
|
|
375
|
-
/** Alias for FrameNextControls */
|
|
376
|
-
type FrameControls = FrameNextControls
|
|
369
|
+
type StorageLike =
|
|
370
|
+
| StorageTexture // 2D GPU storage texture
|
|
371
|
+
| Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
|
|
372
|
+
| StorageArrayTexture // 2D-array GPU storage texture
|
|
373
|
+
| Data3DTexture // 3D texture (can be used as storage)
|
|
374
|
+
| Node // TSL storage texture nodes (storageTexture)
|
|
377
375
|
|
|
378
|
-
|
|
376
|
+
/** Flat record of storage-like values (no nested scopes) */
|
|
377
|
+
type StorageRecord = Record<string, StorageLike>
|
|
379
378
|
|
|
380
379
|
/**
|
|
381
|
-
*
|
|
380
|
+
* Storage store that can contain both root-level storage and scoped storage objects.
|
|
381
|
+
* Structure: { heightMap: StorageTexture, terrain: { normal: StorageTextureNode } }
|
|
382
382
|
*/
|
|
383
|
-
|
|
384
|
-
//* Phase Management --------------------------------
|
|
385
|
-
|
|
386
|
-
/** Add a named phase to the scheduler */
|
|
387
|
-
addPhase(name: string, options?: AddPhaseOptions): void
|
|
388
|
-
/** Get the ordered list of phase names */
|
|
389
|
-
readonly phases: string[]
|
|
390
|
-
/** Check if a phase exists */
|
|
391
|
-
hasPhase(name: string): boolean
|
|
392
|
-
|
|
393
|
-
//* Root Management --------------------------------
|
|
394
|
-
|
|
395
|
-
/** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
|
|
396
|
-
registerRoot(id: string, options?: RootOptions): () => void
|
|
397
|
-
/** Unregister a root */
|
|
398
|
-
unregisterRoot(id: string): void
|
|
399
|
-
/** Generate a unique root ID */
|
|
400
|
-
generateRootId(): string
|
|
401
|
-
/** Get the number of registered roots */
|
|
402
|
-
getRootCount(): number
|
|
403
|
-
/** Check if any root is registered and ready */
|
|
404
|
-
readonly isReady: boolean
|
|
405
|
-
/** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
|
|
406
|
-
onRootReady(callback: () => void): () => void
|
|
407
|
-
|
|
408
|
-
//* Job Registration --------------------------------
|
|
409
|
-
|
|
410
|
-
/** Register a job with the scheduler (returns unsubscribe function) */
|
|
411
|
-
register(
|
|
412
|
-
callback: FrameNextCallback,
|
|
413
|
-
options?: {
|
|
414
|
-
id?: string
|
|
415
|
-
rootId?: string
|
|
416
|
-
phase?: string
|
|
417
|
-
before?: string | string[]
|
|
418
|
-
after?: string | string[]
|
|
419
|
-
priority?: number
|
|
420
|
-
fps?: number
|
|
421
|
-
drop?: boolean
|
|
422
|
-
enabled?: boolean
|
|
423
|
-
},
|
|
424
|
-
): () => void
|
|
425
|
-
/** Update a job's options */
|
|
426
|
-
updateJob(
|
|
427
|
-
id: string,
|
|
428
|
-
options: {
|
|
429
|
-
priority?: number
|
|
430
|
-
fps?: number
|
|
431
|
-
drop?: boolean
|
|
432
|
-
enabled?: boolean
|
|
433
|
-
phase?: string
|
|
434
|
-
before?: string | string[]
|
|
435
|
-
after?: string | string[]
|
|
436
|
-
},
|
|
437
|
-
): void
|
|
438
|
-
/** Unregister a job by ID */
|
|
439
|
-
unregister(id: string, rootId?: string): void
|
|
440
|
-
/** Get the number of registered jobs */
|
|
441
|
-
getJobCount(): number
|
|
442
|
-
/** Get all job IDs */
|
|
443
|
-
getJobIds(): string[]
|
|
444
|
-
|
|
445
|
-
//* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
|
|
446
|
-
|
|
447
|
-
/** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
|
|
448
|
-
registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
|
|
449
|
-
|
|
450
|
-
//* Idle Callbacks (for legacy addTail) --------------------------------
|
|
451
|
-
|
|
452
|
-
/** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
|
|
453
|
-
onIdle(callback: (timestamp: number) => void): () => void
|
|
454
|
-
|
|
455
|
-
//* Frame Loop Control --------------------------------
|
|
456
|
-
|
|
457
|
-
/** Start the scheduler loop */
|
|
458
|
-
start(): void
|
|
459
|
-
/** Stop the scheduler loop */
|
|
460
|
-
stop(): void
|
|
461
|
-
/** Check if the scheduler is running */
|
|
462
|
-
readonly isRunning: boolean
|
|
463
|
-
/** Get/set the frameloop mode ('always', 'demand', 'never') */
|
|
464
|
-
frameloop: Frameloop
|
|
465
|
-
/** Independent mode - runs without Canvas, callbacks receive timing-only state */
|
|
466
|
-
independent: boolean
|
|
467
|
-
|
|
468
|
-
//* Manual Stepping --------------------------------
|
|
469
|
-
|
|
470
|
-
/** Manually step all jobs once (for frameloop='never' or testing) */
|
|
471
|
-
step(timestamp?: number): void
|
|
472
|
-
/** Manually step a single job by ID */
|
|
473
|
-
stepJob(id: string, timestamp?: number): void
|
|
474
|
-
/** Request frame(s) to be rendered (for frameloop='demand') */
|
|
475
|
-
invalidate(frames?: number): void
|
|
476
|
-
|
|
477
|
-
//* Per-Job Control --------------------------------
|
|
478
|
-
|
|
479
|
-
/** Check if a job is paused */
|
|
480
|
-
isJobPaused(id: string): boolean
|
|
481
|
-
/** Pause a job */
|
|
482
|
-
pauseJob(id: string): void
|
|
483
|
-
/** Resume a job */
|
|
484
|
-
resumeJob(id: string): void
|
|
485
|
-
/** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
|
|
486
|
-
subscribeJobState(id: string, listener: () => void): () => void
|
|
487
|
-
}
|
|
383
|
+
type StorageStore = Record<string, StorageLike | StorageRecord>
|
|
488
384
|
|
|
489
385
|
//* Renderer Types ========================================
|
|
490
386
|
|
|
@@ -499,6 +395,18 @@ type Subscription = {
|
|
|
499
395
|
store: RootStore
|
|
500
396
|
}
|
|
501
397
|
|
|
398
|
+
/** Per-pointer state for multi-touch and XR support */
|
|
399
|
+
type PointerState = {
|
|
400
|
+
/** Objects currently hovered by this pointer */
|
|
401
|
+
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
402
|
+
/** Objects capturing this pointer */
|
|
403
|
+
captured: Map<THREE$1.Object3D, PointerCaptureTarget>
|
|
404
|
+
/** Initial click position [x, y] */
|
|
405
|
+
initialClick: [x: number, y: number]
|
|
406
|
+
/** Objects hit on initial click */
|
|
407
|
+
initialHits: THREE$1.Object3D[]
|
|
408
|
+
}
|
|
409
|
+
|
|
502
410
|
type Dpr = number | [min: number, max: number]
|
|
503
411
|
|
|
504
412
|
interface Size {
|
|
@@ -540,12 +448,21 @@ interface Performance {
|
|
|
540
448
|
|
|
541
449
|
interface InternalState {
|
|
542
450
|
interaction: THREE$1.Object3D[]
|
|
543
|
-
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
544
451
|
subscribers: Subscription[]
|
|
452
|
+
/** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
|
|
453
|
+
pointerMap: Map<number, PointerState>
|
|
454
|
+
/** Pointers needing raycast this frame (used with frameTimedRaycasts) */
|
|
455
|
+
pointerDirty: Map<number, DomEvent>
|
|
456
|
+
/** Last event received (for events.update() compatibility) */
|
|
457
|
+
lastEvent: React$1.RefObject<DomEvent | null>
|
|
458
|
+
/** @deprecated Use pointerMap.get(pointerId).hovered instead */
|
|
459
|
+
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
460
|
+
/** @deprecated Use pointerMap.get(pointerId).captured instead */
|
|
545
461
|
capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
|
|
462
|
+
/** @deprecated Use pointerMap.get(pointerId).initialClick instead */
|
|
546
463
|
initialClick: [x: number, y: number]
|
|
464
|
+
/** @deprecated Use pointerMap.get(pointerId).initialHits instead */
|
|
547
465
|
initialHits: THREE$1.Object3D[]
|
|
548
|
-
lastEvent: React$1.RefObject<DomEvent | null>
|
|
549
466
|
/** Visibility event registry (onFramed, onOccluded, onVisible) */
|
|
550
467
|
visibilityRegistry: Map<string, VisibilityEntry>
|
|
551
468
|
/** Whether occlusion queries are enabled (WebGPU only) */
|
|
@@ -571,14 +488,31 @@ interface InternalState {
|
|
|
571
488
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
572
489
|
container?: THREE$1.Object3D
|
|
573
490
|
/**
|
|
574
|
-
* CanvasTarget
|
|
575
|
-
*
|
|
491
|
+
* The CanvasTarget this root sizes and renders through.
|
|
492
|
+
*
|
|
493
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
494
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
495
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
496
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
497
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
576
498
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
577
499
|
*/
|
|
578
500
|
canvasTarget?: CanvasTarget
|
|
501
|
+
/**
|
|
502
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
503
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
504
|
+
*
|
|
505
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
506
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
507
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
508
|
+
* invalidate some other canvas's descriptor instead.
|
|
509
|
+
*
|
|
510
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
511
|
+
*/
|
|
512
|
+
canvasTargetSizeDirty?: boolean
|
|
579
513
|
/**
|
|
580
514
|
* Whether multi-canvas rendering is active.
|
|
581
|
-
* True when any canvas uses `
|
|
515
|
+
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
582
516
|
* When true, setCanvasTarget is called before each render.
|
|
583
517
|
*/
|
|
584
518
|
isMultiCanvas?: boolean
|
|
@@ -676,8 +610,8 @@ interface RootState {
|
|
|
676
610
|
setSize: (width?: number, height?: number, top?: number, left?: number) => void
|
|
677
611
|
/** Shortcut to manual setting the pixel ratio */
|
|
678
612
|
setDpr: (dpr: Dpr) => void
|
|
679
|
-
/** Shortcut to setting frameloop flags */
|
|
680
|
-
setFrameloop: (frameloop
|
|
613
|
+
/** Shortcut to setting frameloop flags. No args resets to 'always'. */
|
|
614
|
+
setFrameloop: (frameloop?: Frameloop) => void
|
|
681
615
|
/** Set error state to propagate to error boundary */
|
|
682
616
|
setError: (error: Error | null) => void
|
|
683
617
|
/** Current error state (null when no error) */
|
|
@@ -685,13 +619,19 @@ interface RootState {
|
|
|
685
619
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
686
620
|
uniforms: UniformStore
|
|
687
621
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
688
|
-
nodes:
|
|
689
|
-
/** Global TSL
|
|
690
|
-
|
|
691
|
-
/**
|
|
692
|
-
|
|
693
|
-
/** Global
|
|
694
|
-
|
|
622
|
+
nodes: NodeStore
|
|
623
|
+
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
624
|
+
buffers: BufferStore
|
|
625
|
+
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
626
|
+
gpuStorage: StorageStore
|
|
627
|
+
/** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
|
|
628
|
+
textures: Map<string, THREE$1.Texture>
|
|
629
|
+
/** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
|
|
630
|
+
_textureRefs: Map<string, number>
|
|
631
|
+
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
632
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
633
|
+
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
634
|
+
passes: PassRecord
|
|
695
635
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
696
636
|
_hmrVersion: number
|
|
697
637
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -740,6 +680,20 @@ interface Renderer {
|
|
|
740
680
|
render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
|
|
741
681
|
}
|
|
742
682
|
|
|
683
|
+
//* Color Management Config ==============================
|
|
684
|
+
|
|
685
|
+
/**
|
|
686
|
+
* Color management configuration shared by both WebGL and WebGPU renderers.
|
|
687
|
+
*/
|
|
688
|
+
interface ColorManagementConfig {
|
|
689
|
+
/**
|
|
690
|
+
* Color space assigned to 8-bit input textures (color maps).
|
|
691
|
+
* Defaults to sRGB. Most textures are authored in sRGB.
|
|
692
|
+
* @default THREE.SRGBColorSpace
|
|
693
|
+
*/
|
|
694
|
+
textureColorSpace?: THREE$1.ColorSpace
|
|
695
|
+
}
|
|
696
|
+
|
|
743
697
|
//* WebGL Renderer Props ==============================
|
|
744
698
|
|
|
745
699
|
type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
|
|
@@ -750,7 +704,7 @@ type GLProps =
|
|
|
750
704
|
| Renderer
|
|
751
705
|
| ((defaultProps: DefaultGLProps) => Renderer)
|
|
752
706
|
| ((defaultProps: DefaultGLProps) => Promise<Renderer>)
|
|
753
|
-
| Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
|
|
707
|
+
| (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
|
|
754
708
|
|
|
755
709
|
//* WebGPU Renderer Props ==============================
|
|
756
710
|
|
|
@@ -765,20 +719,27 @@ type DefaultRendererProps = {
|
|
|
765
719
|
*/
|
|
766
720
|
interface CanvasSchedulerConfig {
|
|
767
721
|
/**
|
|
768
|
-
*
|
|
769
|
-
* Pass the `id` of another canvas.
|
|
722
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
770
723
|
*/
|
|
771
|
-
|
|
724
|
+
before?: string | string[]
|
|
772
725
|
/**
|
|
773
|
-
*
|
|
726
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
727
|
+
*/
|
|
728
|
+
after?: string | string[]
|
|
729
|
+
/**
|
|
730
|
+
* Numeric root order. Lower values run first.
|
|
731
|
+
*/
|
|
732
|
+
order?: number
|
|
733
|
+
/**
|
|
734
|
+
* Limit this Canvas's default render job (frames per second).
|
|
774
735
|
*/
|
|
775
736
|
fps?: number
|
|
776
737
|
}
|
|
777
738
|
|
|
778
739
|
/**
|
|
779
|
-
* Extended renderer configuration for multi-canvas support.
|
|
740
|
+
* Extended renderer configuration for multi-canvas support and color management.
|
|
780
741
|
*/
|
|
781
|
-
interface RendererConfigExtended {
|
|
742
|
+
interface RendererConfigExtended extends ColorManagementConfig {
|
|
782
743
|
/** Share renderer from another canvas (WebGPU only) */
|
|
783
744
|
primaryCanvas?: string
|
|
784
745
|
/** Canvas-level scheduler options */
|
|
@@ -843,8 +804,6 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
843
804
|
* @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
|
|
844
805
|
*/
|
|
845
806
|
shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
|
|
846
|
-
/** Color space assigned to 8-bit input textures (color maps). Defaults to sRGB. Most textures are authored in sRGB. */
|
|
847
|
-
textureColorSpace?: THREE$1.ColorSpace
|
|
848
807
|
/** Creates an orthographic camera */
|
|
849
808
|
orthographic?: boolean
|
|
850
809
|
/**
|
|
@@ -859,14 +818,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
859
818
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
860
819
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
861
820
|
dpr?: Dpr
|
|
862
|
-
/**
|
|
863
|
-
|
|
821
|
+
/**
|
|
822
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
823
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
824
|
+
*/
|
|
825
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
864
826
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
865
827
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
866
828
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
867
829
|
camera?: CameraProps
|
|
868
830
|
/** An R3F event manager to manage elements' pointer events */
|
|
869
|
-
events?: (store: RootStore) => EventManager<
|
|
831
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
870
832
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
871
833
|
onCreated?: (state: RootState) => void
|
|
872
834
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -970,8 +932,6 @@ interface Instance<O = any> {
|
|
|
970
932
|
attach?: AttachType<O>
|
|
971
933
|
previousAttach?: any
|
|
972
934
|
isHidden: boolean
|
|
973
|
-
/** Deferred ref props to apply in commitMount */
|
|
974
|
-
deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
|
|
975
935
|
/** Set of props that have been applied via once() */
|
|
976
936
|
appliedOnce?: Set<string>
|
|
977
937
|
}
|
|
@@ -1097,7 +1057,7 @@ interface CanvasProps
|
|
|
1097
1057
|
*/
|
|
1098
1058
|
resize?: Options
|
|
1099
1059
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1100
|
-
eventSource?:
|
|
1060
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1101
1061
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1102
1062
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1103
1063
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1205,70 +1165,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1205
1165
|
|
|
1206
1166
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1207
1167
|
|
|
1208
|
-
//* Global Types ==============================
|
|
1168
|
+
//* Global TSL Types ==============================
|
|
1209
1169
|
|
|
1210
1170
|
declare global {
|
|
1211
|
-
/** Uniform node type - a Node with a value property (matches Three.js UniformNode) */
|
|
1212
|
-
interface UniformNode<T = unknown> extends Node {
|
|
1213
|
-
value: T
|
|
1214
|
-
}
|
|
1215
|
-
|
|
1216
1171
|
/**
|
|
1217
|
-
*
|
|
1218
|
-
*
|
|
1219
|
-
* The function returns a ShaderNodeObject when called.
|
|
1220
|
-
*
|
|
1221
|
-
* @example
|
|
1222
|
-
* ```tsx
|
|
1223
|
-
* // Define a shader function
|
|
1224
|
-
* const blendColorFn = Fn(([color1, color2, factor]) => {
|
|
1225
|
-
* return mix(color1, color2, factor)
|
|
1226
|
-
* })
|
|
1227
|
-
*
|
|
1228
|
-
* // Type when retrieving from nodes store
|
|
1229
|
-
* const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
|
|
1230
|
-
*
|
|
1231
|
-
* // Or with specific return type
|
|
1232
|
-
* const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
|
|
1233
|
-
* ```
|
|
1172
|
+
* Broad callable-node fallback for dynamic store readers.
|
|
1173
|
+
* Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
|
|
1234
1174
|
*/
|
|
1235
|
-
type
|
|
1175
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1176
|
+
readonly shaderNode: unknown
|
|
1177
|
+
readonly id: number
|
|
1178
|
+
}
|
|
1236
1179
|
|
|
1237
|
-
/**
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
*/
|
|
1246
|
-
type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
|
|
1180
|
+
/** Legacy structural node accepted when at least one historical marker exists. */
|
|
1181
|
+
type LegacyTSLNodeLike = {
|
|
1182
|
+
label?: ((label: string) => unknown) | string
|
|
1183
|
+
setName?: (name: string) => unknown
|
|
1184
|
+
} & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
|
|
1185
|
+
|
|
1186
|
+
/** Node type accepted by broad dynamic node-store readers. */
|
|
1187
|
+
type TSLNodeType = three_webgpu.Node | CallableTSLNode
|
|
1247
1188
|
|
|
1248
1189
|
/**
|
|
1249
|
-
*
|
|
1250
|
-
*
|
|
1251
|
-
*
|
|
1252
|
-
*
|
|
1253
|
-
* - Node: base Three.js node type
|
|
1254
|
-
* - ShaderCallable: function nodes created with Fn()
|
|
1255
|
-
* - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
|
|
1256
|
-
*
|
|
1257
|
-
* @example
|
|
1258
|
-
* ```tsx
|
|
1259
|
-
* // In useLocalNodes, nodes are typed as TSLNodeType
|
|
1260
|
-
* const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
|
|
1261
|
-
* positionNode: nodes.myPosition, // Works - Node is in union
|
|
1262
|
-
* blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
|
|
1263
|
-
* }))
|
|
1264
|
-
*
|
|
1265
|
-
* // Can narrow with type guard or assertion when needed
|
|
1266
|
-
* if (typeof blendColorFn === 'function') {
|
|
1267
|
-
* blendColorFn(someColor, 0.5)
|
|
1268
|
-
* }
|
|
1269
|
-
* ```
|
|
1190
|
+
* Derive Three's shader node type from an existing node or a supported raw input.
|
|
1191
|
+
* Existing InputNode generics take precedence over structural value normalization.
|
|
1192
|
+
* Both generics must be inferred because Three's UniformNode intersects an unknown-typed
|
|
1193
|
+
* InputNode base with its concrete InputNode specialization.
|
|
1270
1194
|
*/
|
|
1271
|
-
type
|
|
1195
|
+
type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
|
|
1196
|
+
? TNodeType
|
|
1197
|
+
: T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
|
|
1198
|
+
? TNodeType
|
|
1199
|
+
: T extends number
|
|
1200
|
+
? 'float'
|
|
1201
|
+
: T extends boolean
|
|
1202
|
+
? 'bool'
|
|
1203
|
+
: T extends string | three_webgpu.Color | { r: number; g: number; b: number }
|
|
1204
|
+
? 'color'
|
|
1205
|
+
: T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
|
|
1206
|
+
? 'vec4'
|
|
1207
|
+
: T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
|
|
1208
|
+
? 'vec3'
|
|
1209
|
+
: T extends three_webgpu.Vector2 | { x: number; y: number }
|
|
1210
|
+
? 'vec2'
|
|
1211
|
+
: T extends three_webgpu.Matrix4
|
|
1212
|
+
? 'mat4'
|
|
1213
|
+
: T extends three_webgpu.Matrix3
|
|
1214
|
+
? 'mat3'
|
|
1215
|
+
: T extends three_webgpu.Matrix2
|
|
1216
|
+
? 'mat2'
|
|
1217
|
+
: unknown
|
|
1218
|
+
|
|
1219
|
+
/** Derive the normalized JavaScript value stored by a uniform node. */
|
|
1220
|
+
type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
|
|
1221
|
+
? TValue
|
|
1222
|
+
: T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
|
|
1223
|
+
? TValue
|
|
1224
|
+
: T extends string | { r: number; g: number; b: number }
|
|
1225
|
+
? three_webgpu.Color
|
|
1226
|
+
: T extends { x: number; y: number; z: number; w: number }
|
|
1227
|
+
? three_webgpu.Vector4
|
|
1228
|
+
: T extends { x: number; y: number; z: number }
|
|
1229
|
+
? three_webgpu.Vector3
|
|
1230
|
+
: T extends { x: number; y: number }
|
|
1231
|
+
? three_webgpu.Vector2
|
|
1232
|
+
: T extends number
|
|
1233
|
+
? number
|
|
1234
|
+
: T extends boolean
|
|
1235
|
+
? boolean
|
|
1236
|
+
: T
|
|
1237
|
+
|
|
1238
|
+
/** Three's exact UniformNode with shader and value generics derived from an input. */
|
|
1239
|
+
type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
|
|
1240
|
+
|
|
1241
|
+
/** Preserve every input key while mapping values to exact Three uniform nodes. */
|
|
1242
|
+
type UniformNodesFor<T extends UniformInputRecord> = {
|
|
1243
|
+
[K in keyof T]: UniformNodeFor<T[K]>
|
|
1244
|
+
}
|
|
1245
|
+
|
|
1246
|
+
/** Backward-compatible single-parameter uniform alias. */
|
|
1247
|
+
type UniformNode<T = unknown> = UniformNodeFor<T>
|
|
1272
1248
|
|
|
1273
1249
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1274
1250
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1293,7 +1269,7 @@ declare global {
|
|
|
1293
1269
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1294
1270
|
* Supports:
|
|
1295
1271
|
* - Primitives: number, string (color), boolean
|
|
1296
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1272
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1297
1273
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1298
1274
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1299
1275
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1306,226 +1282,124 @@ declare global {
|
|
|
1306
1282
|
| three_webgpu.Vector2
|
|
1307
1283
|
| three_webgpu.Vector3
|
|
1308
1284
|
| three_webgpu.Vector4
|
|
1285
|
+
| three_webgpu.Matrix2
|
|
1309
1286
|
| three_webgpu.Matrix3
|
|
1310
1287
|
| three_webgpu.Matrix4
|
|
1311
|
-
|
|
|
1312
|
-
|
|
|
1313
|
-
| { x: number; y
|
|
1314
|
-
|
|
|
1288
|
+
| { x: number; y: number }
|
|
1289
|
+
| { x: number; y: number; z: number }
|
|
1290
|
+
| { x: number; y: number; z: number; w: number }
|
|
1291
|
+
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1292
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1315
1293
|
| UniformNode
|
|
1316
1294
|
|
|
1317
1295
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1318
1296
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1319
1297
|
}
|
|
1320
1298
|
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
declare module 'three/tsl' {
|
|
1299
|
+
declare global {
|
|
1324
1300
|
/**
|
|
1325
|
-
*
|
|
1326
|
-
*
|
|
1301
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1302
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1303
|
+
* is r185, so the new name is the only one.
|
|
1327
1304
|
*/
|
|
1328
|
-
|
|
1329
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1330
|
-
): ShaderCallable<R>
|
|
1305
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1331
1306
|
|
|
1332
1307
|
/**
|
|
1333
|
-
*
|
|
1334
|
-
*
|
|
1308
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1309
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1310
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1335
1311
|
*/
|
|
1336
|
-
|
|
1337
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1338
|
-
): ShaderCallable<R>
|
|
1312
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1339
1313
|
|
|
1340
1314
|
/**
|
|
1341
|
-
*
|
|
1342
|
-
*
|
|
1315
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1316
|
+
*
|
|
1317
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1318
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1319
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1320
|
+
* {@link RenderPipelineCallbackState}.
|
|
1321
|
+
*
|
|
1322
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1323
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1324
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1325
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1326
|
+
*
|
|
1327
|
+
* The index signature admits `undefined` because a key may simply not be registered, and
|
|
1328
|
+
* because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
|
|
1329
|
+
* optional property whose type excludes `undefined` from the index signature is an error
|
|
1330
|
+
* (TS2411) for every consumer compiling these declarations.
|
|
1343
1331
|
*/
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1332
|
+
interface PassRecord {
|
|
1333
|
+
scenePass?: ScenePassNode
|
|
1334
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1335
|
+
}
|
|
1348
1336
|
|
|
1349
1337
|
/**
|
|
1350
|
-
*
|
|
1338
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1339
|
+
*
|
|
1340
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1341
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1342
|
+
*
|
|
1343
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1344
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1351
1345
|
*/
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
/**
|
|
1359
|
-
* PostProcessing Types for usePostProcessing hook (WebGPU only)
|
|
1360
|
-
*/
|
|
1361
|
-
|
|
1362
|
-
|
|
1346
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1347
|
+
renderPipeline: ThreeRenderPipeline
|
|
1348
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1349
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1350
|
+
isLegacy: false
|
|
1351
|
+
}
|
|
1363
1352
|
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1353
|
+
/**
|
|
1354
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1355
|
+
*
|
|
1356
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1357
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1358
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1359
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1360
|
+
*/
|
|
1361
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1367
1362
|
|
|
1368
1363
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1369
|
-
type
|
|
1364
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1370
1365
|
|
|
1371
1366
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1372
|
-
type
|
|
1367
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1373
1368
|
|
|
1374
|
-
/**
|
|
1375
|
-
interface
|
|
1369
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1370
|
+
interface UseRenderPipelineActions {
|
|
1376
1371
|
/** Current passes from state */
|
|
1377
1372
|
passes: PassRecord
|
|
1378
|
-
/** PostProcessing instance (null if not initialized) */
|
|
1379
|
-
postProcessing: any | null // THREE.PostProcessing
|
|
1380
1373
|
/** Clear all passes from state */
|
|
1381
1374
|
clearPasses: () => void
|
|
1382
|
-
/** Reset
|
|
1375
|
+
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1383
1376
|
reset: () => void
|
|
1384
1377
|
/** Re-run setup/main callbacks with current closure values */
|
|
1385
1378
|
rebuild: () => void
|
|
1386
|
-
/** True when PostProcessing is configured and ready */
|
|
1387
|
-
isReady: boolean
|
|
1388
|
-
}
|
|
1389
|
-
}
|
|
1390
|
-
|
|
1391
|
-
//* useFrameNext Types ==============================
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
//* Global Type Declarations ==============================
|
|
1396
|
-
|
|
1397
|
-
declare global {
|
|
1398
|
-
// Job --------------------------------
|
|
1399
|
-
|
|
1400
|
-
/**
|
|
1401
|
-
* Internal job representation in the scheduler
|
|
1402
|
-
*/
|
|
1403
|
-
interface Job {
|
|
1404
|
-
/** Unique identifier */
|
|
1405
|
-
id: string
|
|
1406
|
-
/** The callback to execute */
|
|
1407
|
-
callback: FrameNextCallback
|
|
1408
|
-
/** Phase this job belongs to */
|
|
1409
|
-
phase: string
|
|
1410
|
-
/** Run before these phases/job ids */
|
|
1411
|
-
before: Set<string>
|
|
1412
|
-
/** Run after these phases/job ids */
|
|
1413
|
-
after: Set<string>
|
|
1414
|
-
/** Priority within phase (higher first) */
|
|
1415
|
-
priority: number
|
|
1416
|
-
/** Insertion order for deterministic tie-breaking */
|
|
1417
|
-
index: number
|
|
1418
|
-
/** Max FPS for this job (undefined = no limit) */
|
|
1419
|
-
fps?: number
|
|
1420
|
-
/** Drop frames when behind (true) or catch up (false) */
|
|
1421
|
-
drop: boolean
|
|
1422
|
-
/** Last run timestamp (ms) */
|
|
1423
|
-
lastRun?: number
|
|
1424
|
-
/** Whether job is enabled */
|
|
1425
|
-
enabled: boolean
|
|
1426
|
-
/** Internal flag: system jobs (like default render) don't block user render takeover */
|
|
1427
|
-
system?: boolean
|
|
1428
|
-
}
|
|
1429
|
-
|
|
1430
|
-
// Phase Graph --------------------------------
|
|
1431
|
-
|
|
1432
|
-
/**
|
|
1433
|
-
* A node in the phase graph
|
|
1434
|
-
*/
|
|
1435
|
-
interface PhaseNode {
|
|
1436
|
-
/** Phase name */
|
|
1437
|
-
name: string
|
|
1438
|
-
/** Whether this was auto-generated from a before/after constraint */
|
|
1439
|
-
isAutoGenerated: boolean
|
|
1440
|
-
}
|
|
1441
|
-
|
|
1442
|
-
/**
|
|
1443
|
-
* Options for creating a job from hook options
|
|
1444
|
-
*/
|
|
1445
|
-
interface JobOptions {
|
|
1446
|
-
id?: string
|
|
1447
|
-
phase?: string
|
|
1448
|
-
before?: string | string[]
|
|
1449
|
-
after?: string | string[]
|
|
1450
|
-
priority?: number
|
|
1451
|
-
fps?: number
|
|
1452
|
-
drop?: boolean
|
|
1453
|
-
enabled?: boolean
|
|
1454
1379
|
}
|
|
1455
1380
|
|
|
1456
|
-
// Frame Loop State --------------------------------
|
|
1457
|
-
|
|
1458
|
-
/**
|
|
1459
|
-
* Internal frame loop state
|
|
1460
|
-
*/
|
|
1461
|
-
interface FrameLoopState {
|
|
1462
|
-
/** Whether the loop is running */
|
|
1463
|
-
running: boolean
|
|
1464
|
-
/** Current RAF handle */
|
|
1465
|
-
rafHandle: number | null
|
|
1466
|
-
/** Last frame timestamp in ms (null = uninitialized) */
|
|
1467
|
-
lastTime: number | null
|
|
1468
|
-
/** Frame counter */
|
|
1469
|
-
frameCount: number
|
|
1470
|
-
/** Elapsed time since first frame in ms */
|
|
1471
|
-
elapsedTime: number
|
|
1472
|
-
/** createdAt timestamp in ms */
|
|
1473
|
-
createdAt: number
|
|
1474
|
-
}
|
|
1475
|
-
|
|
1476
|
-
// Root Entry --------------------------------
|
|
1477
|
-
|
|
1478
1381
|
/**
|
|
1479
|
-
*
|
|
1480
|
-
*
|
|
1481
|
-
*
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
/** Unique identifier for this root */
|
|
1485
|
-
id: string
|
|
1486
|
-
/** Function to get the root's current state. Returns any to support independent mode. */
|
|
1487
|
-
getState: () => any
|
|
1488
|
-
/** Map of job IDs to Job objects */
|
|
1489
|
-
jobs: Map<string, Job>
|
|
1490
|
-
/** Cached sorted job list for execution order */
|
|
1491
|
-
sortedJobs: Job[]
|
|
1492
|
-
/** Whether sortedJobs needs rebuilding */
|
|
1493
|
-
needsRebuild: boolean
|
|
1494
|
-
}
|
|
1495
|
-
|
|
1496
|
-
/**
|
|
1497
|
-
* Internal representation of a global job (deprecated API).
|
|
1498
|
-
* Global jobs run once per frame, not per-root.
|
|
1499
|
-
* Used by legacy addEffect/addAfterEffect APIs.
|
|
1500
|
-
* @internal
|
|
1501
|
-
* @deprecated Use useFrame with phases instead
|
|
1502
|
-
*/
|
|
1503
|
-
interface GlobalJob {
|
|
1504
|
-
/** Unique identifier for this global job */
|
|
1505
|
-
id: string
|
|
1506
|
-
/** Callback invoked with RAF timestamp in ms */
|
|
1507
|
-
callback: (timestamp: number) => void
|
|
1508
|
-
}
|
|
1509
|
-
|
|
1510
|
-
// HMR Support --------------------------------
|
|
1511
|
-
|
|
1512
|
-
/**
|
|
1513
|
-
* Hot Module Replacement data structure for preserving scheduler state
|
|
1514
|
-
* @internal
|
|
1515
|
-
*/
|
|
1516
|
-
interface HMRData {
|
|
1517
|
-
/** Shared data object for storing values across reloads */
|
|
1518
|
-
data: Record<string, any>
|
|
1519
|
-
/** Optional function to accept HMR updates */
|
|
1520
|
-
accept?: () => void
|
|
1521
|
-
}
|
|
1522
|
-
|
|
1523
|
-
// Default Phases --------------------------------
|
|
1524
|
-
|
|
1525
|
-
/**
|
|
1526
|
-
* Default phase names for the scheduler
|
|
1382
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1383
|
+
*
|
|
1384
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1385
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1386
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1527
1387
|
*/
|
|
1528
|
-
type
|
|
1388
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1389
|
+
(
|
|
1390
|
+
| {
|
|
1391
|
+
/** True when RenderPipeline is configured and ready */
|
|
1392
|
+
isReady: true
|
|
1393
|
+
/** RenderPipeline instance */
|
|
1394
|
+
renderPipeline: ThreeRenderPipeline
|
|
1395
|
+
}
|
|
1396
|
+
| {
|
|
1397
|
+
/** False until the pipeline has been created */
|
|
1398
|
+
isReady: false
|
|
1399
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1400
|
+
renderPipeline: null
|
|
1401
|
+
}
|
|
1402
|
+
)
|
|
1529
1403
|
}
|
|
1530
1404
|
|
|
1531
1405
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -1604,10 +1478,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1604
1478
|
|
|
1605
1479
|
/**
|
|
1606
1480
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1607
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1481
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1482
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1608
1483
|
*/
|
|
1609
1484
|
type NodeProps<P> = {
|
|
1610
|
-
[K in keyof P as P[K] extends
|
|
1485
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1611
1486
|
}
|
|
1612
1487
|
|
|
1613
1488
|
interface ReactProps<P> {
|
|
@@ -1628,11 +1503,30 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1628
1503
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1629
1504
|
}
|
|
1630
1505
|
|
|
1506
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1507
|
+
type Object3DMethod = NonNullable<
|
|
1508
|
+
{
|
|
1509
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1510
|
+
}[keyof Object3D]
|
|
1511
|
+
>
|
|
1512
|
+
|
|
1631
1513
|
type ThreeExports = typeof import('three')
|
|
1632
1514
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1633
1515
|
|
|
1634
1516
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1635
|
-
|
|
1517
|
+
/**
|
|
1518
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1519
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1520
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1521
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1522
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1523
|
+
*/
|
|
1524
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | 'onUpdate' | Object3DMethod> & {
|
|
1525
|
+
object: object
|
|
1526
|
+
ref?: React.Ref<any>
|
|
1527
|
+
onUpdate?: (self: any) => void
|
|
1528
|
+
[prop: string]: unknown
|
|
1529
|
+
}
|
|
1636
1530
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1637
1531
|
threeAudio: ThreeElementsImpl['audio']
|
|
1638
1532
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1673,6 +1567,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1673
1567
|
type three_d_Matrix4 = Matrix4;
|
|
1674
1568
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1675
1569
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1570
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1676
1571
|
type three_d_Quaternion = Quaternion;
|
|
1677
1572
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1678
1573
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1687,7 +1582,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1687
1582
|
type three_d_Vector4 = Vector4;
|
|
1688
1583
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1689
1584
|
declare namespace three_d {
|
|
1690
|
-
export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
|
|
1585
|
+
export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Object3DMethod as Object3DMethod, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
|
|
1691
1586
|
}
|
|
1692
1587
|
|
|
1693
1588
|
/**
|
|
@@ -1697,7 +1592,7 @@ declare namespace three_d {
|
|
|
1697
1592
|
* a single WebGPURenderer using Three.js CanvasTarget API.
|
|
1698
1593
|
*
|
|
1699
1594
|
* Primary canvas: Has `id` prop, creates its own renderer, registers here
|
|
1700
|
-
* Secondary canvas: Has `
|
|
1595
|
+
* Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
|
|
1701
1596
|
*/
|
|
1702
1597
|
|
|
1703
1598
|
interface PrimaryCanvasEntry {
|
|
@@ -1765,12 +1660,23 @@ type EnvironmentLoaderProps = {
|
|
|
1765
1660
|
* const texture = useEnvironment({ preset: 'sunset' })
|
|
1766
1661
|
* ```
|
|
1767
1662
|
*/
|
|
1768
|
-
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture
|
|
1663
|
+
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
|
|
1769
1664
|
declare namespace useEnvironment {
|
|
1770
1665
|
var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
|
|
1771
1666
|
var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
|
|
1772
1667
|
}
|
|
1773
|
-
|
|
1668
|
+
/**
|
|
1669
|
+
* Options accepted by `useEnvironment.preload`.
|
|
1670
|
+
*
|
|
1671
|
+
* `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
|
|
1672
|
+
* applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
|
|
1673
|
+
* advertise an option this function silently ignores.
|
|
1674
|
+
*
|
|
1675
|
+
* This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
|
|
1676
|
+
* `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
|
|
1677
|
+
* type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
|
|
1678
|
+
*/
|
|
1679
|
+
type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
|
|
1774
1680
|
type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
|
|
1775
1681
|
|
|
1776
1682
|
/**
|
|
@@ -1814,9 +1720,9 @@ type EnvironmentProps = {
|
|
|
1814
1720
|
blur?: number;
|
|
1815
1721
|
backgroundBlurriness?: number;
|
|
1816
1722
|
backgroundIntensity?: number;
|
|
1817
|
-
backgroundRotation?: Euler
|
|
1723
|
+
backgroundRotation?: Euler;
|
|
1818
1724
|
environmentIntensity?: number;
|
|
1819
|
-
environmentRotation?: Euler
|
|
1725
|
+
environmentRotation?: Euler;
|
|
1820
1726
|
map?: Texture$1;
|
|
1821
1727
|
preset?: PresetsType;
|
|
1822
1728
|
scene?: Scene | React$1.RefObject<Scene>;
|
|
@@ -1900,7 +1806,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
|
|
|
1900
1806
|
declare function EnvironmentPortal({ children, near, far, resolution, frames, map, background, blur, backgroundBlurriness, backgroundIntensity, backgroundRotation, environmentIntensity, environmentRotation, scene, files, path, preset, extensions, }: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
1901
1807
|
declare module '@react-three/fiber' {
|
|
1902
1808
|
interface ThreeElements {
|
|
1903
|
-
groundProjectedEnvImpl: ThreeElement
|
|
1809
|
+
groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
|
|
1904
1810
|
}
|
|
1905
1811
|
}
|
|
1906
1812
|
/**
|
|
@@ -2000,12 +1906,32 @@ declare module '@react-three/fiber' {
|
|
|
2000
1906
|
*/
|
|
2001
1907
|
declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
2002
1908
|
|
|
1909
|
+
/**
|
|
1910
|
+
* Moves every trace of interactivity from one object to its replacement, for reconstruction.
|
|
1911
|
+
*
|
|
1912
|
+
* When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
|
|
1913
|
+
* instance. Removing the old object from the interaction state and registering the new one from
|
|
1914
|
+
* scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
|
|
1915
|
+
* the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
|
|
1916
|
+
* is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
|
|
1917
|
+
* swap the user never asked to see (#3744).
|
|
1918
|
+
*
|
|
1919
|
+
* Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
|
|
1920
|
+
* left alone — releasing and re-acquiring it is precisely the glitch being avoided.
|
|
1921
|
+
*
|
|
1922
|
+
* Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
|
|
1923
|
+
* the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
|
|
1924
|
+
* cannot outlive the object it described.
|
|
1925
|
+
*/
|
|
1926
|
+
declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
|
|
2003
1927
|
declare function removeInteractivity(store: RootStore, object: Object3D): void;
|
|
2004
1928
|
declare function createEvents(store: RootStore): {
|
|
2005
1929
|
handlePointer: (name: string) => (event: DomEvent) => void;
|
|
1930
|
+
flushDeferredPointers: () => void;
|
|
1931
|
+
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
2006
1932
|
};
|
|
2007
1933
|
/** Default R3F event manager for web */
|
|
2008
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1934
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
2009
1935
|
|
|
2010
1936
|
/**
|
|
2011
1937
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -2018,389 +1944,27 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
|
|
|
2018
1944
|
* Note: this hook's caller must be wrapped with `React.Suspense`
|
|
2019
1945
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
|
|
2020
1946
|
*/
|
|
2021
|
-
declare function useLoader<I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void): I extends any[] ? LoaderResult<L>[] : LoaderResult<L>;
|
|
1947
|
+
declare function useLoader<I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void, cacheKey?: InputLike): I extends any[] ? LoaderResult<L>[] : LoaderResult<L>;
|
|
2022
1948
|
declare namespace useLoader {
|
|
2023
|
-
var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
|
|
2024
|
-
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
|
|
1949
|
+
var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void, cacheKey?: InputLike) => void;
|
|
1950
|
+
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
|
|
2025
1951
|
var loader: typeof getLoader;
|
|
2026
1952
|
}
|
|
2027
1953
|
|
|
2028
|
-
/**
|
|
2029
|
-
* Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
|
|
2030
|
-
*
|
|
2031
|
-
* Features:
|
|
2032
|
-
* - Single RAF loop for entire application
|
|
2033
|
-
* - Root registration (multiple Canvas support)
|
|
2034
|
-
* - Global phases for addEffect/addAfterEffect (deprecated)
|
|
2035
|
-
* - Per-root job management with phases, priorities, FPS throttling
|
|
2036
|
-
* - onIdle callbacks for addTail (deprecated)
|
|
2037
|
-
* - Demand mode support via invalidate()
|
|
2038
|
-
*/
|
|
2039
|
-
declare class Scheduler {
|
|
2040
|
-
private static readonly INSTANCE_KEY;
|
|
2041
|
-
private static get instance();
|
|
2042
|
-
private static set instance(value);
|
|
2043
|
-
/**
|
|
2044
|
-
* Get the global scheduler instance (creates if doesn't exist).
|
|
2045
|
-
* Uses HMR data to preserve instance across hot reloads.
|
|
2046
|
-
* @returns {Scheduler} The singleton scheduler instance
|
|
2047
|
-
*/
|
|
2048
|
-
static get(): Scheduler;
|
|
2049
|
-
/**
|
|
2050
|
-
* Reset the singleton instance. Stops the loop and clears all state.
|
|
2051
|
-
* Primarily used for testing to ensure clean state between tests.
|
|
2052
|
-
* @returns {void}
|
|
2053
|
-
*/
|
|
2054
|
-
static reset(): void;
|
|
2055
|
-
private roots;
|
|
2056
|
-
private phaseGraph;
|
|
2057
|
-
private loopState;
|
|
2058
|
-
private stoppedTime;
|
|
2059
|
-
private nextRootIndex;
|
|
2060
|
-
private globalBeforeJobs;
|
|
2061
|
-
private globalAfterJobs;
|
|
2062
|
-
private nextGlobalIndex;
|
|
2063
|
-
private idleCallbacks;
|
|
2064
|
-
private nextJobIndex;
|
|
2065
|
-
private jobStateListeners;
|
|
2066
|
-
private pendingFrames;
|
|
2067
|
-
private _frameloop;
|
|
2068
|
-
private _independent;
|
|
2069
|
-
private errorHandler;
|
|
2070
|
-
private rootReadyCallbacks;
|
|
2071
|
-
get phases(): string[];
|
|
2072
|
-
get frameloop(): Frameloop;
|
|
2073
|
-
set frameloop(mode: Frameloop);
|
|
2074
|
-
get isRunning(): boolean;
|
|
2075
|
-
get isReady(): boolean;
|
|
2076
|
-
get independent(): boolean;
|
|
2077
|
-
set independent(value: boolean);
|
|
2078
|
-
constructor();
|
|
2079
|
-
/**
|
|
2080
|
-
* Register a root (Canvas) with the scheduler.
|
|
2081
|
-
* The first root to register starts the RAF loop (if frameloop='always').
|
|
2082
|
-
* @param {string} id - Unique identifier for this root
|
|
2083
|
-
* @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
|
|
2084
|
-
* @returns {() => void} Unsubscribe function to remove this root
|
|
2085
|
-
*/
|
|
2086
|
-
registerRoot(id: string, options?: RootOptions): () => void;
|
|
2087
|
-
/**
|
|
2088
|
-
* Unregister a root from the scheduler.
|
|
2089
|
-
* Cleans up all job state listeners for this root's jobs.
|
|
2090
|
-
* The last root to unregister stops the RAF loop.
|
|
2091
|
-
* @param {string} id - The root ID to unregister
|
|
2092
|
-
* @returns {void}
|
|
2093
|
-
*/
|
|
2094
|
-
unregisterRoot(id: string): void;
|
|
2095
|
-
/**
|
|
2096
|
-
* Subscribe to be notified when a root becomes available.
|
|
2097
|
-
* Fires immediately if a root already exists.
|
|
2098
|
-
* @param {() => void} callback - Function called when first root registers
|
|
2099
|
-
* @returns {() => void} Unsubscribe function
|
|
2100
|
-
*/
|
|
2101
|
-
onRootReady(callback: () => void): () => void;
|
|
2102
|
-
/**
|
|
2103
|
-
* Notify all registered root-ready callbacks.
|
|
2104
|
-
* Called when the first root registers.
|
|
2105
|
-
* @returns {void}
|
|
2106
|
-
* @private
|
|
2107
|
-
*/
|
|
2108
|
-
private notifyRootReady;
|
|
2109
|
-
/**
|
|
2110
|
-
* Ensure a default root exists for independent mode.
|
|
2111
|
-
* Creates a minimal root with no state provider.
|
|
2112
|
-
* @returns {void}
|
|
2113
|
-
* @private
|
|
2114
|
-
*/
|
|
2115
|
-
private ensureDefaultRoot;
|
|
2116
|
-
/**
|
|
2117
|
-
* Trigger error handling for job errors.
|
|
2118
|
-
* Uses the bound error handler if available, otherwise logs to console.
|
|
2119
|
-
* @param {Error} error - The error to handle
|
|
2120
|
-
* @returns {void}
|
|
2121
|
-
*/
|
|
2122
|
-
triggerError(error: Error): void;
|
|
2123
|
-
/**
|
|
2124
|
-
* Add a named phase to the scheduler's execution order.
|
|
2125
|
-
* Marks all roots for rebuild to incorporate the new phase.
|
|
2126
|
-
* @param {string} name - The phase name (e.g., 'physics', 'postprocess')
|
|
2127
|
-
* @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
|
|
2128
|
-
* @returns {void}
|
|
2129
|
-
* @example
|
|
2130
|
-
* scheduler.addPhase('physics', { before: 'update' });
|
|
2131
|
-
* scheduler.addPhase('postprocess', { after: 'render' });
|
|
2132
|
-
*/
|
|
2133
|
-
addPhase(name: string, options?: AddPhaseOptions): void;
|
|
2134
|
-
/**
|
|
2135
|
-
* Check if a phase exists in the scheduler.
|
|
2136
|
-
* @param {string} name - The phase name to check
|
|
2137
|
-
* @returns {boolean} True if the phase exists
|
|
2138
|
-
*/
|
|
2139
|
-
hasPhase(name: string): boolean;
|
|
2140
|
-
/**
|
|
2141
|
-
* Register a global job that runs once per frame (not per-root).
|
|
2142
|
-
* Used internally by deprecated addEffect/addAfterEffect APIs.
|
|
2143
|
-
* @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
|
|
2144
|
-
* @param {string} id - Unique identifier for this global job
|
|
2145
|
-
* @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
|
|
2146
|
-
* @returns {() => void} Unsubscribe function to remove this global job
|
|
2147
|
-
* @deprecated Use useFrame with phases instead
|
|
2148
|
-
*/
|
|
2149
|
-
registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
|
|
2150
|
-
/**
|
|
2151
|
-
* Register an idle callback that fires when the loop stops.
|
|
2152
|
-
* Used internally by deprecated addTail API.
|
|
2153
|
-
* @param {(timestamp: number) => void} callback - Function called when loop becomes idle
|
|
2154
|
-
* @returns {() => void} Unsubscribe function to remove this idle callback
|
|
2155
|
-
* @deprecated Use demand mode with invalidate() instead
|
|
2156
|
-
*/
|
|
2157
|
-
onIdle(callback: (timestamp: number) => void): () => void;
|
|
2158
|
-
/**
|
|
2159
|
-
* Notify all registered idle callbacks.
|
|
2160
|
-
* Called when the loop stops in demand mode.
|
|
2161
|
-
* @param {number} timestamp - The RAF timestamp when idle occurred
|
|
2162
|
-
* @returns {void}
|
|
2163
|
-
* @private
|
|
2164
|
-
*/
|
|
2165
|
-
private notifyIdle;
|
|
2166
|
-
/**
|
|
2167
|
-
* Register a job (frame callback) with a specific root.
|
|
2168
|
-
* This is the core registration method used by useFrame internally.
|
|
2169
|
-
* @param {FrameNextCallback} callback - The function to call each frame
|
|
2170
|
-
* @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
|
|
2171
|
-
* @param {string} [options.rootId] - Target root ID (defaults to first registered root)
|
|
2172
|
-
* @param {string} [options.id] - Unique job ID (auto-generated if not provided)
|
|
2173
|
-
* @param {string} [options.phase] - Execution phase (defaults to 'update')
|
|
2174
|
-
* @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
|
|
2175
|
-
* @param {number} [options.fps] - FPS throttle limit
|
|
2176
|
-
* @param {boolean} [options.drop] - Drop frames when behind (default true)
|
|
2177
|
-
* @param {boolean} [options.enabled] - Whether job is active (default true)
|
|
2178
|
-
* @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
|
|
2179
|
-
* @returns {() => void} Unsubscribe function to remove this job
|
|
2180
|
-
*/
|
|
2181
|
-
register(callback: FrameNextCallback, options?: JobOptions & {
|
|
2182
|
-
rootId?: string;
|
|
2183
|
-
system?: boolean;
|
|
2184
|
-
}): () => void;
|
|
2185
|
-
/**
|
|
2186
|
-
* Unregister a job by its ID.
|
|
2187
|
-
* Searches all roots if rootId is not provided.
|
|
2188
|
-
* @param {string} id - The job ID to unregister
|
|
2189
|
-
* @param {string} [rootId] - Optional root ID to search (searches all if not provided)
|
|
2190
|
-
* @returns {void}
|
|
2191
|
-
*/
|
|
2192
|
-
unregister(id: string, rootId?: string): void;
|
|
2193
|
-
/**
|
|
2194
|
-
* Update a job's options dynamically.
|
|
2195
|
-
* Searches all roots to find the job by ID.
|
|
2196
|
-
* Phase/constraint changes trigger a rebuild of the sorted job list.
|
|
2197
|
-
* @param {string} id - The job ID to update
|
|
2198
|
-
* @param {Partial<JobOptions>} options - The options to update
|
|
2199
|
-
* @returns {void}
|
|
2200
|
-
*/
|
|
2201
|
-
updateJob(id: string, options: Partial<JobOptions>): void;
|
|
2202
|
-
/**
|
|
2203
|
-
* Check if a job is currently paused (disabled).
|
|
2204
|
-
* @param {string} id - The job ID to check
|
|
2205
|
-
* @returns {boolean} True if the job exists and is paused
|
|
2206
|
-
*/
|
|
2207
|
-
isJobPaused(id: string): boolean;
|
|
2208
|
-
/**
|
|
2209
|
-
* Subscribe to state changes for a specific job.
|
|
2210
|
-
* Listener is called when job is paused or resumed.
|
|
2211
|
-
* @param {string} id - The job ID to subscribe to
|
|
2212
|
-
* @param {() => void} listener - Callback invoked on state changes
|
|
2213
|
-
* @returns {() => void} Unsubscribe function
|
|
2214
|
-
*/
|
|
2215
|
-
subscribeJobState(id: string, listener: () => void): () => void;
|
|
2216
|
-
/**
|
|
2217
|
-
* Notify all listeners that a job's state has changed.
|
|
2218
|
-
* @param {string} id - The job ID that changed
|
|
2219
|
-
* @returns {void}
|
|
2220
|
-
* @private
|
|
2221
|
-
*/
|
|
2222
|
-
private notifyJobStateChange;
|
|
2223
|
-
/**
|
|
2224
|
-
* Pause a job by ID (sets enabled=false).
|
|
2225
|
-
* Notifies any subscribed state listeners.
|
|
2226
|
-
* @param {string} id - The job ID to pause
|
|
2227
|
-
* @returns {void}
|
|
2228
|
-
*/
|
|
2229
|
-
pauseJob(id: string): void;
|
|
2230
|
-
/**
|
|
2231
|
-
* Resume a paused job by ID (sets enabled=true).
|
|
2232
|
-
* Resets job timing to prevent frame accumulation.
|
|
2233
|
-
* Notifies any subscribed state listeners.
|
|
2234
|
-
* @param {string} id - The job ID to resume
|
|
2235
|
-
* @returns {void}
|
|
2236
|
-
*/
|
|
2237
|
-
resumeJob(id: string): void;
|
|
2238
|
-
/**
|
|
2239
|
-
* Start the requestAnimationFrame loop.
|
|
2240
|
-
* Resets timing state (elapsedTime, frameCount) on start.
|
|
2241
|
-
* No-op if already running.
|
|
2242
|
-
* @returns {void}
|
|
2243
|
-
*/
|
|
2244
|
-
start(): void;
|
|
2245
|
-
/**
|
|
2246
|
-
* Stop the requestAnimationFrame loop.
|
|
2247
|
-
* Cancels any pending RAF callback.
|
|
2248
|
-
* No-op if not running.
|
|
2249
|
-
* @returns {void}
|
|
2250
|
-
*/
|
|
2251
|
-
stop(): void;
|
|
2252
|
-
/**
|
|
2253
|
-
* Request frames to be rendered in demand mode.
|
|
2254
|
-
* Accumulates pending frames (capped at 60) and starts the loop if not running.
|
|
2255
|
-
* No-op if frameloop is not 'demand'.
|
|
2256
|
-
* @param {number} [frames=1] - Number of frames to request
|
|
2257
|
-
* @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
|
|
2258
|
-
* - `false` (default): Sets pending frames to the specified value (replaces existing count)
|
|
2259
|
-
* - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
|
|
2260
|
-
* @returns {void}
|
|
2261
|
-
* @example
|
|
2262
|
-
* // Request a single frame render
|
|
2263
|
-
* scheduler.invalidate();
|
|
2264
|
-
*
|
|
2265
|
-
* @example
|
|
2266
|
-
* // Request 5 frames (e.g., for animations)
|
|
2267
|
-
* scheduler.invalidate(5);
|
|
2268
|
-
*
|
|
2269
|
-
* @example
|
|
2270
|
-
* // Set pending frames to exactly 3 (don't stack with existing)
|
|
2271
|
-
* scheduler.invalidate(3, false);
|
|
2272
|
-
*
|
|
2273
|
-
* @example
|
|
2274
|
-
* // Add 2 more frames to existing pending count
|
|
2275
|
-
* scheduler.invalidate(2, true);
|
|
2276
|
-
*/
|
|
2277
|
-
invalidate(frames?: number, stackFrames?: boolean): void;
|
|
2278
|
-
/**
|
|
2279
|
-
* Reset timing state for deterministic testing.
|
|
2280
|
-
* Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
|
|
2281
|
-
* @returns {void}
|
|
2282
|
-
*/
|
|
2283
|
-
resetTiming(): void;
|
|
2284
|
-
/**
|
|
2285
|
-
* Manually execute a single frame for all roots.
|
|
2286
|
-
* Useful for frameloop='never' mode or testing scenarios.
|
|
2287
|
-
* @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
|
|
2288
|
-
* @returns {void}
|
|
2289
|
-
* @example
|
|
2290
|
-
* // Manual control mode
|
|
2291
|
-
* scheduler.frameloop = 'never';
|
|
2292
|
-
* scheduler.step(); // Execute one frame
|
|
2293
|
-
*/
|
|
2294
|
-
step(timestamp?: number): void;
|
|
2295
|
-
/**
|
|
2296
|
-
* Manually execute a single job by its ID.
|
|
2297
|
-
* Useful for testing individual job callbacks in isolation.
|
|
2298
|
-
* @param {string} id - The job ID to step
|
|
2299
|
-
* @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
|
|
2300
|
-
* @returns {void}
|
|
2301
|
-
*/
|
|
2302
|
-
stepJob(id: string, timestamp?: number): void;
|
|
2303
|
-
/**
|
|
2304
|
-
* Main RAF loop callback.
|
|
2305
|
-
* Executes frame, handles demand mode, and schedules next frame.
|
|
2306
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2307
|
-
* @returns {void}
|
|
2308
|
-
* @private
|
|
2309
|
-
*/
|
|
2310
|
-
private loop;
|
|
2311
|
-
/**
|
|
2312
|
-
* Execute a single frame across all roots.
|
|
2313
|
-
* Order: globalBefore → each root's jobs → globalAfter
|
|
2314
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2315
|
-
* @returns {void}
|
|
2316
|
-
* @private
|
|
2317
|
-
*/
|
|
2318
|
-
private executeFrame;
|
|
2319
|
-
/**
|
|
2320
|
-
* Run all global jobs from a job map.
|
|
2321
|
-
* Catches and logs errors without stopping execution.
|
|
2322
|
-
* @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
|
|
2323
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2324
|
-
* @returns {void}
|
|
2325
|
-
* @private
|
|
2326
|
-
*/
|
|
2327
|
-
private runGlobalJobs;
|
|
2328
|
-
/**
|
|
2329
|
-
* Execute all jobs for a single root in sorted order.
|
|
2330
|
-
* Rebuilds sorted job list if needed, then dispatches each job.
|
|
2331
|
-
* Errors are caught and propagated via triggerError.
|
|
2332
|
-
* @param {RootEntry} root - The root entry to tick
|
|
2333
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2334
|
-
* @param {number} delta - Time since last frame in seconds
|
|
2335
|
-
* @returns {void}
|
|
2336
|
-
* @private
|
|
2337
|
-
*/
|
|
2338
|
-
private tickRoot;
|
|
2339
|
-
/**
|
|
2340
|
-
* Get the total number of registered jobs across all roots.
|
|
2341
|
-
* Includes both per-root jobs and global before/after jobs.
|
|
2342
|
-
* @returns {number} Total job count
|
|
2343
|
-
*/
|
|
2344
|
-
getJobCount(): number;
|
|
2345
|
-
/**
|
|
2346
|
-
* Get all registered job IDs across all roots.
|
|
2347
|
-
* Includes both per-root jobs and global before/after jobs.
|
|
2348
|
-
* @returns {string[]} Array of all job IDs
|
|
2349
|
-
*/
|
|
2350
|
-
getJobIds(): string[];
|
|
2351
|
-
/**
|
|
2352
|
-
* Get the number of registered roots (Canvas instances).
|
|
2353
|
-
* @returns {number} Number of registered roots
|
|
2354
|
-
*/
|
|
2355
|
-
getRootCount(): number;
|
|
2356
|
-
/**
|
|
2357
|
-
* Check if any user (non-system) jobs are registered in a specific phase.
|
|
2358
|
-
* Used by the default render job to know if a user has taken over rendering.
|
|
2359
|
-
*
|
|
2360
|
-
* @param phase The phase to check
|
|
2361
|
-
* @param rootId Optional root ID to check (checks all roots if not provided)
|
|
2362
|
-
* @returns true if any user jobs exist in the phase
|
|
2363
|
-
*/
|
|
2364
|
-
hasUserJobsInPhase(phase: string, rootId?: string): boolean;
|
|
2365
|
-
/**
|
|
2366
|
-
* Generate a unique root ID for automatic root registration.
|
|
2367
|
-
* @returns {string} A unique root ID in the format 'root_N'
|
|
2368
|
-
*/
|
|
2369
|
-
generateRootId(): string;
|
|
2370
|
-
/**
|
|
2371
|
-
* Generate a unique job ID.
|
|
2372
|
-
* @returns {string} A unique job ID in the format 'job_N'
|
|
2373
|
-
* @private
|
|
2374
|
-
*/
|
|
2375
|
-
private generateJobId;
|
|
2376
|
-
/**
|
|
2377
|
-
* Normalize before/after constraints to a Set.
|
|
2378
|
-
* Handles undefined, single string, or array inputs.
|
|
2379
|
-
* @param {string | string[] | undefined} value - The constraint value(s)
|
|
2380
|
-
* @returns {Set<string>} Normalized Set of constraint strings
|
|
2381
|
-
* @private
|
|
2382
|
-
*/
|
|
2383
|
-
private normalizeConstraints;
|
|
2384
|
-
}
|
|
2385
|
-
/**
|
|
2386
|
-
* Get the global scheduler instance.
|
|
2387
|
-
* Creates one if it doesn't exist.
|
|
2388
|
-
*/
|
|
2389
|
-
declare const getScheduler: () => Scheduler;
|
|
2390
|
-
|
|
2391
1954
|
/**
|
|
2392
1955
|
* Frame hook with phase-based ordering, priority, and FPS throttling.
|
|
2393
1956
|
*
|
|
2394
|
-
*
|
|
2395
|
-
* - Inside Canvas: Full RootState (
|
|
2396
|
-
* - Outside Canvas
|
|
2397
|
-
*
|
|
1957
|
+
* Always delivers full RootState — works both inside and outside Canvas context:
|
|
1958
|
+
* - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
|
|
1959
|
+
* - Outside Canvas: The job registers immediately but the callback is held until a
|
|
1960
|
+
* Canvas adopts it, then runs with full RootState. For hostless / standalone
|
|
1961
|
+
* frame loops with no Canvas, use `@pmndrs/scheduler` directly.
|
|
2398
1962
|
*
|
|
2399
1963
|
* Returns a controls object for manual stepping, pausing, and resuming.
|
|
2400
1964
|
*
|
|
2401
1965
|
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
2402
1966
|
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
2403
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
1967
|
+
* @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
|
|
2404
1968
|
*
|
|
2405
1969
|
* @example
|
|
2406
1970
|
* // Simple priority (backwards compat)
|
|
@@ -2411,16 +1975,16 @@ declare const getScheduler: () => Scheduler;
|
|
|
2411
1975
|
* useFrame((state, delta) => { ... }, { phase: 'physics' })
|
|
2412
1976
|
*
|
|
2413
1977
|
* @example
|
|
2414
|
-
* // Outside Canvas - waits for Canvas
|
|
1978
|
+
* // Outside Canvas - callback waits for a Canvas, then always has full state
|
|
2415
1979
|
* function UI() {
|
|
2416
1980
|
* useFrame((state, delta) => { syncUI(state.camera) });
|
|
2417
1981
|
* return <button>...</button>;
|
|
2418
1982
|
* }
|
|
2419
1983
|
*
|
|
2420
1984
|
* @example
|
|
2421
|
-
* //
|
|
2422
|
-
* getScheduler
|
|
2423
|
-
*
|
|
1985
|
+
* // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
|
|
1986
|
+
* import { getScheduler } from '@pmndrs/scheduler'
|
|
1987
|
+
* getScheduler().register((state, delta) => { updateGame(delta) })
|
|
2424
1988
|
*
|
|
2425
1989
|
* @example
|
|
2426
1990
|
* // Scheduler-only access (no callback)
|
|
@@ -2443,11 +2007,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2443
2007
|
/** Callback when texture(s) finish loading */
|
|
2444
2008
|
onLoad?: (texture: MappedTextureType<Url>) => void;
|
|
2445
2009
|
/**
|
|
2446
|
-
*
|
|
2447
|
-
* When true:
|
|
2010
|
+
* Register the texture(s) in R3F's global texture registry for access via useTextures().
|
|
2011
|
+
* When true (the default):
|
|
2448
2012
|
* - Textures persist until explicitly disposed
|
|
2449
|
-
* -
|
|
2450
|
-
*
|
|
2013
|
+
* - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
|
|
2014
|
+
*
|
|
2015
|
+
* Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
|
|
2016
|
+
* changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
|
|
2017
|
+
*
|
|
2018
|
+
* Pass `false` to opt out of registry enrollment entirely.
|
|
2019
|
+
* @default true
|
|
2451
2020
|
*/
|
|
2452
2021
|
cache?: boolean;
|
|
2453
2022
|
};
|
|
@@ -2471,15 +2040,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2471
2040
|
* normal: '/normal.png'
|
|
2472
2041
|
* })
|
|
2473
2042
|
*
|
|
2474
|
-
* //
|
|
2475
|
-
* //
|
|
2476
|
-
* const diffuse = useTexture('/diffuse.png'
|
|
2043
|
+
* // Textures are registered in the global registry by default — the same texture
|
|
2044
|
+
* // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
|
|
2045
|
+
* const diffuse = useTexture('/diffuse.png')
|
|
2477
2046
|
* diffuse.colorSpace = THREE.SRGBColorSpace
|
|
2478
2047
|
*
|
|
2479
2048
|
* // Another component gets the SAME texture with colorSpace already set
|
|
2480
|
-
* const sameDiffuse = useTexture('/diffuse.png'
|
|
2049
|
+
* const sameDiffuse = useTexture('/diffuse.png')
|
|
2050
|
+
*
|
|
2051
|
+
* // Opt out of registry enrollment for a one-off texture
|
|
2052
|
+
* const scratch = useTexture('/scratch.png', { cache: false })
|
|
2481
2053
|
*
|
|
2482
|
-
* // Access
|
|
2054
|
+
* // Access the registry directly
|
|
2483
2055
|
* const { get } = useTextures()
|
|
2484
2056
|
* const cached = get('/diffuse.png')
|
|
2485
2057
|
* ```
|
|
@@ -2496,63 +2068,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
|
|
|
2496
2068
|
cache?: boolean;
|
|
2497
2069
|
}) => react_jsx_runtime.JSX.Element;
|
|
2498
2070
|
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2071
|
+
/** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
|
|
2072
|
+
type TextureInput = string | string[] | Record<string, string>;
|
|
2073
|
+
/** Result of a `get()` read, mirroring the input shape. */
|
|
2074
|
+
type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
|
|
2075
|
+
[K in keyof Input]: Texture$1 | undefined;
|
|
2502
2076
|
};
|
|
2077
|
+
/** Options for `dispose()`. */
|
|
2078
|
+
interface DisposeOptions {
|
|
2079
|
+
/** Dispose even if the texture still has active references (default false). */
|
|
2080
|
+
force?: boolean;
|
|
2081
|
+
}
|
|
2503
2082
|
interface UseTexturesReturn {
|
|
2504
|
-
/** Map
|
|
2505
|
-
|
|
2506
|
-
/**
|
|
2507
|
-
get
|
|
2508
|
-
/** Check
|
|
2509
|
-
has
|
|
2510
|
-
/**
|
|
2511
|
-
|
|
2512
|
-
|
|
2513
|
-
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
|
|
2083
|
+
/** The live registry Map (key → Texture). Treat as read-only. */
|
|
2084
|
+
readonly all: Map<string, Texture$1>;
|
|
2085
|
+
/** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
|
|
2086
|
+
get<Input extends TextureInput>(input: Input): TextureResult<Input>;
|
|
2087
|
+
/** Check whether a key exists in the registry. */
|
|
2088
|
+
has(key: string): boolean;
|
|
2089
|
+
/**
|
|
2090
|
+
* Register a texture (or a record of textures) that has no URL — e.g. a render
|
|
2091
|
+
* target or procedural texture. URL-loaded textures are registered automatically
|
|
2092
|
+
* by `useTexture` (registry enrollment is on by default).
|
|
2093
|
+
*/
|
|
2094
|
+
add(key: string, texture: Texture$1): void;
|
|
2095
|
+
add(record: Record<string, Texture$1>): void;
|
|
2096
|
+
/**
|
|
2097
|
+
* Dispose a texture's GPU resources and remove it from the registry.
|
|
2098
|
+
* Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
|
|
2099
|
+
* skipped (with a warning) unless `{ force: true }` is passed.
|
|
2100
|
+
* @returns true if disposed, false if skipped.
|
|
2101
|
+
*/
|
|
2102
|
+
dispose(key: string, options?: DisposeOptions): boolean;
|
|
2103
|
+
/** Dispose every texture in the registry and clear it. Use on scene teardown. */
|
|
2104
|
+
disposeAll(): void;
|
|
2524
2105
|
}
|
|
2525
2106
|
/**
|
|
2526
|
-
*
|
|
2107
|
+
* Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
|
|
2108
|
+
*
|
|
2109
|
+
* This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
|
|
2110
|
+
* a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
|
|
2111
|
+
* `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
|
|
2527
2112
|
*
|
|
2528
|
-
*
|
|
2529
|
-
*
|
|
2113
|
+
* The returned handle is **reactive**: the calling component re-renders when the registry
|
|
2114
|
+
* changes. Pass a selector to scope the subscription to a single read.
|
|
2530
2115
|
*
|
|
2531
2116
|
* @example
|
|
2532
2117
|
* ```tsx
|
|
2533
|
-
*
|
|
2118
|
+
* // Load + register once (anywhere in the tree) — registered by default
|
|
2119
|
+
* useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
2534
2120
|
*
|
|
2535
|
-
* //
|
|
2536
|
-
*
|
|
2537
|
-
*
|
|
2538
|
-
* const tex = useTexture('/textures/diffuse.png', { cache: true })
|
|
2539
|
-
* }
|
|
2121
|
+
* // Reach them from another component — record form lands straight into a material
|
|
2122
|
+
* const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
2123
|
+
* return <meshStandardMaterial map={map} normalMap={normalMap} />
|
|
2540
2124
|
*
|
|
2541
|
-
* //
|
|
2542
|
-
* const
|
|
2543
|
-
* if (diffuse) material.map = diffuse
|
|
2125
|
+
* // A set of heightmaps at once
|
|
2126
|
+
* const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
|
|
2544
2127
|
*
|
|
2545
|
-
* //
|
|
2546
|
-
*
|
|
2128
|
+
* // Register a non-URL texture (render target / procedural)
|
|
2129
|
+
* useTextures().add('rt-main', renderTarget.texture)
|
|
2547
2130
|
*
|
|
2548
|
-
* //
|
|
2549
|
-
* dispose('/
|
|
2550
|
-
*
|
|
2551
|
-
* // Nuclear option - dispose everything
|
|
2552
|
-
* disposeAll()
|
|
2131
|
+
* // Deliberate GPU cleanup (refcount-aware; force to override)
|
|
2132
|
+
* useTextures().dispose('/diffuse.jpg')
|
|
2133
|
+
* useTextures().disposeAll() // scene teardown
|
|
2553
2134
|
* ```
|
|
2135
|
+
*
|
|
2136
|
+
* @remarks
|
|
2137
|
+
* **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
|
|
2138
|
+
* intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
|
|
2139
|
+
* populate the registry without Suspense, at the cost of putting loading back into this hook. It
|
|
2140
|
+
* will be added only if a concrete consumer needs imperative loading; for now, loading lives in
|
|
2141
|
+
* `useTexture`.
|
|
2554
2142
|
*/
|
|
2555
2143
|
declare function useTextures(): UseTexturesReturn;
|
|
2144
|
+
declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
|
|
2556
2145
|
|
|
2557
2146
|
/**
|
|
2558
2147
|
* Creates a render target compatible with the current renderer.
|
|
@@ -2582,9 +2171,9 @@ declare function useTextures(): UseTexturesReturn;
|
|
|
2582
2171
|
* const fbo = useRenderTarget(512, 256, { samples: 4 })
|
|
2583
2172
|
* ```
|
|
2584
2173
|
*/
|
|
2585
|
-
declare function useRenderTarget(options?: RenderTargetOptions):
|
|
2586
|
-
declare function useRenderTarget(size: number, options?: RenderTargetOptions):
|
|
2587
|
-
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions):
|
|
2174
|
+
declare function useRenderTarget(options?: RenderTargetOptions): WebGLRenderTarget;
|
|
2175
|
+
declare function useRenderTarget(size: number, options?: RenderTargetOptions): WebGLRenderTarget;
|
|
2176
|
+
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): WebGLRenderTarget;
|
|
2588
2177
|
|
|
2589
2178
|
/**
|
|
2590
2179
|
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
@@ -2671,7 +2260,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2671
2260
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2672
2261
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2673
2262
|
*
|
|
2674
|
-
*
|
|
2263
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
2264
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
2265
|
+
*
|
|
2266
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2675
2267
|
* @param frames - Number of frames to request (default: 1)
|
|
2676
2268
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2677
2269
|
*
|
|
@@ -2682,14 +2274,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2682
2274
|
* Advances the frameloop and runs render effects.
|
|
2683
2275
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2684
2276
|
*
|
|
2277
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2278
|
+
* registered root is stepped for backwards compatibility.
|
|
2279
|
+
*
|
|
2685
2280
|
* @param timestamp - The timestamp to use for this frame
|
|
2686
2281
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2687
|
-
* @param state -
|
|
2688
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2282
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2689
2283
|
*
|
|
2690
2284
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2691
2285
|
*/
|
|
2692
|
-
declare function advance(timestamp: number): void;
|
|
2286
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2693
2287
|
|
|
2694
2288
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2695
2289
|
declare function ReactReconciler<
|
|
@@ -3734,6 +3328,7 @@ declare namespace ReactReconciler {
|
|
|
3734
3328
|
|
|
3735
3329
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3736
3330
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3331
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3737
3332
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3738
3333
|
|
|
3739
3334
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3760,11 +3355,6 @@ declare function flushSync<R>(fn: () => R): R;
|
|
|
3760
3355
|
declare const context: React$1.Context<RootStore>;
|
|
3761
3356
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3762
3357
|
|
|
3763
|
-
/**
|
|
3764
|
-
* Safely flush async effects when testing, simulating a legacy root.
|
|
3765
|
-
* @deprecated Import from React instead. import { act } from 'react'
|
|
3766
|
-
*/
|
|
3767
|
-
declare const act: typeof React$1.act;
|
|
3768
3358
|
/**
|
|
3769
3359
|
* An SSR-friendly useLayoutEffect.
|
|
3770
3360
|
*
|
|
@@ -4182,29 +3772,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
4182
3772
|
* Used to identify values that should be resolved from refs after mount.
|
|
4183
3773
|
*/
|
|
4184
3774
|
declare const FROM_REF: unique symbol;
|
|
3775
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3776
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3777
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3778
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3779
|
+
transform?: (value: T) => R;
|
|
3780
|
+
}
|
|
4185
3781
|
/**
|
|
4186
3782
|
* Defers prop application until the referenced object is available.
|
|
4187
3783
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
4188
3784
|
*
|
|
3785
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3786
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3787
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3788
|
+
* what gets assigned.
|
|
3789
|
+
*
|
|
4189
3790
|
* @param ref - React ref object to resolve at mount time
|
|
4190
|
-
* @
|
|
3791
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3792
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
4191
3793
|
*
|
|
4192
3794
|
* @example
|
|
4193
3795
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
4194
3796
|
*
|
|
4195
3797
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
4196
3798
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3799
|
+
*
|
|
3800
|
+
* @example
|
|
3801
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3802
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
4197
3803
|
*/
|
|
4198
3804
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3805
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
4199
3806
|
/**
|
|
4200
3807
|
* Type guard to check if a value is a fromRef marker.
|
|
4201
3808
|
*
|
|
4202
3809
|
* @param value - Value to check
|
|
4203
3810
|
* @returns True if value is a fromRef marker
|
|
4204
3811
|
*/
|
|
4205
|
-
declare function isFromRef(value: unknown): value is
|
|
4206
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
4207
|
-
};
|
|
3812
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
4208
3813
|
|
|
4209
3814
|
/**
|
|
4210
3815
|
* Symbol marker for mount-only method calls.
|
|
@@ -4231,7 +3836,15 @@ declare const ONCE: unique symbol;
|
|
|
4231
3836
|
* // No arguments
|
|
4232
3837
|
* <geometry center={once()} />
|
|
4233
3838
|
*/
|
|
4234
|
-
declare function once<
|
|
3839
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3840
|
+
/**
|
|
3841
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3842
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3843
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3844
|
+
*
|
|
3845
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3846
|
+
*/
|
|
3847
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
4235
3848
|
/**
|
|
4236
3849
|
* Type guard to check if a value is a once marker.
|
|
4237
3850
|
*
|
|
@@ -4248,5 +3861,5 @@ declare function isOnce(value: unknown): value is {
|
|
|
4248
3861
|
*/
|
|
4249
3862
|
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
4250
3863
|
|
|
4251
|
-
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,
|
|
4252
|
-
export type { Act,
|
|
3864
|
+
export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
|
|
3865
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, FromRefMarker, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as 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, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, LegacyRootState as 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 };
|