@react-three/fiber 10.0.0-canary.1b98c17 → 10.0.0-canary.20de6b2
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 +2694 -3489
- package/dist/index.d.cts +190 -805
- package/dist/index.d.mts +190 -805
- package/dist/index.d.ts +190 -805
- package/dist/index.mjs +2719 -3513
- package/dist/legacy.cjs +2521 -3321
- package/dist/legacy.d.cts +189 -807
- package/dist/legacy.d.mts +189 -807
- package/dist/legacy.d.ts +189 -807
- package/dist/legacy.mjs +3058 -3857
- package/dist/webgpu/index.cjs +2975 -3987
- package/dist/webgpu/index.d.cts +231 -848
- package/dist/webgpu/index.d.mts +231 -848
- package/dist/webgpu/index.d.ts +231 -848
- package/dist/webgpu/index.mjs +3108 -4119
- 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.cts
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
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, Node as Node$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three';
|
|
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, Node as Node$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, 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
6
|
import { WebGPURenderer as WebGPURenderer$1, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject } 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
15
|
function _mergeNamespaces(n, m) {
|
|
@@ -37,23 +38,28 @@ function _mergeNamespaces(n, m) {
|
|
|
37
38
|
declare const R3F_BUILD_LEGACY = true;
|
|
38
39
|
declare const R3F_BUILD_WEBGPU = false;
|
|
39
40
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
41
|
+
type Inspector = never;
|
|
42
|
+
/** Not available on the legacy (WebGL-only) entry. */
|
|
43
|
+
declare function loadInspector(): Promise<never>;
|
|
43
44
|
declare const WebGPURenderer: {
|
|
44
45
|
new (): {};
|
|
45
46
|
};
|
|
46
47
|
|
|
47
48
|
declare const RenderTarget: any;
|
|
48
49
|
|
|
50
|
+
declare const CubeRenderTarget: any;
|
|
51
|
+
|
|
49
52
|
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
50
53
|
__proto__: null,
|
|
54
|
+
CubeRenderTarget: CubeRenderTarget,
|
|
55
|
+
CubeRenderTargetCompat: WebGLCubeRenderTarget,
|
|
51
56
|
Inspector: Inspector,
|
|
52
57
|
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
53
58
|
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
54
59
|
RenderTarget: RenderTarget,
|
|
55
60
|
RenderTargetCompat: WebGLRenderTarget,
|
|
56
|
-
WebGPURenderer: WebGPURenderer
|
|
61
|
+
WebGPURenderer: WebGPURenderer,
|
|
62
|
+
loadInspector: loadInspector
|
|
57
63
|
}, [THREE$1]);
|
|
58
64
|
|
|
59
65
|
//* Utility Types ==============================
|
|
@@ -291,228 +297,33 @@ interface VisibilityEntry {
|
|
|
291
297
|
}
|
|
292
298
|
|
|
293
299
|
//* Scheduler Types (useFrame) ==============================
|
|
300
|
+
//
|
|
301
|
+
// The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
|
|
302
|
+
// This file re-exports them and layers r3f's RootState-aware frame state on top,
|
|
303
|
+
// so existing `#types` imports across the codebase keep resolving unchanged.
|
|
294
304
|
|
|
295
305
|
|
|
296
306
|
|
|
297
|
-
//
|
|
298
|
-
|
|
299
|
-
/**
|
|
300
|
-
* Options for useFrame hook
|
|
301
|
-
*/
|
|
302
|
-
interface UseFrameNextOptions {
|
|
303
|
-
/** Optional stable id for the job. Auto-generated if not provided */
|
|
304
|
-
id?: string
|
|
305
|
-
/** Named phase to run in. Default: 'update' */
|
|
306
|
-
phase?: string
|
|
307
|
-
/** Run before this phase or job id */
|
|
308
|
-
before?: string | string[]
|
|
309
|
-
/** Run after this phase or job id */
|
|
310
|
-
after?: string | string[]
|
|
311
|
-
/** Priority within phase. Higher runs first. Default: 0 */
|
|
312
|
-
priority?: number
|
|
313
|
-
/** Max frames per second for this job */
|
|
314
|
-
fps?: number
|
|
315
|
-
/** If true, skip frames when behind. If false, try to catch up. Default: true */
|
|
316
|
-
drop?: boolean
|
|
317
|
-
/** Enable/disable without unregistering. Default: true */
|
|
318
|
-
enabled?: boolean
|
|
319
|
-
}
|
|
320
|
-
|
|
321
|
-
/** Alias for UseFrameNextOptions */
|
|
322
|
-
type UseFrameOptions = UseFrameNextOptions
|
|
307
|
+
// Frame State (r3f-specific) --------------------------------
|
|
323
308
|
|
|
324
309
|
/**
|
|
325
|
-
*
|
|
326
|
-
*/
|
|
327
|
-
interface AddPhaseOptions {
|
|
328
|
-
/** Insert this phase before the specified phase */
|
|
329
|
-
before?: string
|
|
330
|
-
/** Insert this phase after the specified phase */
|
|
331
|
-
after?: string
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
// Frame State --------------------------------
|
|
335
|
-
|
|
336
|
-
/**
|
|
337
|
-
* Timing-only state for independent/outside mode (no RootState)
|
|
338
|
-
*/
|
|
339
|
-
interface FrameTimingState {
|
|
340
|
-
/** High-resolution timestamp from RAF (ms) */
|
|
341
|
-
time: number
|
|
342
|
-
/** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
|
|
343
|
-
delta: number
|
|
344
|
-
/** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
|
|
345
|
-
elapsed: number
|
|
346
|
-
/** Incrementing frame counter */
|
|
347
|
-
frame: number
|
|
348
|
-
}
|
|
349
|
-
|
|
350
|
-
/**
|
|
351
|
-
* State passed to useFrame callbacks (extends RootState with timing)
|
|
310
|
+
* State passed to useFrame callbacks (extends RootState with timing).
|
|
352
311
|
*/
|
|
353
312
|
interface FrameNextState extends RootState, FrameTimingState {}
|
|
354
313
|
|
|
355
314
|
/** Alias for FrameNextState */
|
|
356
315
|
type FrameState = FrameNextState
|
|
357
316
|
|
|
358
|
-
//
|
|
317
|
+
// Callback Types (r3f-specific) --------------------------------
|
|
359
318
|
|
|
360
319
|
/**
|
|
361
|
-
*
|
|
320
|
+
* Callback function for useFrame. Receives the full r3f RootState plus timing.
|
|
362
321
|
*/
|
|
363
|
-
|
|
364
|
-
/** State provider for callbacks. Optional in independent mode. */
|
|
365
|
-
getState?: () => any
|
|
366
|
-
/** Error handler for job errors. Falls back to console.error if not provided. */
|
|
367
|
-
onError?: (error: Error) => void
|
|
368
|
-
}
|
|
369
|
-
|
|
370
|
-
// Callback Types --------------------------------
|
|
371
|
-
|
|
372
|
-
/**
|
|
373
|
-
* Callback function for useFrame
|
|
374
|
-
*/
|
|
375
|
-
type FrameNextCallback = (state: FrameNextState, delta: number) => void
|
|
322
|
+
type FrameNextCallback = FrameCallback$1<RootState>
|
|
376
323
|
|
|
377
324
|
/** Alias for FrameNextCallback */
|
|
378
325
|
type FrameCallback = FrameNextCallback
|
|
379
326
|
|
|
380
|
-
// Controls returned from useFrame --------------------------------
|
|
381
|
-
|
|
382
|
-
/**
|
|
383
|
-
* Controls object returned from useFrame hook
|
|
384
|
-
*/
|
|
385
|
-
interface FrameNextControls {
|
|
386
|
-
/** The job's unique ID */
|
|
387
|
-
id: string
|
|
388
|
-
/** Access to the global scheduler for frame loop control */
|
|
389
|
-
scheduler: SchedulerApi
|
|
390
|
-
/** Manually step this job only (bypasses FPS limiting) */
|
|
391
|
-
step(timestamp?: number): void
|
|
392
|
-
/** Manually step ALL jobs in the scheduler */
|
|
393
|
-
stepAll(timestamp?: number): void
|
|
394
|
-
/** Pause this job (set enabled=false) */
|
|
395
|
-
pause(): void
|
|
396
|
-
/** Resume this job (set enabled=true) */
|
|
397
|
-
resume(): void
|
|
398
|
-
/** Reactive paused state - automatically triggers re-render when changed */
|
|
399
|
-
isPaused: boolean
|
|
400
|
-
}
|
|
401
|
-
|
|
402
|
-
/** Alias for FrameNextControls */
|
|
403
|
-
type FrameControls = FrameNextControls
|
|
404
|
-
|
|
405
|
-
// Scheduler Interface --------------------------------
|
|
406
|
-
|
|
407
|
-
/**
|
|
408
|
-
* Public interface for the global Scheduler
|
|
409
|
-
*/
|
|
410
|
-
interface SchedulerApi {
|
|
411
|
-
//* Phase Management --------------------------------
|
|
412
|
-
|
|
413
|
-
/** Add a named phase to the scheduler */
|
|
414
|
-
addPhase(name: string, options?: AddPhaseOptions): void
|
|
415
|
-
/** Get the ordered list of phase names */
|
|
416
|
-
readonly phases: string[]
|
|
417
|
-
/** Check if a phase exists */
|
|
418
|
-
hasPhase(name: string): boolean
|
|
419
|
-
|
|
420
|
-
//* Root Management --------------------------------
|
|
421
|
-
|
|
422
|
-
/** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
|
|
423
|
-
registerRoot(id: string, options?: RootOptions): () => void
|
|
424
|
-
/** Unregister a root */
|
|
425
|
-
unregisterRoot(id: string): void
|
|
426
|
-
/** Generate a unique root ID */
|
|
427
|
-
generateRootId(): string
|
|
428
|
-
/** Get the number of registered roots */
|
|
429
|
-
getRootCount(): number
|
|
430
|
-
/** Check if any root is registered and ready */
|
|
431
|
-
readonly isReady: boolean
|
|
432
|
-
/** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
|
|
433
|
-
onRootReady(callback: () => void): () => void
|
|
434
|
-
|
|
435
|
-
//* Job Registration --------------------------------
|
|
436
|
-
|
|
437
|
-
/** Register a job with the scheduler (returns unsubscribe function) */
|
|
438
|
-
register(
|
|
439
|
-
callback: FrameNextCallback,
|
|
440
|
-
options?: {
|
|
441
|
-
id?: string
|
|
442
|
-
rootId?: string
|
|
443
|
-
phase?: string
|
|
444
|
-
before?: string | string[]
|
|
445
|
-
after?: string | string[]
|
|
446
|
-
priority?: number
|
|
447
|
-
fps?: number
|
|
448
|
-
drop?: boolean
|
|
449
|
-
enabled?: boolean
|
|
450
|
-
},
|
|
451
|
-
): () => void
|
|
452
|
-
/** Update a job's options */
|
|
453
|
-
updateJob(
|
|
454
|
-
id: string,
|
|
455
|
-
options: {
|
|
456
|
-
priority?: number
|
|
457
|
-
fps?: number
|
|
458
|
-
drop?: boolean
|
|
459
|
-
enabled?: boolean
|
|
460
|
-
phase?: string
|
|
461
|
-
before?: string | string[]
|
|
462
|
-
after?: string | string[]
|
|
463
|
-
},
|
|
464
|
-
): void
|
|
465
|
-
/** Unregister a job by ID */
|
|
466
|
-
unregister(id: string, rootId?: string): void
|
|
467
|
-
/** Get the number of registered jobs */
|
|
468
|
-
getJobCount(): number
|
|
469
|
-
/** Get all job IDs */
|
|
470
|
-
getJobIds(): string[]
|
|
471
|
-
|
|
472
|
-
//* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
|
|
473
|
-
|
|
474
|
-
/** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
|
|
475
|
-
registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
|
|
476
|
-
|
|
477
|
-
//* Idle Callbacks (for legacy addTail) --------------------------------
|
|
478
|
-
|
|
479
|
-
/** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
|
|
480
|
-
onIdle(callback: (timestamp: number) => void): () => void
|
|
481
|
-
|
|
482
|
-
//* Frame Loop Control --------------------------------
|
|
483
|
-
|
|
484
|
-
/** Start the scheduler loop */
|
|
485
|
-
start(): void
|
|
486
|
-
/** Stop the scheduler loop */
|
|
487
|
-
stop(): void
|
|
488
|
-
/** Check if the scheduler is running */
|
|
489
|
-
readonly isRunning: boolean
|
|
490
|
-
/** Get/set the frameloop mode ('always', 'demand', 'never') */
|
|
491
|
-
frameloop: Frameloop
|
|
492
|
-
/** Independent mode - runs without Canvas, callbacks receive timing-only state */
|
|
493
|
-
independent: boolean
|
|
494
|
-
|
|
495
|
-
//* Manual Stepping --------------------------------
|
|
496
|
-
|
|
497
|
-
/** Manually step all jobs once (for frameloop='never' or testing) */
|
|
498
|
-
step(timestamp?: number): void
|
|
499
|
-
/** Manually step a single job by ID */
|
|
500
|
-
stepJob(id: string, timestamp?: number): void
|
|
501
|
-
/** Request frame(s) to be rendered (for frameloop='demand') */
|
|
502
|
-
invalidate(frames?: number): void
|
|
503
|
-
|
|
504
|
-
//* Per-Job Control --------------------------------
|
|
505
|
-
|
|
506
|
-
/** Check if a job is paused */
|
|
507
|
-
isJobPaused(id: string): boolean
|
|
508
|
-
/** Pause a job */
|
|
509
|
-
pauseJob(id: string): void
|
|
510
|
-
/** Resume a job */
|
|
511
|
-
resumeJob(id: string): void
|
|
512
|
-
/** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
|
|
513
|
-
subscribeJobState(id: string, listener: () => void): () => void
|
|
514
|
-
}
|
|
515
|
-
|
|
516
327
|
//* Buffer Types (useBuffers) ========================================
|
|
517
328
|
|
|
518
329
|
/**
|
|
@@ -686,9 +497,21 @@ interface InternalState {
|
|
|
686
497
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
687
498
|
*/
|
|
688
499
|
canvasTarget?: CanvasTarget
|
|
500
|
+
/**
|
|
501
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
502
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
503
|
+
*
|
|
504
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
505
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
506
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
507
|
+
* invalidate some other canvas's descriptor instead.
|
|
508
|
+
*
|
|
509
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
510
|
+
*/
|
|
511
|
+
canvasTargetSizeDirty?: boolean
|
|
689
512
|
/**
|
|
690
513
|
* Whether multi-canvas rendering is active.
|
|
691
|
-
* True when any canvas uses `
|
|
514
|
+
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
692
515
|
* When true, setCanvasTarget is called before each render.
|
|
693
516
|
*/
|
|
694
517
|
isMultiCanvas?: boolean
|
|
@@ -786,8 +609,8 @@ interface RootState {
|
|
|
786
609
|
setSize: (width?: number, height?: number, top?: number, left?: number) => void
|
|
787
610
|
/** Shortcut to manual setting the pixel ratio */
|
|
788
611
|
setDpr: (dpr: Dpr) => void
|
|
789
|
-
/** Shortcut to setting frameloop flags */
|
|
790
|
-
setFrameloop: (frameloop
|
|
612
|
+
/** Shortcut to setting frameloop flags. No args resets to 'always'. */
|
|
613
|
+
setFrameloop: (frameloop?: Frameloop) => void
|
|
791
614
|
/** Set error state to propagate to error boundary */
|
|
792
615
|
setError: (error: Error | null) => void
|
|
793
616
|
/** Current error state (null when no error) */
|
|
@@ -800,10 +623,12 @@ interface RootState {
|
|
|
800
623
|
buffers: BufferStore
|
|
801
624
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
802
625
|
gpuStorage: StorageStore
|
|
803
|
-
/** Global
|
|
804
|
-
textures: Map<string,
|
|
626
|
+
/** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
|
|
627
|
+
textures: Map<string, THREE$1.Texture>
|
|
628
|
+
/** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
|
|
629
|
+
_textureRefs: Map<string, number>
|
|
805
630
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
806
|
-
renderPipeline:
|
|
631
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
807
632
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
808
633
|
passes: Record<string, any>
|
|
809
634
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
@@ -1096,8 +921,6 @@ interface Instance<O = any> {
|
|
|
1096
921
|
attach?: AttachType<O>
|
|
1097
922
|
previousAttach?: any
|
|
1098
923
|
isHidden: boolean
|
|
1099
|
-
/** Deferred ref props to apply in commitMount */
|
|
1100
|
-
deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
|
|
1101
924
|
/** Set of props that have been applied via once() */
|
|
1102
925
|
appliedOnce?: Set<string>
|
|
1103
926
|
}
|
|
@@ -1334,10 +1157,21 @@ type RenderTargetOptions = RenderTargetOptions$1
|
|
|
1334
1157
|
//* Global Types ==============================
|
|
1335
1158
|
|
|
1336
1159
|
declare global {
|
|
1337
|
-
/**
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1160
|
+
/**
|
|
1161
|
+
* Uniform node type.
|
|
1162
|
+
*
|
|
1163
|
+
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1164
|
+
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1165
|
+
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1166
|
+
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1167
|
+
* arity when three made `UniformNode` two-parameter.
|
|
1168
|
+
*
|
|
1169
|
+
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1170
|
+
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1171
|
+
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1172
|
+
* installed three instead of needing to be mirrored by hand.
|
|
1173
|
+
*/
|
|
1174
|
+
type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
|
|
1341
1175
|
|
|
1342
1176
|
/**
|
|
1343
1177
|
* ShaderCallable - the return type of Fn()
|
|
@@ -1482,13 +1316,14 @@ declare module 'three/tsl' {
|
|
|
1482
1316
|
): ShaderCallable<R>
|
|
1483
1317
|
}
|
|
1484
1318
|
|
|
1485
|
-
/**
|
|
1486
|
-
* RenderPipeline Types for useRenderPipeline hook (WebGPU only)
|
|
1487
|
-
*/
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
1319
|
declare global {
|
|
1320
|
+
/**
|
|
1321
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1322
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1323
|
+
* is r185, so the new name is the only one.
|
|
1324
|
+
*/
|
|
1325
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1326
|
+
|
|
1492
1327
|
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1493
1328
|
type PassRecord = Record<string, any>
|
|
1494
1329
|
|
|
@@ -1503,7 +1338,7 @@ declare global {
|
|
|
1503
1338
|
/** Current passes from state */
|
|
1504
1339
|
passes: PassRecord
|
|
1505
1340
|
/** RenderPipeline instance (null if not initialized) */
|
|
1506
|
-
renderPipeline:
|
|
1341
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
1507
1342
|
/** Clear all passes from state */
|
|
1508
1343
|
clearPasses: () => void
|
|
1509
1344
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
@@ -1515,146 +1350,6 @@ declare global {
|
|
|
1515
1350
|
}
|
|
1516
1351
|
}
|
|
1517
1352
|
|
|
1518
|
-
//* useFrameNext Types ==============================
|
|
1519
|
-
|
|
1520
|
-
|
|
1521
|
-
|
|
1522
|
-
//* Global Type Declarations ==============================
|
|
1523
|
-
|
|
1524
|
-
declare global {
|
|
1525
|
-
// Job --------------------------------
|
|
1526
|
-
|
|
1527
|
-
/**
|
|
1528
|
-
* Internal job representation in the scheduler
|
|
1529
|
-
*/
|
|
1530
|
-
interface Job {
|
|
1531
|
-
/** Unique identifier */
|
|
1532
|
-
id: string
|
|
1533
|
-
/** The callback to execute */
|
|
1534
|
-
callback: FrameNextCallback
|
|
1535
|
-
/** Phase this job belongs to */
|
|
1536
|
-
phase: string
|
|
1537
|
-
/** Run before these phases/job ids */
|
|
1538
|
-
before: Set<string>
|
|
1539
|
-
/** Run after these phases/job ids */
|
|
1540
|
-
after: Set<string>
|
|
1541
|
-
/** Priority within phase (higher first) */
|
|
1542
|
-
priority: number
|
|
1543
|
-
/** Insertion order for deterministic tie-breaking */
|
|
1544
|
-
index: number
|
|
1545
|
-
/** Max FPS for this job (undefined = no limit) */
|
|
1546
|
-
fps?: number
|
|
1547
|
-
/** Drop frames when behind (true) or catch up (false) */
|
|
1548
|
-
drop: boolean
|
|
1549
|
-
/** Last run timestamp (ms) */
|
|
1550
|
-
lastRun?: number
|
|
1551
|
-
/** Whether job is enabled */
|
|
1552
|
-
enabled: boolean
|
|
1553
|
-
/** Internal flag: system jobs (like default render) don't block user render takeover */
|
|
1554
|
-
system?: boolean
|
|
1555
|
-
}
|
|
1556
|
-
|
|
1557
|
-
// Phase Graph --------------------------------
|
|
1558
|
-
|
|
1559
|
-
/**
|
|
1560
|
-
* A node in the phase graph
|
|
1561
|
-
*/
|
|
1562
|
-
interface PhaseNode {
|
|
1563
|
-
/** Phase name */
|
|
1564
|
-
name: string
|
|
1565
|
-
/** Whether this was auto-generated from a before/after constraint */
|
|
1566
|
-
isAutoGenerated: boolean
|
|
1567
|
-
}
|
|
1568
|
-
|
|
1569
|
-
/**
|
|
1570
|
-
* Options for creating a job from hook options
|
|
1571
|
-
*/
|
|
1572
|
-
interface JobOptions {
|
|
1573
|
-
id?: string
|
|
1574
|
-
phase?: string
|
|
1575
|
-
before?: string | string[]
|
|
1576
|
-
after?: string | string[]
|
|
1577
|
-
priority?: number
|
|
1578
|
-
fps?: number
|
|
1579
|
-
drop?: boolean
|
|
1580
|
-
enabled?: boolean
|
|
1581
|
-
}
|
|
1582
|
-
|
|
1583
|
-
// Frame Loop State --------------------------------
|
|
1584
|
-
|
|
1585
|
-
/**
|
|
1586
|
-
* Internal frame loop state
|
|
1587
|
-
*/
|
|
1588
|
-
interface FrameLoopState {
|
|
1589
|
-
/** Whether the loop is running */
|
|
1590
|
-
running: boolean
|
|
1591
|
-
/** Current RAF handle */
|
|
1592
|
-
rafHandle: number | null
|
|
1593
|
-
/** Last frame timestamp in ms (null = uninitialized) */
|
|
1594
|
-
lastTime: number | null
|
|
1595
|
-
/** Frame counter */
|
|
1596
|
-
frameCount: number
|
|
1597
|
-
/** Elapsed time since first frame in ms */
|
|
1598
|
-
elapsedTime: number
|
|
1599
|
-
/** createdAt timestamp in ms */
|
|
1600
|
-
createdAt: number
|
|
1601
|
-
}
|
|
1602
|
-
|
|
1603
|
-
// Root Entry --------------------------------
|
|
1604
|
-
|
|
1605
|
-
/**
|
|
1606
|
-
* Internal representation of a registered root (Canvas).
|
|
1607
|
-
* Tracks jobs and manages rebuild state for this root.
|
|
1608
|
-
* @internal
|
|
1609
|
-
*/
|
|
1610
|
-
interface RootEntry {
|
|
1611
|
-
/** Unique identifier for this root */
|
|
1612
|
-
id: string
|
|
1613
|
-
/** Function to get the root's current state. Returns any to support independent mode. */
|
|
1614
|
-
getState: () => any
|
|
1615
|
-
/** Map of job IDs to Job objects */
|
|
1616
|
-
jobs: Map<string, Job>
|
|
1617
|
-
/** Cached sorted job list for execution order */
|
|
1618
|
-
sortedJobs: Job[]
|
|
1619
|
-
/** Whether sortedJobs needs rebuilding */
|
|
1620
|
-
needsRebuild: boolean
|
|
1621
|
-
}
|
|
1622
|
-
|
|
1623
|
-
/**
|
|
1624
|
-
* Internal representation of a global job (deprecated API).
|
|
1625
|
-
* Global jobs run once per frame, not per-root.
|
|
1626
|
-
* Used by legacy addEffect/addAfterEffect APIs.
|
|
1627
|
-
* @internal
|
|
1628
|
-
* @deprecated Use useFrame with phases instead
|
|
1629
|
-
*/
|
|
1630
|
-
interface GlobalJob {
|
|
1631
|
-
/** Unique identifier for this global job */
|
|
1632
|
-
id: string
|
|
1633
|
-
/** Callback invoked with RAF timestamp in ms */
|
|
1634
|
-
callback: (timestamp: number) => void
|
|
1635
|
-
}
|
|
1636
|
-
|
|
1637
|
-
// HMR Support --------------------------------
|
|
1638
|
-
|
|
1639
|
-
/**
|
|
1640
|
-
* Hot Module Replacement data structure for preserving scheduler state
|
|
1641
|
-
* @internal
|
|
1642
|
-
*/
|
|
1643
|
-
interface HMRData {
|
|
1644
|
-
/** Shared data object for storing values across reloads */
|
|
1645
|
-
data: Record<string, any>
|
|
1646
|
-
/** Optional function to accept HMR updates */
|
|
1647
|
-
accept?: () => void
|
|
1648
|
-
}
|
|
1649
|
-
|
|
1650
|
-
// Default Phases --------------------------------
|
|
1651
|
-
|
|
1652
|
-
/**
|
|
1653
|
-
* Default phase names for the scheduler
|
|
1654
|
-
*/
|
|
1655
|
-
type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
|
|
1656
|
-
}
|
|
1657
|
-
|
|
1658
1353
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
1659
1354
|
|
|
1660
1355
|
interface MathRepresentation {
|
|
@@ -1824,7 +1519,7 @@ declare namespace three_d {
|
|
|
1824
1519
|
* a single WebGPURenderer using Three.js CanvasTarget API.
|
|
1825
1520
|
*
|
|
1826
1521
|
* Primary canvas: Has `id` prop, creates its own renderer, registers here
|
|
1827
|
-
* Secondary canvas: Has `
|
|
1522
|
+
* Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
|
|
1828
1523
|
*/
|
|
1829
1524
|
|
|
1830
1525
|
interface PrimaryCanvasEntry {
|
|
@@ -1892,12 +1587,23 @@ type EnvironmentLoaderProps = {
|
|
|
1892
1587
|
* const texture = useEnvironment({ preset: 'sunset' })
|
|
1893
1588
|
* ```
|
|
1894
1589
|
*/
|
|
1895
|
-
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture
|
|
1590
|
+
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
|
|
1896
1591
|
declare namespace useEnvironment {
|
|
1897
1592
|
var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
|
|
1898
1593
|
var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
|
|
1899
1594
|
}
|
|
1900
|
-
|
|
1595
|
+
/**
|
|
1596
|
+
* Options accepted by `useEnvironment.preload`.
|
|
1597
|
+
*
|
|
1598
|
+
* `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
|
|
1599
|
+
* applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
|
|
1600
|
+
* advertise an option this function silently ignores.
|
|
1601
|
+
*
|
|
1602
|
+
* This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
|
|
1603
|
+
* `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
|
|
1604
|
+
* type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
|
|
1605
|
+
*/
|
|
1606
|
+
type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
|
|
1901
1607
|
type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
|
|
1902
1608
|
|
|
1903
1609
|
/**
|
|
@@ -1941,9 +1647,9 @@ type EnvironmentProps = {
|
|
|
1941
1647
|
blur?: number;
|
|
1942
1648
|
backgroundBlurriness?: number;
|
|
1943
1649
|
backgroundIntensity?: number;
|
|
1944
|
-
backgroundRotation?: Euler
|
|
1650
|
+
backgroundRotation?: Euler;
|
|
1945
1651
|
environmentIntensity?: number;
|
|
1946
|
-
environmentRotation?: Euler
|
|
1652
|
+
environmentRotation?: Euler;
|
|
1947
1653
|
map?: Texture$1;
|
|
1948
1654
|
preset?: PresetsType;
|
|
1949
1655
|
scene?: Scene | React$1.RefObject<Scene>;
|
|
@@ -2027,7 +1733,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
|
|
|
2027
1733
|
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;
|
|
2028
1734
|
declare module '@react-three/fiber' {
|
|
2029
1735
|
interface ThreeElements {
|
|
2030
|
-
groundProjectedEnvImpl: ThreeElement
|
|
1736
|
+
groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
|
|
2031
1737
|
}
|
|
2032
1738
|
}
|
|
2033
1739
|
/**
|
|
@@ -2127,6 +1833,24 @@ declare module '@react-three/fiber' {
|
|
|
2127
1833
|
*/
|
|
2128
1834
|
declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
2129
1835
|
|
|
1836
|
+
/**
|
|
1837
|
+
* Moves every trace of interactivity from one object to its replacement, for reconstruction.
|
|
1838
|
+
*
|
|
1839
|
+
* When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
|
|
1840
|
+
* instance. Removing the old object from the interaction state and registering the new one from
|
|
1841
|
+
* scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
|
|
1842
|
+
* the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
|
|
1843
|
+
* is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
|
|
1844
|
+
* swap the user never asked to see (#3744).
|
|
1845
|
+
*
|
|
1846
|
+
* Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
|
|
1847
|
+
* left alone — releasing and re-acquiring it is precisely the glitch being avoided.
|
|
1848
|
+
*
|
|
1849
|
+
* Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
|
|
1850
|
+
* the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
|
|
1851
|
+
* cannot outlive the object it described.
|
|
1852
|
+
*/
|
|
1853
|
+
declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
|
|
2130
1854
|
declare function removeInteractivity(store: RootStore, object: Object3D): void;
|
|
2131
1855
|
declare function createEvents(store: RootStore): {
|
|
2132
1856
|
handlePointer: (name: string) => (event: DomEvent) => void;
|
|
@@ -2147,383 +1871,21 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
|
|
|
2147
1871
|
* Note: this hook's caller must be wrapped with `React.Suspense`
|
|
2148
1872
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
|
|
2149
1873
|
*/
|
|
2150
|
-
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>;
|
|
1874
|
+
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>;
|
|
2151
1875
|
declare namespace useLoader {
|
|
2152
|
-
var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
|
|
2153
|
-
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
|
|
1876
|
+
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;
|
|
1877
|
+
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
|
|
2154
1878
|
var loader: typeof getLoader;
|
|
2155
1879
|
}
|
|
2156
1880
|
|
|
2157
|
-
/**
|
|
2158
|
-
* Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
|
|
2159
|
-
*
|
|
2160
|
-
* Features:
|
|
2161
|
-
* - Single RAF loop for entire application
|
|
2162
|
-
* - Root registration (multiple Canvas support)
|
|
2163
|
-
* - Global phases for addEffect/addAfterEffect (deprecated)
|
|
2164
|
-
* - Per-root job management with phases, priorities, FPS throttling
|
|
2165
|
-
* - onIdle callbacks for addTail (deprecated)
|
|
2166
|
-
* - Demand mode support via invalidate()
|
|
2167
|
-
*/
|
|
2168
|
-
declare class Scheduler {
|
|
2169
|
-
private static readonly INSTANCE_KEY;
|
|
2170
|
-
private static get instance();
|
|
2171
|
-
private static set instance(value);
|
|
2172
|
-
/**
|
|
2173
|
-
* Get the global scheduler instance (creates if doesn't exist).
|
|
2174
|
-
* Uses HMR data to preserve instance across hot reloads.
|
|
2175
|
-
* @returns {Scheduler} The singleton scheduler instance
|
|
2176
|
-
*/
|
|
2177
|
-
static get(): Scheduler;
|
|
2178
|
-
/**
|
|
2179
|
-
* Reset the singleton instance. Stops the loop and clears all state.
|
|
2180
|
-
* Primarily used for testing to ensure clean state between tests.
|
|
2181
|
-
* @returns {void}
|
|
2182
|
-
*/
|
|
2183
|
-
static reset(): void;
|
|
2184
|
-
private roots;
|
|
2185
|
-
private phaseGraph;
|
|
2186
|
-
private loopState;
|
|
2187
|
-
private stoppedTime;
|
|
2188
|
-
private nextRootIndex;
|
|
2189
|
-
private globalBeforeJobs;
|
|
2190
|
-
private globalAfterJobs;
|
|
2191
|
-
private nextGlobalIndex;
|
|
2192
|
-
private idleCallbacks;
|
|
2193
|
-
private nextJobIndex;
|
|
2194
|
-
private jobStateListeners;
|
|
2195
|
-
private pendingFrames;
|
|
2196
|
-
private _frameloop;
|
|
2197
|
-
private _independent;
|
|
2198
|
-
private errorHandler;
|
|
2199
|
-
private rootReadyCallbacks;
|
|
2200
|
-
get phases(): string[];
|
|
2201
|
-
get frameloop(): Frameloop;
|
|
2202
|
-
set frameloop(mode: Frameloop);
|
|
2203
|
-
get isRunning(): boolean;
|
|
2204
|
-
get isReady(): boolean;
|
|
2205
|
-
get independent(): boolean;
|
|
2206
|
-
set independent(value: boolean);
|
|
2207
|
-
constructor();
|
|
2208
|
-
/**
|
|
2209
|
-
* Register a root (Canvas) with the scheduler.
|
|
2210
|
-
* The first root to register starts the RAF loop (if frameloop='always').
|
|
2211
|
-
* @param {string} id - Unique identifier for this root
|
|
2212
|
-
* @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
|
|
2213
|
-
* @returns {() => void} Unsubscribe function to remove this root
|
|
2214
|
-
*/
|
|
2215
|
-
registerRoot(id: string, options?: RootOptions): () => void;
|
|
2216
|
-
/**
|
|
2217
|
-
* Unregister a root from the scheduler.
|
|
2218
|
-
* Cleans up all job state listeners for this root's jobs.
|
|
2219
|
-
* The last root to unregister stops the RAF loop.
|
|
2220
|
-
* @param {string} id - The root ID to unregister
|
|
2221
|
-
* @returns {void}
|
|
2222
|
-
*/
|
|
2223
|
-
unregisterRoot(id: string): void;
|
|
2224
|
-
/**
|
|
2225
|
-
* Subscribe to be notified when a root becomes available.
|
|
2226
|
-
* Fires immediately if a root already exists.
|
|
2227
|
-
* @param {() => void} callback - Function called when first root registers
|
|
2228
|
-
* @returns {() => void} Unsubscribe function
|
|
2229
|
-
*/
|
|
2230
|
-
onRootReady(callback: () => void): () => void;
|
|
2231
|
-
/**
|
|
2232
|
-
* Notify all registered root-ready callbacks.
|
|
2233
|
-
* Called when the first root registers.
|
|
2234
|
-
* @returns {void}
|
|
2235
|
-
* @private
|
|
2236
|
-
*/
|
|
2237
|
-
private notifyRootReady;
|
|
2238
|
-
/**
|
|
2239
|
-
* Ensure a default root exists for independent mode.
|
|
2240
|
-
* Creates a minimal root with no state provider.
|
|
2241
|
-
* @returns {void}
|
|
2242
|
-
* @private
|
|
2243
|
-
*/
|
|
2244
|
-
private ensureDefaultRoot;
|
|
2245
|
-
/**
|
|
2246
|
-
* Trigger error handling for job errors.
|
|
2247
|
-
* Uses the bound error handler if available, otherwise logs to console.
|
|
2248
|
-
* @param {Error} error - The error to handle
|
|
2249
|
-
* @returns {void}
|
|
2250
|
-
*/
|
|
2251
|
-
triggerError(error: Error): void;
|
|
2252
|
-
/**
|
|
2253
|
-
* Add a named phase to the scheduler's execution order.
|
|
2254
|
-
* Marks all roots for rebuild to incorporate the new phase.
|
|
2255
|
-
* @param {string} name - The phase name (e.g., 'physics', 'postprocess')
|
|
2256
|
-
* @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
|
|
2257
|
-
* @returns {void}
|
|
2258
|
-
* @example
|
|
2259
|
-
* scheduler.addPhase('physics', { before: 'update' });
|
|
2260
|
-
* scheduler.addPhase('postprocess', { after: 'render' });
|
|
2261
|
-
*/
|
|
2262
|
-
addPhase(name: string, options?: AddPhaseOptions): void;
|
|
2263
|
-
/**
|
|
2264
|
-
* Check if a phase exists in the scheduler.
|
|
2265
|
-
* @param {string} name - The phase name to check
|
|
2266
|
-
* @returns {boolean} True if the phase exists
|
|
2267
|
-
*/
|
|
2268
|
-
hasPhase(name: string): boolean;
|
|
2269
|
-
/**
|
|
2270
|
-
* Register a global job that runs once per frame (not per-root).
|
|
2271
|
-
* Used internally by deprecated addEffect/addAfterEffect APIs.
|
|
2272
|
-
* @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
|
|
2273
|
-
* @param {string} id - Unique identifier for this global job
|
|
2274
|
-
* @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
|
|
2275
|
-
* @returns {() => void} Unsubscribe function to remove this global job
|
|
2276
|
-
* @deprecated Use useFrame with phases instead
|
|
2277
|
-
*/
|
|
2278
|
-
registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
|
|
2279
|
-
/**
|
|
2280
|
-
* Register an idle callback that fires when the loop stops.
|
|
2281
|
-
* Used internally by deprecated addTail API.
|
|
2282
|
-
* @param {(timestamp: number) => void} callback - Function called when loop becomes idle
|
|
2283
|
-
* @returns {() => void} Unsubscribe function to remove this idle callback
|
|
2284
|
-
* @deprecated Use demand mode with invalidate() instead
|
|
2285
|
-
*/
|
|
2286
|
-
onIdle(callback: (timestamp: number) => void): () => void;
|
|
2287
|
-
/**
|
|
2288
|
-
* Notify all registered idle callbacks.
|
|
2289
|
-
* Called when the loop stops in demand mode.
|
|
2290
|
-
* @param {number} timestamp - The RAF timestamp when idle occurred
|
|
2291
|
-
* @returns {void}
|
|
2292
|
-
* @private
|
|
2293
|
-
*/
|
|
2294
|
-
private notifyIdle;
|
|
2295
|
-
/**
|
|
2296
|
-
* Register a job (frame callback) with a specific root.
|
|
2297
|
-
* This is the core registration method used by useFrame internally.
|
|
2298
|
-
* @param {FrameNextCallback} callback - The function to call each frame
|
|
2299
|
-
* @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
|
|
2300
|
-
* @param {string} [options.rootId] - Target root ID (defaults to first registered root)
|
|
2301
|
-
* @param {string} [options.id] - Unique job ID (auto-generated if not provided)
|
|
2302
|
-
* @param {string} [options.phase] - Execution phase (defaults to 'update')
|
|
2303
|
-
* @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
|
|
2304
|
-
* @param {number} [options.fps] - FPS throttle limit
|
|
2305
|
-
* @param {boolean} [options.drop] - Drop frames when behind (default true)
|
|
2306
|
-
* @param {boolean} [options.enabled] - Whether job is active (default true)
|
|
2307
|
-
* @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
|
|
2308
|
-
* @returns {() => void} Unsubscribe function to remove this job
|
|
2309
|
-
*/
|
|
2310
|
-
register(callback: FrameNextCallback, options?: JobOptions & {
|
|
2311
|
-
rootId?: string;
|
|
2312
|
-
system?: boolean;
|
|
2313
|
-
}): () => void;
|
|
2314
|
-
/**
|
|
2315
|
-
* Unregister a job by its ID.
|
|
2316
|
-
* Searches all roots if rootId is not provided.
|
|
2317
|
-
* @param {string} id - The job ID to unregister
|
|
2318
|
-
* @param {string} [rootId] - Optional root ID to search (searches all if not provided)
|
|
2319
|
-
* @returns {void}
|
|
2320
|
-
*/
|
|
2321
|
-
unregister(id: string, rootId?: string): void;
|
|
2322
|
-
/**
|
|
2323
|
-
* Update a job's options dynamically.
|
|
2324
|
-
* Searches all roots to find the job by ID.
|
|
2325
|
-
* Phase/constraint changes trigger a rebuild of the sorted job list.
|
|
2326
|
-
* @param {string} id - The job ID to update
|
|
2327
|
-
* @param {Partial<JobOptions>} options - The options to update
|
|
2328
|
-
* @returns {void}
|
|
2329
|
-
*/
|
|
2330
|
-
updateJob(id: string, options: Partial<JobOptions>): void;
|
|
2331
|
-
/**
|
|
2332
|
-
* Check if a job is currently paused (disabled).
|
|
2333
|
-
* @param {string} id - The job ID to check
|
|
2334
|
-
* @returns {boolean} True if the job exists and is paused
|
|
2335
|
-
*/
|
|
2336
|
-
isJobPaused(id: string): boolean;
|
|
2337
|
-
/**
|
|
2338
|
-
* Subscribe to state changes for a specific job.
|
|
2339
|
-
* Listener is called when job is paused or resumed.
|
|
2340
|
-
* @param {string} id - The job ID to subscribe to
|
|
2341
|
-
* @param {() => void} listener - Callback invoked on state changes
|
|
2342
|
-
* @returns {() => void} Unsubscribe function
|
|
2343
|
-
*/
|
|
2344
|
-
subscribeJobState(id: string, listener: () => void): () => void;
|
|
2345
|
-
/**
|
|
2346
|
-
* Notify all listeners that a job's state has changed.
|
|
2347
|
-
* @param {string} id - The job ID that changed
|
|
2348
|
-
* @returns {void}
|
|
2349
|
-
* @private
|
|
2350
|
-
*/
|
|
2351
|
-
private notifyJobStateChange;
|
|
2352
|
-
/**
|
|
2353
|
-
* Pause a job by ID (sets enabled=false).
|
|
2354
|
-
* Notifies any subscribed state listeners.
|
|
2355
|
-
* @param {string} id - The job ID to pause
|
|
2356
|
-
* @returns {void}
|
|
2357
|
-
*/
|
|
2358
|
-
pauseJob(id: string): void;
|
|
2359
|
-
/**
|
|
2360
|
-
* Resume a paused job by ID (sets enabled=true).
|
|
2361
|
-
* Resets job timing to prevent frame accumulation.
|
|
2362
|
-
* Notifies any subscribed state listeners.
|
|
2363
|
-
* @param {string} id - The job ID to resume
|
|
2364
|
-
* @returns {void}
|
|
2365
|
-
*/
|
|
2366
|
-
resumeJob(id: string): void;
|
|
2367
|
-
/**
|
|
2368
|
-
* Start the requestAnimationFrame loop.
|
|
2369
|
-
* Resets timing state (elapsedTime, frameCount) on start.
|
|
2370
|
-
* No-op if already running.
|
|
2371
|
-
* @returns {void}
|
|
2372
|
-
*/
|
|
2373
|
-
start(): void;
|
|
2374
|
-
/**
|
|
2375
|
-
* Stop the requestAnimationFrame loop.
|
|
2376
|
-
* Cancels any pending RAF callback.
|
|
2377
|
-
* No-op if not running.
|
|
2378
|
-
* @returns {void}
|
|
2379
|
-
*/
|
|
2380
|
-
stop(): void;
|
|
2381
|
-
/**
|
|
2382
|
-
* Request frames to be rendered in demand mode.
|
|
2383
|
-
* Accumulates pending frames (capped at 60) and starts the loop if not running.
|
|
2384
|
-
* No-op if frameloop is not 'demand'.
|
|
2385
|
-
* @param {number} [frames=1] - Number of frames to request
|
|
2386
|
-
* @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
|
|
2387
|
-
* - `false` (default): Sets pending frames to the specified value (replaces existing count)
|
|
2388
|
-
* - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
|
|
2389
|
-
* @returns {void}
|
|
2390
|
-
* @example
|
|
2391
|
-
* // Request a single frame render
|
|
2392
|
-
* scheduler.invalidate();
|
|
2393
|
-
*
|
|
2394
|
-
* @example
|
|
2395
|
-
* // Request 5 frames (e.g., for animations)
|
|
2396
|
-
* scheduler.invalidate(5);
|
|
2397
|
-
*
|
|
2398
|
-
* @example
|
|
2399
|
-
* // Set pending frames to exactly 3 (don't stack with existing)
|
|
2400
|
-
* scheduler.invalidate(3, false);
|
|
2401
|
-
*
|
|
2402
|
-
* @example
|
|
2403
|
-
* // Add 2 more frames to existing pending count
|
|
2404
|
-
* scheduler.invalidate(2, true);
|
|
2405
|
-
*/
|
|
2406
|
-
invalidate(frames?: number, stackFrames?: boolean): void;
|
|
2407
|
-
/**
|
|
2408
|
-
* Reset timing state for deterministic testing.
|
|
2409
|
-
* Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
|
|
2410
|
-
* @returns {void}
|
|
2411
|
-
*/
|
|
2412
|
-
resetTiming(): void;
|
|
2413
|
-
/**
|
|
2414
|
-
* Manually execute a single frame for all roots.
|
|
2415
|
-
* Useful for frameloop='never' mode or testing scenarios.
|
|
2416
|
-
* @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
|
|
2417
|
-
* @returns {void}
|
|
2418
|
-
* @example
|
|
2419
|
-
* // Manual control mode
|
|
2420
|
-
* scheduler.frameloop = 'never';
|
|
2421
|
-
* scheduler.step(); // Execute one frame
|
|
2422
|
-
*/
|
|
2423
|
-
step(timestamp?: number): void;
|
|
2424
|
-
/**
|
|
2425
|
-
* Manually execute a single job by its ID.
|
|
2426
|
-
* Useful for testing individual job callbacks in isolation.
|
|
2427
|
-
* @param {string} id - The job ID to step
|
|
2428
|
-
* @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
|
|
2429
|
-
* @returns {void}
|
|
2430
|
-
*/
|
|
2431
|
-
stepJob(id: string, timestamp?: number): void;
|
|
2432
|
-
/**
|
|
2433
|
-
* Main RAF loop callback.
|
|
2434
|
-
* Executes frame, handles demand mode, and schedules next frame.
|
|
2435
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2436
|
-
* @returns {void}
|
|
2437
|
-
* @private
|
|
2438
|
-
*/
|
|
2439
|
-
private loop;
|
|
2440
|
-
/**
|
|
2441
|
-
* Execute a single frame across all roots.
|
|
2442
|
-
* Order: globalBefore → each root's jobs → globalAfter
|
|
2443
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2444
|
-
* @returns {void}
|
|
2445
|
-
* @private
|
|
2446
|
-
*/
|
|
2447
|
-
private executeFrame;
|
|
2448
|
-
/**
|
|
2449
|
-
* Run all global jobs from a job map.
|
|
2450
|
-
* Catches and logs errors without stopping execution.
|
|
2451
|
-
* @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
|
|
2452
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2453
|
-
* @returns {void}
|
|
2454
|
-
* @private
|
|
2455
|
-
*/
|
|
2456
|
-
private runGlobalJobs;
|
|
2457
|
-
/**
|
|
2458
|
-
* Execute all jobs for a single root in sorted order.
|
|
2459
|
-
* Rebuilds sorted job list if needed, then dispatches each job.
|
|
2460
|
-
* Errors are caught and propagated via triggerError.
|
|
2461
|
-
* @param {RootEntry} root - The root entry to tick
|
|
2462
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2463
|
-
* @param {number} delta - Time since last frame in seconds
|
|
2464
|
-
* @returns {void}
|
|
2465
|
-
* @private
|
|
2466
|
-
*/
|
|
2467
|
-
private tickRoot;
|
|
2468
|
-
/**
|
|
2469
|
-
* Get the total number of registered jobs across all roots.
|
|
2470
|
-
* Includes both per-root jobs and global before/after jobs.
|
|
2471
|
-
* @returns {number} Total job count
|
|
2472
|
-
*/
|
|
2473
|
-
getJobCount(): number;
|
|
2474
|
-
/**
|
|
2475
|
-
* Get all registered job IDs across all roots.
|
|
2476
|
-
* Includes both per-root jobs and global before/after jobs.
|
|
2477
|
-
* @returns {string[]} Array of all job IDs
|
|
2478
|
-
*/
|
|
2479
|
-
getJobIds(): string[];
|
|
2480
|
-
/**
|
|
2481
|
-
* Get the number of registered roots (Canvas instances).
|
|
2482
|
-
* @returns {number} Number of registered roots
|
|
2483
|
-
*/
|
|
2484
|
-
getRootCount(): number;
|
|
2485
|
-
/**
|
|
2486
|
-
* Check if any user (non-system) jobs are registered in a specific phase.
|
|
2487
|
-
* Used by the default render job to know if a user has taken over rendering.
|
|
2488
|
-
*
|
|
2489
|
-
* @param phase The phase to check
|
|
2490
|
-
* @param rootId Optional root ID to check (checks all roots if not provided)
|
|
2491
|
-
* @returns true if any user jobs exist in the phase
|
|
2492
|
-
*/
|
|
2493
|
-
hasUserJobsInPhase(phase: string, rootId?: string): boolean;
|
|
2494
|
-
/**
|
|
2495
|
-
* Generate a unique root ID for automatic root registration.
|
|
2496
|
-
* @returns {string} A unique root ID in the format 'root_N'
|
|
2497
|
-
*/
|
|
2498
|
-
generateRootId(): string;
|
|
2499
|
-
/**
|
|
2500
|
-
* Generate a unique job ID.
|
|
2501
|
-
* @returns {string} A unique job ID in the format 'job_N'
|
|
2502
|
-
* @private
|
|
2503
|
-
*/
|
|
2504
|
-
private generateJobId;
|
|
2505
|
-
/**
|
|
2506
|
-
* Normalize before/after constraints to a Set.
|
|
2507
|
-
* Handles undefined, single string, or array inputs.
|
|
2508
|
-
* @param {string | string[] | undefined} value - The constraint value(s)
|
|
2509
|
-
* @returns {Set<string>} Normalized Set of constraint strings
|
|
2510
|
-
* @private
|
|
2511
|
-
*/
|
|
2512
|
-
private normalizeConstraints;
|
|
2513
|
-
}
|
|
2514
|
-
/**
|
|
2515
|
-
* Get the global scheduler instance.
|
|
2516
|
-
* Creates one if it doesn't exist.
|
|
2517
|
-
*/
|
|
2518
|
-
declare const getScheduler: () => Scheduler;
|
|
2519
|
-
|
|
2520
1881
|
/**
|
|
2521
1882
|
* Frame hook with phase-based ordering, priority, and FPS throttling.
|
|
2522
1883
|
*
|
|
2523
|
-
*
|
|
2524
|
-
* - Inside Canvas: Full RootState (
|
|
2525
|
-
* - Outside Canvas
|
|
2526
|
-
*
|
|
1884
|
+
* Always delivers full RootState — works both inside and outside Canvas context:
|
|
1885
|
+
* - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
|
|
1886
|
+
* - Outside Canvas: The job registers immediately but the callback is held until a
|
|
1887
|
+
* Canvas adopts it, then runs with full RootState. For hostless / standalone
|
|
1888
|
+
* frame loops with no Canvas, use `@pmndrs/scheduler` directly.
|
|
2527
1889
|
*
|
|
2528
1890
|
* Returns a controls object for manual stepping, pausing, and resuming.
|
|
2529
1891
|
*
|
|
@@ -2540,16 +1902,16 @@ declare const getScheduler: () => Scheduler;
|
|
|
2540
1902
|
* useFrame((state, delta) => { ... }, { phase: 'physics' })
|
|
2541
1903
|
*
|
|
2542
1904
|
* @example
|
|
2543
|
-
* // Outside Canvas - waits for Canvas
|
|
1905
|
+
* // Outside Canvas - callback waits for a Canvas, then always has full state
|
|
2544
1906
|
* function UI() {
|
|
2545
1907
|
* useFrame((state, delta) => { syncUI(state.camera) });
|
|
2546
1908
|
* return <button>...</button>;
|
|
2547
1909
|
* }
|
|
2548
1910
|
*
|
|
2549
1911
|
* @example
|
|
2550
|
-
* //
|
|
2551
|
-
* getScheduler
|
|
2552
|
-
*
|
|
1912
|
+
* // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
|
|
1913
|
+
* import { getScheduler } from '@pmndrs/scheduler'
|
|
1914
|
+
* getScheduler().register((state, delta) => { updateGame(delta) })
|
|
2553
1915
|
*
|
|
2554
1916
|
* @example
|
|
2555
1917
|
* // Scheduler-only access (no callback)
|
|
@@ -2572,11 +1934,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2572
1934
|
/** Callback when texture(s) finish loading */
|
|
2573
1935
|
onLoad?: (texture: MappedTextureType<Url>) => void;
|
|
2574
1936
|
/**
|
|
2575
|
-
*
|
|
2576
|
-
* When true:
|
|
1937
|
+
* Register the texture(s) in R3F's global texture registry for access via useTextures().
|
|
1938
|
+
* When true (the default):
|
|
2577
1939
|
* - Textures persist until explicitly disposed
|
|
2578
|
-
* -
|
|
2579
|
-
*
|
|
1940
|
+
* - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
|
|
1941
|
+
*
|
|
1942
|
+
* Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
|
|
1943
|
+
* changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
|
|
1944
|
+
*
|
|
1945
|
+
* Pass `false` to opt out of registry enrollment entirely.
|
|
1946
|
+
* @default true
|
|
2580
1947
|
*/
|
|
2581
1948
|
cache?: boolean;
|
|
2582
1949
|
};
|
|
@@ -2600,15 +1967,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2600
1967
|
* normal: '/normal.png'
|
|
2601
1968
|
* })
|
|
2602
1969
|
*
|
|
2603
|
-
* //
|
|
2604
|
-
* //
|
|
2605
|
-
* const diffuse = useTexture('/diffuse.png'
|
|
1970
|
+
* // Textures are registered in the global registry by default — the same texture
|
|
1971
|
+
* // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
|
|
1972
|
+
* const diffuse = useTexture('/diffuse.png')
|
|
2606
1973
|
* diffuse.colorSpace = THREE.SRGBColorSpace
|
|
2607
1974
|
*
|
|
2608
1975
|
* // Another component gets the SAME texture with colorSpace already set
|
|
2609
|
-
* const sameDiffuse = useTexture('/diffuse.png'
|
|
1976
|
+
* const sameDiffuse = useTexture('/diffuse.png')
|
|
2610
1977
|
*
|
|
2611
|
-
* //
|
|
1978
|
+
* // Opt out of registry enrollment for a one-off texture
|
|
1979
|
+
* const scratch = useTexture('/scratch.png', { cache: false })
|
|
1980
|
+
*
|
|
1981
|
+
* // Access the registry directly
|
|
2612
1982
|
* const { get } = useTextures()
|
|
2613
1983
|
* const cached = get('/diffuse.png')
|
|
2614
1984
|
* ```
|
|
@@ -2625,63 +1995,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
|
|
|
2625
1995
|
cache?: boolean;
|
|
2626
1996
|
}) => react_jsx_runtime.JSX.Element;
|
|
2627
1997
|
|
|
2628
|
-
|
|
2629
|
-
|
|
2630
|
-
|
|
1998
|
+
/** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
|
|
1999
|
+
type TextureInput = string | string[] | Record<string, string>;
|
|
2000
|
+
/** Result of a `get()` read, mirroring the input shape. */
|
|
2001
|
+
type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
|
|
2002
|
+
[K in keyof Input]: Texture$1 | undefined;
|
|
2631
2003
|
};
|
|
2004
|
+
/** Options for `dispose()`. */
|
|
2005
|
+
interface DisposeOptions {
|
|
2006
|
+
/** Dispose even if the texture still has active references (default false). */
|
|
2007
|
+
force?: boolean;
|
|
2008
|
+
}
|
|
2632
2009
|
interface UseTexturesReturn {
|
|
2633
|
-
/** Map
|
|
2634
|
-
|
|
2635
|
-
/**
|
|
2636
|
-
get
|
|
2637
|
-
/** Check
|
|
2638
|
-
has
|
|
2639
|
-
/**
|
|
2640
|
-
|
|
2641
|
-
|
|
2642
|
-
|
|
2643
|
-
|
|
2644
|
-
|
|
2645
|
-
|
|
2646
|
-
|
|
2647
|
-
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
|
|
2652
|
-
|
|
2010
|
+
/** The live registry Map (key → Texture). Treat as read-only. */
|
|
2011
|
+
readonly all: Map<string, Texture$1>;
|
|
2012
|
+
/** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
|
|
2013
|
+
get<Input extends TextureInput>(input: Input): TextureResult<Input>;
|
|
2014
|
+
/** Check whether a key exists in the registry. */
|
|
2015
|
+
has(key: string): boolean;
|
|
2016
|
+
/**
|
|
2017
|
+
* Register a texture (or a record of textures) that has no URL — e.g. a render
|
|
2018
|
+
* target or procedural texture. URL-loaded textures are registered automatically
|
|
2019
|
+
* by `useTexture` (registry enrollment is on by default).
|
|
2020
|
+
*/
|
|
2021
|
+
add(key: string, texture: Texture$1): void;
|
|
2022
|
+
add(record: Record<string, Texture$1>): void;
|
|
2023
|
+
/**
|
|
2024
|
+
* Dispose a texture's GPU resources and remove it from the registry.
|
|
2025
|
+
* Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
|
|
2026
|
+
* skipped (with a warning) unless `{ force: true }` is passed.
|
|
2027
|
+
* @returns true if disposed, false if skipped.
|
|
2028
|
+
*/
|
|
2029
|
+
dispose(key: string, options?: DisposeOptions): boolean;
|
|
2030
|
+
/** Dispose every texture in the registry and clear it. Use on scene teardown. */
|
|
2031
|
+
disposeAll(): void;
|
|
2653
2032
|
}
|
|
2654
2033
|
/**
|
|
2655
|
-
*
|
|
2034
|
+
* Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
|
|
2035
|
+
*
|
|
2036
|
+
* This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
|
|
2037
|
+
* a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
|
|
2038
|
+
* `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
|
|
2656
2039
|
*
|
|
2657
|
-
*
|
|
2658
|
-
*
|
|
2040
|
+
* The returned handle is **reactive**: the calling component re-renders when the registry
|
|
2041
|
+
* changes. Pass a selector to scope the subscription to a single read.
|
|
2659
2042
|
*
|
|
2660
2043
|
* @example
|
|
2661
2044
|
* ```tsx
|
|
2662
|
-
*
|
|
2045
|
+
* // Load + register once (anywhere in the tree) — registered by default
|
|
2046
|
+
* useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
2663
2047
|
*
|
|
2664
|
-
* //
|
|
2665
|
-
*
|
|
2666
|
-
*
|
|
2667
|
-
* const tex = useTexture('/textures/diffuse.png', { cache: true })
|
|
2668
|
-
* }
|
|
2669
|
-
*
|
|
2670
|
-
* // Access cached texture from anywhere
|
|
2671
|
-
* const diffuse = get('/textures/diffuse.png')
|
|
2672
|
-
* if (diffuse) material.map = diffuse
|
|
2048
|
+
* // Reach them from another component — record form lands straight into a material
|
|
2049
|
+
* const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
2050
|
+
* return <meshStandardMaterial map={map} normalMap={normalMap} />
|
|
2673
2051
|
*
|
|
2674
|
-
* //
|
|
2675
|
-
*
|
|
2052
|
+
* // A set of heightmaps at once
|
|
2053
|
+
* const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
|
|
2676
2054
|
*
|
|
2677
|
-
* //
|
|
2678
|
-
*
|
|
2055
|
+
* // Register a non-URL texture (render target / procedural)
|
|
2056
|
+
* useTextures().add('rt-main', renderTarget.texture)
|
|
2679
2057
|
*
|
|
2680
|
-
* //
|
|
2681
|
-
*
|
|
2058
|
+
* // Deliberate GPU cleanup (refcount-aware; force to override)
|
|
2059
|
+
* useTextures().dispose('/diffuse.jpg')
|
|
2060
|
+
* useTextures().disposeAll() // scene teardown
|
|
2682
2061
|
* ```
|
|
2062
|
+
*
|
|
2063
|
+
* @remarks
|
|
2064
|
+
* **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
|
|
2065
|
+
* intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
|
|
2066
|
+
* populate the registry without Suspense, at the cost of putting loading back into this hook. It
|
|
2067
|
+
* will be added only if a concrete consumer needs imperative loading; for now, loading lives in
|
|
2068
|
+
* `useTexture`.
|
|
2683
2069
|
*/
|
|
2684
2070
|
declare function useTextures(): UseTexturesReturn;
|
|
2071
|
+
declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
|
|
2685
2072
|
|
|
2686
2073
|
/**
|
|
2687
2074
|
* Creates a render target compatible with the current renderer.
|
|
@@ -3889,11 +3276,6 @@ declare function flushSync<R>(fn: () => R): R;
|
|
|
3889
3276
|
declare const context: React$1.Context<RootStore>;
|
|
3890
3277
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3891
3278
|
|
|
3892
|
-
/**
|
|
3893
|
-
* Safely flush async effects when testing, simulating a legacy root.
|
|
3894
|
-
* @deprecated Import from React instead. import { act } from 'react'
|
|
3895
|
-
*/
|
|
3896
|
-
declare const act: typeof React$1.act;
|
|
3897
3279
|
/**
|
|
3898
3280
|
* An SSR-friendly useLayoutEffect.
|
|
3899
3281
|
*
|
|
@@ -4377,5 +3759,5 @@ declare function isOnce(value: unknown): value is {
|
|
|
4377
3759
|
*/
|
|
4378
3760
|
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
4379
3761
|
|
|
4380
|
-
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,
|
|
4381
|
-
export type { Act,
|
|
3762
|
+
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 };
|
|
3763
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, 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 };
|