@react-three/fiber 10.0.0-canary.dbbe704 → 10.0.0-canary.de17310
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/extension.cjs +278 -0
- package/dist/extension.d.cts +629 -0
- package/dist/extension.d.mts +629 -0
- package/dist/extension.d.ts +629 -0
- package/dist/extension.mjs +258 -0
- package/dist/index.cjs +2746 -3186
- package/dist/index.d.cts +383 -1039
- package/dist/index.d.mts +383 -1039
- package/dist/index.d.ts +377 -1061
- package/dist/index.mjs +2675 -3116
- package/dist/legacy.cjs +2713 -3160
- package/dist/legacy.d.cts +393 -1081
- package/dist/legacy.d.mts +393 -1081
- package/dist/legacy.d.ts +389 -1103
- package/dist/legacy.mjs +2667 -3115
- package/dist/webgpu/index.cjs +2708 -3830
- package/dist/webgpu/index.d.cts +403 -1327
- package/dist/webgpu/index.d.mts +403 -1327
- package/dist/webgpu/index.d.ts +398 -1350
- package/dist/webgpu/index.mjs +2257 -3366
- package/package.json +11 -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,14 @@
|
|
|
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
|
-
import
|
|
6
|
-
import { WebGPURenderer as WebGPURenderer$1, CanvasTarget, Node, ShaderNodeObject } from 'three/webgpu';
|
|
5
|
+
import { WebGPURenderer as WebGPURenderer$1, CanvasTarget } from 'three/webgpu';
|
|
7
6
|
import { StoreApi } from 'zustand';
|
|
8
7
|
import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
|
|
8
|
+
import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
|
|
9
|
+
export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
|
|
9
10
|
import { Options } from 'react-use-measure';
|
|
10
11
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
11
|
-
import { ThreeElement as ThreeElement$1, Euler as Euler$2 } from '@react-three/fiber';
|
|
12
12
|
import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
|
|
13
13
|
|
|
14
14
|
function _mergeNamespaces(n, m) {
|
|
@@ -37,23 +37,28 @@ function _mergeNamespaces(n, m) {
|
|
|
37
37
|
declare const R3F_BUILD_LEGACY = true;
|
|
38
38
|
declare const R3F_BUILD_WEBGPU = false;
|
|
39
39
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
declare
|
|
44
|
-
|
|
45
|
-
}
|
|
40
|
+
type Inspector = never;
|
|
41
|
+
/** Not available on the legacy (WebGL-only) entry. */
|
|
42
|
+
declare function loadInspector(): Promise<never>;
|
|
43
|
+
declare class WebGPURenderer {
|
|
44
|
+
constructor();
|
|
45
|
+
}
|
|
46
46
|
|
|
47
47
|
declare const RenderTarget: any;
|
|
48
48
|
|
|
49
|
+
declare const CubeRenderTarget: any;
|
|
50
|
+
|
|
49
51
|
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
50
52
|
__proto__: null,
|
|
53
|
+
CubeRenderTarget: CubeRenderTarget,
|
|
54
|
+
CubeRenderTargetCompat: WebGLCubeRenderTarget,
|
|
51
55
|
Inspector: Inspector,
|
|
52
56
|
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
53
57
|
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
54
58
|
RenderTarget: RenderTarget,
|
|
55
59
|
RenderTargetCompat: WebGLRenderTarget,
|
|
56
|
-
WebGPURenderer: WebGPURenderer
|
|
60
|
+
WebGPURenderer: WebGPURenderer,
|
|
61
|
+
loadInspector: loadInspector
|
|
57
62
|
}, [THREE$1]);
|
|
58
63
|
|
|
59
64
|
//* Utility Types ==============================
|
|
@@ -148,6 +153,8 @@ interface IntersectionEvent<TSourceEvent> extends Intersection {
|
|
|
148
153
|
unprojectedPoint: THREE$1.Vector3
|
|
149
154
|
/** Normalized event coordinates */
|
|
150
155
|
pointer: THREE$1.Vector2
|
|
156
|
+
/** pointerId of the original event for multiple pointer events */
|
|
157
|
+
pointerId: number
|
|
151
158
|
/** Delta between first click and this event */
|
|
152
159
|
delta: number
|
|
153
160
|
/** The ray that pierced it */
|
|
@@ -224,6 +231,18 @@ interface EventHandlers {
|
|
|
224
231
|
type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
|
|
225
232
|
type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
|
|
226
233
|
|
|
234
|
+
/** Configuration for XR pointer registration (controllers/hands) */
|
|
235
|
+
interface XRPointerConfig {
|
|
236
|
+
/** Ray origin (updated each frame by XR system) */
|
|
237
|
+
ray: THREE$1.Ray
|
|
238
|
+
/** Optional: custom compute function for this pointer */
|
|
239
|
+
compute?: (state: RootState) => void
|
|
240
|
+
/** Pointer type identifier */
|
|
241
|
+
type: 'controller' | 'hand' | 'gaze'
|
|
242
|
+
/** Which hand (for controller/hand types) */
|
|
243
|
+
handedness?: 'left' | 'right'
|
|
244
|
+
}
|
|
245
|
+
|
|
227
246
|
interface EventManager<TTarget> {
|
|
228
247
|
/** Determines if the event layer is active */
|
|
229
248
|
enabled: boolean
|
|
@@ -243,8 +262,21 @@ interface EventManager<TTarget> {
|
|
|
243
262
|
disconnect?: () => void
|
|
244
263
|
/** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
|
|
245
264
|
* explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
|
|
265
|
+
* @param pointerId - Optional pointer ID to update specific pointer only
|
|
246
266
|
*/
|
|
247
|
-
update?: () => void
|
|
267
|
+
update?: (pointerId?: number) => void
|
|
268
|
+
/** Defer pointer move raycasting to frame start (default: true) */
|
|
269
|
+
frameTimedRaycasts?: boolean
|
|
270
|
+
/** Always fire raycaster immediately on scroll events (default: true) */
|
|
271
|
+
alwaysFireOnScroll?: boolean
|
|
272
|
+
/** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
|
|
273
|
+
updateOnFrame?: boolean
|
|
274
|
+
/** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
|
|
275
|
+
flush?: () => void
|
|
276
|
+
/** Register an XR pointer (controller/hand). Returns assigned pointerId */
|
|
277
|
+
registerPointer?: (config: XRPointerConfig) => number
|
|
278
|
+
/** Unregister an XR pointer */
|
|
279
|
+
unregisterPointer?: (pointerId: number) => void
|
|
248
280
|
}
|
|
249
281
|
|
|
250
282
|
interface PointerCaptureTarget {
|
|
@@ -264,228 +296,33 @@ interface VisibilityEntry {
|
|
|
264
296
|
}
|
|
265
297
|
|
|
266
298
|
//* Scheduler Types (useFrame) ==============================
|
|
299
|
+
//
|
|
300
|
+
// The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
|
|
301
|
+
// This file re-exports them and layers r3f's RootState-aware frame state on top,
|
|
302
|
+
// so existing `#types` imports across the codebase keep resolving unchanged.
|
|
267
303
|
|
|
268
304
|
|
|
269
305
|
|
|
270
|
-
//
|
|
306
|
+
// Frame State (r3f-specific) --------------------------------
|
|
271
307
|
|
|
272
308
|
/**
|
|
273
|
-
*
|
|
274
|
-
*/
|
|
275
|
-
interface UseFrameNextOptions {
|
|
276
|
-
/** Optional stable id for the job. Auto-generated if not provided */
|
|
277
|
-
id?: string
|
|
278
|
-
/** Named phase to run in. Default: 'update' */
|
|
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
|
-
}
|
|
293
|
-
|
|
294
|
-
/** Alias for UseFrameNextOptions */
|
|
295
|
-
type UseFrameOptions = UseFrameNextOptions
|
|
296
|
-
|
|
297
|
-
/**
|
|
298
|
-
* Options for addPhase
|
|
299
|
-
*/
|
|
300
|
-
interface AddPhaseOptions {
|
|
301
|
-
/** Insert this phase before the specified phase */
|
|
302
|
-
before?: string
|
|
303
|
-
/** Insert this phase after the specified phase */
|
|
304
|
-
after?: string
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
// Frame State --------------------------------
|
|
308
|
-
|
|
309
|
-
/**
|
|
310
|
-
* Timing-only state for independent/outside mode (no RootState)
|
|
311
|
-
*/
|
|
312
|
-
interface FrameTimingState {
|
|
313
|
-
/** High-resolution timestamp from RAF (ms) */
|
|
314
|
-
time: number
|
|
315
|
-
/** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
|
|
316
|
-
delta: number
|
|
317
|
-
/** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
|
|
318
|
-
elapsed: number
|
|
319
|
-
/** Incrementing frame counter */
|
|
320
|
-
frame: number
|
|
321
|
-
}
|
|
322
|
-
|
|
323
|
-
/**
|
|
324
|
-
* State passed to useFrame callbacks (extends RootState with timing)
|
|
309
|
+
* State passed to useFrame callbacks (extends RootState with timing).
|
|
325
310
|
*/
|
|
326
311
|
interface FrameNextState extends RootState, FrameTimingState {}
|
|
327
312
|
|
|
328
313
|
/** Alias for FrameNextState */
|
|
329
314
|
type FrameState = FrameNextState
|
|
330
315
|
|
|
331
|
-
//
|
|
316
|
+
// Callback Types (r3f-specific) --------------------------------
|
|
332
317
|
|
|
333
318
|
/**
|
|
334
|
-
*
|
|
319
|
+
* Callback function for useFrame. Receives the full r3f RootState plus timing.
|
|
335
320
|
*/
|
|
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
|
-
}
|
|
342
|
-
|
|
343
|
-
// Callback Types --------------------------------
|
|
344
|
-
|
|
345
|
-
/**
|
|
346
|
-
* Callback function for useFrame
|
|
347
|
-
*/
|
|
348
|
-
type FrameNextCallback = (state: FrameNextState, delta: number) => void
|
|
321
|
+
type FrameNextCallback = FrameCallback$1<RootState>
|
|
349
322
|
|
|
350
323
|
/** Alias for FrameNextCallback */
|
|
351
324
|
type FrameCallback = FrameNextCallback
|
|
352
325
|
|
|
353
|
-
// Controls returned from useFrame --------------------------------
|
|
354
|
-
|
|
355
|
-
/**
|
|
356
|
-
* Controls object returned from useFrame hook
|
|
357
|
-
*/
|
|
358
|
-
interface FrameNextControls {
|
|
359
|
-
/** The job's unique ID */
|
|
360
|
-
id: string
|
|
361
|
-
/** Access to the global scheduler for frame loop control */
|
|
362
|
-
scheduler: SchedulerApi
|
|
363
|
-
/** Manually step this job only (bypasses FPS limiting) */
|
|
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
|
|
377
|
-
|
|
378
|
-
// Scheduler Interface --------------------------------
|
|
379
|
-
|
|
380
|
-
/**
|
|
381
|
-
* Public interface for the global Scheduler
|
|
382
|
-
*/
|
|
383
|
-
interface SchedulerApi {
|
|
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
|
-
}
|
|
488
|
-
|
|
489
326
|
//* Renderer Types ========================================
|
|
490
327
|
|
|
491
328
|
/** Default renderer type - union of WebGL and WebGPU renderers */
|
|
@@ -499,6 +336,18 @@ type Subscription = {
|
|
|
499
336
|
store: RootStore
|
|
500
337
|
}
|
|
501
338
|
|
|
339
|
+
/** Per-pointer state for multi-touch and XR support */
|
|
340
|
+
type PointerState = {
|
|
341
|
+
/** Objects currently hovered by this pointer */
|
|
342
|
+
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
343
|
+
/** Objects capturing this pointer */
|
|
344
|
+
captured: Map<THREE$1.Object3D, PointerCaptureTarget>
|
|
345
|
+
/** Initial click position [x, y] */
|
|
346
|
+
initialClick: [x: number, y: number]
|
|
347
|
+
/** Objects hit on initial click */
|
|
348
|
+
initialHits: THREE$1.Object3D[]
|
|
349
|
+
}
|
|
350
|
+
|
|
502
351
|
type Dpr = number | [min: number, max: number]
|
|
503
352
|
|
|
504
353
|
interface Size {
|
|
@@ -540,12 +389,21 @@ interface Performance {
|
|
|
540
389
|
|
|
541
390
|
interface InternalState {
|
|
542
391
|
interaction: THREE$1.Object3D[]
|
|
543
|
-
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
544
392
|
subscribers: Subscription[]
|
|
393
|
+
/** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
|
|
394
|
+
pointerMap: Map<number, PointerState>
|
|
395
|
+
/** Pointers needing raycast this frame (used with frameTimedRaycasts) */
|
|
396
|
+
pointerDirty: Map<number, DomEvent>
|
|
397
|
+
/** Last event received (for events.update() compatibility) */
|
|
398
|
+
lastEvent: React$1.RefObject<DomEvent | null>
|
|
399
|
+
/** @deprecated Use pointerMap.get(pointerId).hovered instead */
|
|
400
|
+
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
401
|
+
/** @deprecated Use pointerMap.get(pointerId).captured instead */
|
|
545
402
|
capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
|
|
403
|
+
/** @deprecated Use pointerMap.get(pointerId).initialClick instead */
|
|
546
404
|
initialClick: [x: number, y: number]
|
|
405
|
+
/** @deprecated Use pointerMap.get(pointerId).initialHits instead */
|
|
547
406
|
initialHits: THREE$1.Object3D[]
|
|
548
|
-
lastEvent: React$1.RefObject<DomEvent | null>
|
|
549
407
|
/** Visibility event registry (onFramed, onOccluded, onVisible) */
|
|
550
408
|
visibilityRegistry: Map<string, VisibilityEntry>
|
|
551
409
|
/** Whether occlusion queries are enabled (WebGPU only) */
|
|
@@ -564,6 +422,12 @@ interface InternalState {
|
|
|
564
422
|
actualRenderer: R3FRenderer
|
|
565
423
|
/** Global scheduler reference (for useFrame hook) */
|
|
566
424
|
scheduler: SchedulerApi | null
|
|
425
|
+
/**
|
|
426
|
+
* Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
|
|
427
|
+
* `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
|
|
428
|
+
* render-phase takeover. Used by `useRenderPipeline`.
|
|
429
|
+
*/
|
|
430
|
+
renderOverride?: (() => void) | null
|
|
567
431
|
/** This root's unique ID in the global scheduler */
|
|
568
432
|
rootId?: string
|
|
569
433
|
/** Function to unregister this root from the global scheduler */
|
|
@@ -571,14 +435,31 @@ interface InternalState {
|
|
|
571
435
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
572
436
|
container?: THREE$1.Object3D
|
|
573
437
|
/**
|
|
574
|
-
* CanvasTarget
|
|
575
|
-
*
|
|
438
|
+
* The CanvasTarget this root sizes and renders through.
|
|
439
|
+
*
|
|
440
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
441
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
442
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
443
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
444
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
576
445
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
577
446
|
*/
|
|
578
447
|
canvasTarget?: CanvasTarget
|
|
448
|
+
/**
|
|
449
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
450
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
451
|
+
*
|
|
452
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
453
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
454
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
455
|
+
* invalidate some other canvas's descriptor instead.
|
|
456
|
+
*
|
|
457
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
458
|
+
*/
|
|
459
|
+
canvasTargetSizeDirty?: boolean
|
|
579
460
|
/**
|
|
580
461
|
* Whether multi-canvas rendering is active.
|
|
581
|
-
* True when any canvas uses `
|
|
462
|
+
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
582
463
|
* When true, setCanvasTarget is called before each render.
|
|
583
464
|
*/
|
|
584
465
|
isMultiCanvas?: boolean
|
|
@@ -614,12 +495,13 @@ interface RootState {
|
|
|
614
495
|
/** Get current state */
|
|
615
496
|
get: StoreApi<RootState>['getState']
|
|
616
497
|
/**
|
|
617
|
-
*
|
|
498
|
+
* The store of the canvas that owns this root's renderer.
|
|
618
499
|
* - For primary/independent canvases: points to its own store (self-reference)
|
|
619
500
|
* - For secondary canvases: points to the primary canvas's store
|
|
501
|
+
* - Portals copy it from their parent
|
|
620
502
|
*
|
|
621
|
-
*
|
|
622
|
-
*
|
|
503
|
+
* Anything shared per renderer rather than per canvas (e.g. @react-three/tsl's resources)
|
|
504
|
+
* resolves through it.
|
|
623
505
|
*/
|
|
624
506
|
primaryStore: RootStore
|
|
625
507
|
/** @deprecated Use `renderer` instead. The instance of the renderer (typed as WebGLRenderer for backwards compat) */
|
|
@@ -676,24 +558,16 @@ interface RootState {
|
|
|
676
558
|
setSize: (width?: number, height?: number, top?: number, left?: number) => void
|
|
677
559
|
/** Shortcut to manual setting the pixel ratio */
|
|
678
560
|
setDpr: (dpr: Dpr) => void
|
|
679
|
-
/** Shortcut to setting frameloop flags */
|
|
680
|
-
setFrameloop: (frameloop
|
|
561
|
+
/** Shortcut to setting frameloop flags. No args resets to 'always'. */
|
|
562
|
+
setFrameloop: (frameloop?: Frameloop) => void
|
|
681
563
|
/** Set error state to propagate to error boundary */
|
|
682
564
|
setError: (error: Error | null) => void
|
|
683
565
|
/** Current error state (null when no error) */
|
|
684
566
|
error: Error | null
|
|
685
|
-
/** Global
|
|
686
|
-
|
|
687
|
-
/**
|
|
688
|
-
|
|
689
|
-
/** Global TSL texture nodes - use useTextures() hook for operations */
|
|
690
|
-
textures: Map<string, any>
|
|
691
|
-
/** WebGPU PostProcessing instance - use usePostProcessing() hook */
|
|
692
|
-
postProcessing: any | null // THREE.PostProcessing when available
|
|
693
|
-
/** Global TSL pass nodes for post-processing - use usePostProcessing() hook */
|
|
694
|
-
passes: Record<string, any>
|
|
695
|
-
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
696
|
-
_hmrVersion: number
|
|
567
|
+
/** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
|
|
568
|
+
textures: Map<string, THREE$1.Texture>
|
|
569
|
+
/** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
|
|
570
|
+
_textureRefs: Map<string, number>
|
|
697
571
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
698
572
|
_sizeImperative: boolean
|
|
699
573
|
/** Internal: stored size props from Canvas for reset functionality */
|
|
@@ -740,6 +614,20 @@ interface Renderer {
|
|
|
740
614
|
render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
|
|
741
615
|
}
|
|
742
616
|
|
|
617
|
+
//* Color Management Config ==============================
|
|
618
|
+
|
|
619
|
+
/**
|
|
620
|
+
* Color management configuration shared by both WebGL and WebGPU renderers.
|
|
621
|
+
*/
|
|
622
|
+
interface ColorManagementConfig {
|
|
623
|
+
/**
|
|
624
|
+
* Color space assigned to 8-bit input textures (color maps).
|
|
625
|
+
* Defaults to sRGB. Most textures are authored in sRGB.
|
|
626
|
+
* @default THREE.SRGBColorSpace
|
|
627
|
+
*/
|
|
628
|
+
textureColorSpace?: THREE$1.ColorSpace
|
|
629
|
+
}
|
|
630
|
+
|
|
743
631
|
//* WebGL Renderer Props ==============================
|
|
744
632
|
|
|
745
633
|
type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
|
|
@@ -750,7 +638,7 @@ type GLProps =
|
|
|
750
638
|
| Renderer
|
|
751
639
|
| ((defaultProps: DefaultGLProps) => Renderer)
|
|
752
640
|
| ((defaultProps: DefaultGLProps) => Promise<Renderer>)
|
|
753
|
-
| Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
|
|
641
|
+
| (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
|
|
754
642
|
|
|
755
643
|
//* WebGPU Renderer Props ==============================
|
|
756
644
|
|
|
@@ -765,20 +653,27 @@ type DefaultRendererProps = {
|
|
|
765
653
|
*/
|
|
766
654
|
interface CanvasSchedulerConfig {
|
|
767
655
|
/**
|
|
768
|
-
*
|
|
769
|
-
|
|
656
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
657
|
+
*/
|
|
658
|
+
before?: string | string[]
|
|
659
|
+
/**
|
|
660
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
661
|
+
*/
|
|
662
|
+
after?: string | string[]
|
|
663
|
+
/**
|
|
664
|
+
* Numeric root order. Lower values run first.
|
|
770
665
|
*/
|
|
771
|
-
|
|
666
|
+
order?: number
|
|
772
667
|
/**
|
|
773
|
-
* Limit this
|
|
668
|
+
* Limit this Canvas's default render job (frames per second).
|
|
774
669
|
*/
|
|
775
670
|
fps?: number
|
|
776
671
|
}
|
|
777
672
|
|
|
778
673
|
/**
|
|
779
|
-
* Extended renderer configuration for multi-canvas support.
|
|
674
|
+
* Extended renderer configuration for multi-canvas support and color management.
|
|
780
675
|
*/
|
|
781
|
-
interface RendererConfigExtended {
|
|
676
|
+
interface RendererConfigExtended extends ColorManagementConfig {
|
|
782
677
|
/** Share renderer from another canvas (WebGPU only) */
|
|
783
678
|
primaryCanvas?: string
|
|
784
679
|
/** Canvas-level scheduler options */
|
|
@@ -843,8 +738,6 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
843
738
|
* @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
|
|
844
739
|
*/
|
|
845
740
|
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
741
|
/** Creates an orthographic camera */
|
|
849
742
|
orthographic?: boolean
|
|
850
743
|
/**
|
|
@@ -859,14 +752,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
859
752
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
860
753
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
861
754
|
dpr?: Dpr
|
|
862
|
-
/**
|
|
863
|
-
|
|
755
|
+
/**
|
|
756
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
757
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
758
|
+
*/
|
|
759
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
864
760
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
865
761
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
866
762
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
867
763
|
camera?: CameraProps
|
|
868
764
|
/** An R3F event manager to manage elements' pointer events */
|
|
869
|
-
events?: (store: RootStore) => EventManager<
|
|
765
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
870
766
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
871
767
|
onCreated?: (state: RootState) => void
|
|
872
768
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -955,7 +851,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
|
|
|
955
851
|
object?: T
|
|
956
852
|
dispose?: null
|
|
957
853
|
attach?: AttachType<T>
|
|
958
|
-
onUpdate?: (self: T) => void
|
|
959
854
|
}
|
|
960
855
|
|
|
961
856
|
interface Instance<O = any> {
|
|
@@ -970,8 +865,6 @@ interface Instance<O = any> {
|
|
|
970
865
|
attach?: AttachType<O>
|
|
971
866
|
previousAttach?: any
|
|
972
867
|
isHidden: boolean
|
|
973
|
-
/** Deferred ref props to apply in commitMount */
|
|
974
|
-
deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
|
|
975
868
|
/** Set of props that have been applied via once() */
|
|
976
869
|
appliedOnce?: Set<string>
|
|
977
870
|
}
|
|
@@ -1097,7 +990,7 @@ interface CanvasProps
|
|
|
1097
990
|
*/
|
|
1098
991
|
resize?: Options
|
|
1099
992
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1100
|
-
eventSource?:
|
|
993
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1101
994
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1102
995
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1103
996
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1205,329 +1098,6 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1205
1098
|
|
|
1206
1099
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1207
1100
|
|
|
1208
|
-
//* Global Types ==============================
|
|
1209
|
-
|
|
1210
|
-
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
|
-
/**
|
|
1217
|
-
* ShaderCallable - the return type of Fn()
|
|
1218
|
-
* A callable shader function node that can be invoked with parameters.
|
|
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
|
-
* ```
|
|
1234
|
-
*/
|
|
1235
|
-
type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
|
|
1236
|
-
|
|
1237
|
-
/**
|
|
1238
|
-
* ShaderNodeRef - a ShaderNodeObject wrapper around a Node
|
|
1239
|
-
* This is the common return type for TSL operations (add, mul, sin, etc.)
|
|
1240
|
-
*
|
|
1241
|
-
* @example
|
|
1242
|
-
* ```tsx
|
|
1243
|
-
* const { wobble } = nodes as { wobble: ShaderNodeRef }
|
|
1244
|
-
* ```
|
|
1245
|
-
*/
|
|
1246
|
-
type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
|
|
1247
|
-
|
|
1248
|
-
/**
|
|
1249
|
-
* TSLNodeType - Union of all common TSL node types
|
|
1250
|
-
* Used by ScopedStore to properly type node access from the store.
|
|
1251
|
-
*
|
|
1252
|
-
* Includes:
|
|
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
|
-
* ```
|
|
1270
|
-
*/
|
|
1271
|
-
type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
|
|
1272
|
-
|
|
1273
|
-
/** Flat record of uniform nodes (no nested scopes) */
|
|
1274
|
-
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
1275
|
-
|
|
1276
|
-
/**
|
|
1277
|
-
* Uniform store that can contain both root-level uniforms and scoped uniform objects
|
|
1278
|
-
* Used by state.uniforms which has structure like:
|
|
1279
|
-
* { uTime: UniformNode, player: { uHealth: UniformNode }, enemy: { uHealth: UniformNode } }
|
|
1280
|
-
*/
|
|
1281
|
-
type UniformStore = Record<string, UniformNode | UniformRecord>
|
|
1282
|
-
|
|
1283
|
-
/**
|
|
1284
|
-
* Helper to safely access a uniform node from the store.
|
|
1285
|
-
* Use this when accessing state.uniforms to get proper typing.
|
|
1286
|
-
* @example
|
|
1287
|
-
* const uTime = uniforms.uTime as UniformNode<number>
|
|
1288
|
-
* const uColor = uniforms.uColor as UniformNode<import('three/webgpu').Color>
|
|
1289
|
-
*/
|
|
1290
|
-
type GetUniform<T = unknown> = UniformNode<T>
|
|
1291
|
-
|
|
1292
|
-
/**
|
|
1293
|
-
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1294
|
-
* Supports:
|
|
1295
|
-
* - Primitives: number, string (color), boolean
|
|
1296
|
-
* - Three.js types: Color, Vector2/3/4, Matrix3/4, Euler, Quaternion
|
|
1297
|
-
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1298
|
-
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1299
|
-
* - UniformNode: existing uniforms (reused as-is)
|
|
1300
|
-
*/
|
|
1301
|
-
type UniformValue =
|
|
1302
|
-
| number
|
|
1303
|
-
| string
|
|
1304
|
-
| boolean
|
|
1305
|
-
| three_webgpu.Color
|
|
1306
|
-
| three_webgpu.Vector2
|
|
1307
|
-
| three_webgpu.Vector3
|
|
1308
|
-
| three_webgpu.Vector4
|
|
1309
|
-
| three_webgpu.Matrix3
|
|
1310
|
-
| three_webgpu.Matrix4
|
|
1311
|
-
| three_webgpu.Euler
|
|
1312
|
-
| three_webgpu.Quaternion
|
|
1313
|
-
| { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
|
|
1314
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1315
|
-
| UniformNode
|
|
1316
|
-
|
|
1317
|
-
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1318
|
-
type UniformInputRecord = Record<string, UniformValue>
|
|
1319
|
-
}
|
|
1320
|
-
|
|
1321
|
-
//* Module Augmentation ==============================
|
|
1322
|
-
|
|
1323
|
-
declare module 'three/tsl' {
|
|
1324
|
-
/**
|
|
1325
|
-
* Fn with array parameter destructuring
|
|
1326
|
-
* @example Fn(([uv, skew]) => { ... })
|
|
1327
|
-
*/
|
|
1328
|
-
export function Fn<R extends Node = Node>(
|
|
1329
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1330
|
-
): ShaderCallable<R>
|
|
1331
|
-
|
|
1332
|
-
/**
|
|
1333
|
-
* Fn with object parameter destructuring
|
|
1334
|
-
* @example Fn(({ color, intensity }) => { ... })
|
|
1335
|
-
*/
|
|
1336
|
-
export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
|
|
1337
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1338
|
-
): ShaderCallable<R>
|
|
1339
|
-
|
|
1340
|
-
/**
|
|
1341
|
-
* Fn with array params + layout
|
|
1342
|
-
* @example Fn(([a, b]) => { ... }, { layout: [...] })
|
|
1343
|
-
*/
|
|
1344
|
-
export function Fn<R extends Node = Node>(
|
|
1345
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1346
|
-
layout: { layout?: unknown },
|
|
1347
|
-
): ShaderCallable<R>
|
|
1348
|
-
|
|
1349
|
-
/**
|
|
1350
|
-
* Fn with object params + layout
|
|
1351
|
-
*/
|
|
1352
|
-
export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
|
|
1353
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1354
|
-
layout: { layout?: unknown },
|
|
1355
|
-
): ShaderCallable<R>
|
|
1356
|
-
}
|
|
1357
|
-
|
|
1358
|
-
/**
|
|
1359
|
-
* PostProcessing Types for usePostProcessing hook (WebGPU only)
|
|
1360
|
-
*/
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
declare global {
|
|
1365
|
-
/** Pass record - stores TSL pass nodes for post-processing */
|
|
1366
|
-
type PassRecord = Record<string, any>
|
|
1367
|
-
|
|
1368
|
-
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1369
|
-
type PostProcessingSetupCallback = (state: RootState) => PassRecord | void
|
|
1370
|
-
|
|
1371
|
-
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1372
|
-
type PostProcessingMainCallback = (state: RootState) => PassRecord | void
|
|
1373
|
-
|
|
1374
|
-
/** Return type for usePostProcessing hook */
|
|
1375
|
-
interface UsePostProcessingReturn {
|
|
1376
|
-
/** Current passes from state */
|
|
1377
|
-
passes: PassRecord
|
|
1378
|
-
/** PostProcessing instance (null if not initialized) */
|
|
1379
|
-
postProcessing: any | null // THREE.PostProcessing
|
|
1380
|
-
/** Clear all passes from state */
|
|
1381
|
-
clearPasses: () => void
|
|
1382
|
-
/** Reset PostProcessing entirely (clears PP + passes) */
|
|
1383
|
-
reset: () => void
|
|
1384
|
-
/** Re-run setup/main callbacks with current closure values */
|
|
1385
|
-
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
|
-
}
|
|
1455
|
-
|
|
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
|
-
/**
|
|
1479
|
-
* Internal representation of a registered root (Canvas).
|
|
1480
|
-
* Tracks jobs and manages rebuild state for this root.
|
|
1481
|
-
* @internal
|
|
1482
|
-
*/
|
|
1483
|
-
interface RootEntry {
|
|
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
|
|
1527
|
-
*/
|
|
1528
|
-
type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
|
|
1529
|
-
}
|
|
1530
|
-
|
|
1531
1101
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
1532
1102
|
|
|
1533
1103
|
interface MathRepresentation {
|
|
@@ -1604,10 +1174,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1604
1174
|
|
|
1605
1175
|
/**
|
|
1606
1176
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1607
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1177
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1178
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1608
1179
|
*/
|
|
1609
1180
|
type NodeProps<P> = {
|
|
1610
|
-
[K in keyof P as P[K] extends
|
|
1181
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1611
1182
|
}
|
|
1612
1183
|
|
|
1613
1184
|
interface ReactProps<P> {
|
|
@@ -1628,11 +1199,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1628
1199
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1629
1200
|
}
|
|
1630
1201
|
|
|
1202
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1203
|
+
type Object3DMethod = NonNullable<
|
|
1204
|
+
{
|
|
1205
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1206
|
+
}[keyof Object3D]
|
|
1207
|
+
>
|
|
1208
|
+
|
|
1631
1209
|
type ThreeExports = typeof THREE
|
|
1632
1210
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1633
1211
|
|
|
1634
1212
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1635
|
-
|
|
1213
|
+
/**
|
|
1214
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1215
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1216
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1217
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1218
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1219
|
+
*/
|
|
1220
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
|
|
1221
|
+
object: object
|
|
1222
|
+
ref?: React.Ref<any>
|
|
1223
|
+
[prop: string]: unknown
|
|
1224
|
+
}
|
|
1636
1225
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1637
1226
|
threeAudio: ThreeElementsImpl['audio']
|
|
1638
1227
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1673,6 +1262,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1673
1262
|
type three_d_Matrix4 = Matrix4;
|
|
1674
1263
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1675
1264
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1265
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1676
1266
|
type three_d_Quaternion = Quaternion;
|
|
1677
1267
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1678
1268
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1687,7 +1277,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1687
1277
|
type three_d_Vector4 = Vector4;
|
|
1688
1278
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1689
1279
|
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 };
|
|
1280
|
+
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
1281
|
}
|
|
1692
1282
|
|
|
1693
1283
|
/**
|
|
@@ -1697,7 +1287,7 @@ declare namespace three_d {
|
|
|
1697
1287
|
* a single WebGPURenderer using Three.js CanvasTarget API.
|
|
1698
1288
|
*
|
|
1699
1289
|
* Primary canvas: Has `id` prop, creates its own renderer, registers here
|
|
1700
|
-
* Secondary canvas: Has `
|
|
1290
|
+
* Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
|
|
1701
1291
|
*/
|
|
1702
1292
|
|
|
1703
1293
|
interface PrimaryCanvasEntry {
|
|
@@ -1765,12 +1355,23 @@ type EnvironmentLoaderProps = {
|
|
|
1765
1355
|
* const texture = useEnvironment({ preset: 'sunset' })
|
|
1766
1356
|
* ```
|
|
1767
1357
|
*/
|
|
1768
|
-
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture
|
|
1358
|
+
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
|
|
1769
1359
|
declare namespace useEnvironment {
|
|
1770
1360
|
var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
|
|
1771
1361
|
var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
|
|
1772
1362
|
}
|
|
1773
|
-
|
|
1363
|
+
/**
|
|
1364
|
+
* Options accepted by `useEnvironment.preload`.
|
|
1365
|
+
*
|
|
1366
|
+
* `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
|
|
1367
|
+
* applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
|
|
1368
|
+
* advertise an option this function silently ignores.
|
|
1369
|
+
*
|
|
1370
|
+
* This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
|
|
1371
|
+
* `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
|
|
1372
|
+
* type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
|
|
1373
|
+
*/
|
|
1374
|
+
type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
|
|
1774
1375
|
type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
|
|
1775
1376
|
|
|
1776
1377
|
/**
|
|
@@ -1814,9 +1415,9 @@ type EnvironmentProps = {
|
|
|
1814
1415
|
blur?: number;
|
|
1815
1416
|
backgroundBlurriness?: number;
|
|
1816
1417
|
backgroundIntensity?: number;
|
|
1817
|
-
backgroundRotation?: Euler
|
|
1418
|
+
backgroundRotation?: Euler;
|
|
1818
1419
|
environmentIntensity?: number;
|
|
1819
|
-
environmentRotation?: Euler
|
|
1420
|
+
environmentRotation?: Euler;
|
|
1820
1421
|
map?: Texture$1;
|
|
1821
1422
|
preset?: PresetsType;
|
|
1822
1423
|
scene?: Scene | React$1.RefObject<Scene>;
|
|
@@ -1900,7 +1501,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
|
|
|
1900
1501
|
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
1502
|
declare module '@react-three/fiber' {
|
|
1902
1503
|
interface ThreeElements {
|
|
1903
|
-
groundProjectedEnvImpl: ThreeElement
|
|
1504
|
+
groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
|
|
1904
1505
|
}
|
|
1905
1506
|
}
|
|
1906
1507
|
/**
|
|
@@ -2000,12 +1601,68 @@ declare module '@react-three/fiber' {
|
|
|
2000
1601
|
*/
|
|
2001
1602
|
declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
2002
1603
|
|
|
1604
|
+
/**
|
|
1605
|
+
* Moves every trace of interactivity from one object to its replacement, for reconstruction.
|
|
1606
|
+
*
|
|
1607
|
+
* When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
|
|
1608
|
+
* instance. Removing the old object from the interaction state and registering the new one from
|
|
1609
|
+
* scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
|
|
1610
|
+
* the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
|
|
1611
|
+
* is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
|
|
1612
|
+
* swap the user never asked to see (#3744).
|
|
1613
|
+
*
|
|
1614
|
+
* Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
|
|
1615
|
+
* left alone — releasing and re-acquiring it is precisely the glitch being avoided.
|
|
1616
|
+
*
|
|
1617
|
+
* Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
|
|
1618
|
+
* the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
|
|
1619
|
+
* cannot outlive the object it described.
|
|
1620
|
+
*/
|
|
1621
|
+
declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
|
|
2003
1622
|
declare function removeInteractivity(store: RootStore, object: Object3D): void;
|
|
2004
1623
|
declare function createEvents(store: RootStore): {
|
|
2005
1624
|
handlePointer: (name: string) => (event: DomEvent) => void;
|
|
1625
|
+
flushDeferredPointers: () => void;
|
|
1626
|
+
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
2006
1627
|
};
|
|
2007
1628
|
/** Default R3F event manager for web */
|
|
2008
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1629
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1630
|
+
|
|
1631
|
+
interface RootExtension {
|
|
1632
|
+
/** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
|
|
1633
|
+
* set up are not set up a second time, but get the new entry's dispose and hmr. */
|
|
1634
|
+
name: string;
|
|
1635
|
+
/**
|
|
1636
|
+
* Called once per root, after its renderer exists and before `onCreated` and the first frame.
|
|
1637
|
+
* `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
|
|
1638
|
+
* to the primary canvas. Return fields to merge into the root's state, or nothing.
|
|
1639
|
+
*/
|
|
1640
|
+
setup?(store: RootStore): Partial<RootState> | void;
|
|
1641
|
+
/** Called when a root this extension set up unmounts. */
|
|
1642
|
+
dispose?(store: RootStore): void;
|
|
1643
|
+
/** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
|
|
1644
|
+
hmr?(store: RootStore): void;
|
|
1645
|
+
}
|
|
1646
|
+
/**
|
|
1647
|
+
* Register an extension. It is set up on every live root immediately, and on every root created
|
|
1648
|
+
* afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
|
|
1649
|
+
* it already set up keep its state and still get its dispose when they unmount.
|
|
1650
|
+
*/
|
|
1651
|
+
declare function registerRootExtension(extension: RootExtension): () => void;
|
|
1652
|
+
/**
|
|
1653
|
+
* Point a root's default render job at a different render function, or back at
|
|
1654
|
+
* `renderer.render(scene, camera)` with `null`.
|
|
1655
|
+
*
|
|
1656
|
+
* The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
|
|
1657
|
+
* boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
|
|
1658
|
+
*/
|
|
1659
|
+
declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
|
|
1660
|
+
|
|
1661
|
+
/**
|
|
1662
|
+
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
1663
|
+
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
1664
|
+
*/
|
|
1665
|
+
declare function useStore(): RootStore;
|
|
2009
1666
|
|
|
2010
1667
|
/**
|
|
2011
1668
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -2018,419 +1675,13 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
|
|
|
2018
1675
|
* Note: this hook's caller must be wrapped with `React.Suspense`
|
|
2019
1676
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
|
|
2020
1677
|
*/
|
|
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>;
|
|
1678
|
+
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
1679
|
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;
|
|
1680
|
+
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;
|
|
1681
|
+
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
|
|
2025
1682
|
var loader: typeof getLoader;
|
|
2026
1683
|
}
|
|
2027
1684
|
|
|
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
|
-
/**
|
|
2392
|
-
* Frame hook with phase-based ordering, priority, and FPS throttling.
|
|
2393
|
-
*
|
|
2394
|
-
* Works both inside and outside Canvas context:
|
|
2395
|
-
* - Inside Canvas: Full RootState (gl, scene, camera, etc.)
|
|
2396
|
-
* - Outside Canvas (waiting mode): Waits for Canvas to mount, then gets full state
|
|
2397
|
-
* - Outside Canvas (independent mode): Fires immediately with timing-only state
|
|
2398
|
-
*
|
|
2399
|
-
* Returns a controls object for manual stepping, pausing, and resuming.
|
|
2400
|
-
*
|
|
2401
|
-
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
2402
|
-
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
2403
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
2404
|
-
*
|
|
2405
|
-
* @example
|
|
2406
|
-
* // Simple priority (backwards compat)
|
|
2407
|
-
* useFrame((state, delta) => { ... }, 5)
|
|
2408
|
-
*
|
|
2409
|
-
* @example
|
|
2410
|
-
* // With phase-based ordering
|
|
2411
|
-
* useFrame((state, delta) => { ... }, { phase: 'physics' })
|
|
2412
|
-
*
|
|
2413
|
-
* @example
|
|
2414
|
-
* // Outside Canvas - waits for Canvas to mount
|
|
2415
|
-
* function UI() {
|
|
2416
|
-
* useFrame((state, delta) => { syncUI(state.camera) });
|
|
2417
|
-
* return <button>...</button>;
|
|
2418
|
-
* }
|
|
2419
|
-
*
|
|
2420
|
-
* @example
|
|
2421
|
-
* // Independent mode - no Canvas needed
|
|
2422
|
-
* getScheduler().independent = true;
|
|
2423
|
-
* useFrame((state, delta) => { updateGame(delta) });
|
|
2424
|
-
*
|
|
2425
|
-
* @example
|
|
2426
|
-
* // Scheduler-only access (no callback)
|
|
2427
|
-
* const { scheduler } = useFrame()
|
|
2428
|
-
* scheduler.pauseJob('some-job-id')
|
|
2429
|
-
*
|
|
2430
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
|
|
2431
|
-
*/
|
|
2432
|
-
declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
|
|
2433
|
-
|
|
2434
1685
|
declare const IsObject: (url: unknown) => url is Record<string, string>;
|
|
2435
1686
|
type TextureArray<T> = T extends string[] ? Texture$1[] : never;
|
|
2436
1687
|
type TextureRecord<T> = T extends Record<string, string> ? {
|
|
@@ -2443,11 +1694,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2443
1694
|
/** Callback when texture(s) finish loading */
|
|
2444
1695
|
onLoad?: (texture: MappedTextureType<Url>) => void;
|
|
2445
1696
|
/**
|
|
2446
|
-
*
|
|
2447
|
-
* When true:
|
|
1697
|
+
* Register the texture(s) in R3F's global texture registry for access via useTextures().
|
|
1698
|
+
* When true (the default):
|
|
2448
1699
|
* - Textures persist until explicitly disposed
|
|
2449
|
-
* -
|
|
2450
|
-
*
|
|
1700
|
+
* - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
|
|
1701
|
+
*
|
|
1702
|
+
* Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
|
|
1703
|
+
* changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
|
|
1704
|
+
*
|
|
1705
|
+
* Pass `false` to opt out of registry enrollment entirely.
|
|
1706
|
+
* @default true
|
|
2451
1707
|
*/
|
|
2452
1708
|
cache?: boolean;
|
|
2453
1709
|
};
|
|
@@ -2471,15 +1727,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2471
1727
|
* normal: '/normal.png'
|
|
2472
1728
|
* })
|
|
2473
1729
|
*
|
|
2474
|
-
* //
|
|
2475
|
-
* //
|
|
2476
|
-
* const diffuse = useTexture('/diffuse.png'
|
|
1730
|
+
* // Textures are registered in the global registry by default — the same texture
|
|
1731
|
+
* // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
|
|
1732
|
+
* const diffuse = useTexture('/diffuse.png')
|
|
2477
1733
|
* diffuse.colorSpace = THREE.SRGBColorSpace
|
|
2478
1734
|
*
|
|
2479
1735
|
* // Another component gets the SAME texture with colorSpace already set
|
|
2480
|
-
* const sameDiffuse = useTexture('/diffuse.png'
|
|
1736
|
+
* const sameDiffuse = useTexture('/diffuse.png')
|
|
1737
|
+
*
|
|
1738
|
+
* // Opt out of registry enrollment for a one-off texture
|
|
1739
|
+
* const scratch = useTexture('/scratch.png', { cache: false })
|
|
2481
1740
|
*
|
|
2482
|
-
* // Access
|
|
1741
|
+
* // Access the registry directly
|
|
2483
1742
|
* const { get } = useTextures()
|
|
2484
1743
|
* const cached = get('/diffuse.png')
|
|
2485
1744
|
* ```
|
|
@@ -2496,63 +1755,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
|
|
|
2496
1755
|
cache?: boolean;
|
|
2497
1756
|
}) => react_jsx_runtime.JSX.Element;
|
|
2498
1757
|
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
1758
|
+
/** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
|
|
1759
|
+
type TextureInput = string | string[] | Record<string, string>;
|
|
1760
|
+
/** Result of a `get()` read, mirroring the input shape. */
|
|
1761
|
+
type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
|
|
1762
|
+
[K in keyof Input]: Texture$1 | undefined;
|
|
2502
1763
|
};
|
|
1764
|
+
/** Options for `dispose()`. */
|
|
1765
|
+
interface DisposeOptions {
|
|
1766
|
+
/** Dispose even if the texture still has active references (default false). */
|
|
1767
|
+
force?: boolean;
|
|
1768
|
+
}
|
|
2503
1769
|
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
|
-
|
|
1770
|
+
/** The live registry Map (key → Texture). Treat as read-only. */
|
|
1771
|
+
readonly all: Map<string, Texture$1>;
|
|
1772
|
+
/** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
|
|
1773
|
+
get<Input extends TextureInput>(input: Input): TextureResult<Input>;
|
|
1774
|
+
/** Check whether a key exists in the registry. */
|
|
1775
|
+
has(key: string): boolean;
|
|
1776
|
+
/**
|
|
1777
|
+
* Register a texture (or a record of textures) that has no URL — e.g. a render
|
|
1778
|
+
* target or procedural texture. URL-loaded textures are registered automatically
|
|
1779
|
+
* by `useTexture` (registry enrollment is on by default).
|
|
1780
|
+
*/
|
|
1781
|
+
add(key: string, texture: Texture$1): void;
|
|
1782
|
+
add(record: Record<string, Texture$1>): void;
|
|
1783
|
+
/**
|
|
1784
|
+
* Dispose a texture's GPU resources and remove it from the registry.
|
|
1785
|
+
* Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
|
|
1786
|
+
* skipped (with a warning) unless `{ force: true }` is passed.
|
|
1787
|
+
* @returns true if disposed, false if skipped.
|
|
1788
|
+
*/
|
|
1789
|
+
dispose(key: string, options?: DisposeOptions): boolean;
|
|
1790
|
+
/** Dispose every texture in the registry and clear it. Use on scene teardown. */
|
|
1791
|
+
disposeAll(): void;
|
|
2524
1792
|
}
|
|
2525
1793
|
/**
|
|
2526
|
-
*
|
|
1794
|
+
* Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
|
|
1795
|
+
*
|
|
1796
|
+
* This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
|
|
1797
|
+
* a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
|
|
1798
|
+
* `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
|
|
2527
1799
|
*
|
|
2528
|
-
*
|
|
2529
|
-
*
|
|
1800
|
+
* The returned handle is **reactive**: the calling component re-renders when the registry
|
|
1801
|
+
* changes. Pass a selector to scope the subscription to a single read.
|
|
2530
1802
|
*
|
|
2531
1803
|
* @example
|
|
2532
1804
|
* ```tsx
|
|
2533
|
-
*
|
|
1805
|
+
* // Load + register once (anywhere in the tree) — registered by default
|
|
1806
|
+
* useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
2534
1807
|
*
|
|
2535
|
-
* //
|
|
2536
|
-
*
|
|
2537
|
-
*
|
|
2538
|
-
* const tex = useTexture('/textures/diffuse.png', { cache: true })
|
|
2539
|
-
* }
|
|
2540
|
-
*
|
|
2541
|
-
* // Access cached texture from anywhere
|
|
2542
|
-
* const diffuse = get('/textures/diffuse.png')
|
|
2543
|
-
* if (diffuse) material.map = diffuse
|
|
1808
|
+
* // Reach them from another component — record form lands straight into a material
|
|
1809
|
+
* const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
1810
|
+
* return <meshStandardMaterial map={map} normalMap={normalMap} />
|
|
2544
1811
|
*
|
|
2545
|
-
* //
|
|
2546
|
-
*
|
|
1812
|
+
* // A set of heightmaps at once
|
|
1813
|
+
* const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
|
|
2547
1814
|
*
|
|
2548
|
-
* //
|
|
2549
|
-
*
|
|
1815
|
+
* // Register a non-URL texture (render target / procedural)
|
|
1816
|
+
* useTextures().add('rt-main', renderTarget.texture)
|
|
2550
1817
|
*
|
|
2551
|
-
* //
|
|
2552
|
-
*
|
|
1818
|
+
* // Deliberate GPU cleanup (refcount-aware; force to override)
|
|
1819
|
+
* useTextures().dispose('/diffuse.jpg')
|
|
1820
|
+
* useTextures().disposeAll() // scene teardown
|
|
2553
1821
|
* ```
|
|
1822
|
+
*
|
|
1823
|
+
* @remarks
|
|
1824
|
+
* **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
|
|
1825
|
+
* intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
|
|
1826
|
+
* populate the registry without Suspense, at the cost of putting loading back into this hook. It
|
|
1827
|
+
* will be added only if a concrete consumer needs imperative loading; for now, loading lives in
|
|
1828
|
+
* `useTexture`.
|
|
2554
1829
|
*/
|
|
2555
1830
|
declare function useTextures(): UseTexturesReturn;
|
|
1831
|
+
declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
|
|
2556
1832
|
|
|
2557
1833
|
/**
|
|
2558
1834
|
* Creates a render target compatible with the current renderer.
|
|
@@ -2582,20 +1858,10 @@ declare function useTextures(): UseTexturesReturn;
|
|
|
2582
1858
|
* const fbo = useRenderTarget(512, 256, { samples: 4 })
|
|
2583
1859
|
* ```
|
|
2584
1860
|
*/
|
|
2585
|
-
declare function useRenderTarget(options?: RenderTargetOptions):
|
|
2586
|
-
declare function useRenderTarget(size: number, options?: RenderTargetOptions):
|
|
2587
|
-
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions):
|
|
1861
|
+
declare function useRenderTarget(options?: RenderTargetOptions): WebGLRenderTarget;
|
|
1862
|
+
declare function useRenderTarget(size: number, options?: RenderTargetOptions): WebGLRenderTarget;
|
|
1863
|
+
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): WebGLRenderTarget;
|
|
2588
1864
|
|
|
2589
|
-
/**
|
|
2590
|
-
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
2591
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2592
|
-
*/
|
|
2593
|
-
declare function useStore(): RootStore;
|
|
2594
|
-
/**
|
|
2595
|
-
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
2596
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
2597
|
-
*/
|
|
2598
|
-
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
2599
1865
|
/**
|
|
2600
1866
|
* Exposes an object's {@link Instance}.
|
|
2601
1867
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2671,7 +1937,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2671
1937
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2672
1938
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2673
1939
|
*
|
|
2674
|
-
*
|
|
1940
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
1941
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
1942
|
+
*
|
|
1943
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2675
1944
|
* @param frames - Number of frames to request (default: 1)
|
|
2676
1945
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2677
1946
|
*
|
|
@@ -2682,14 +1951,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2682
1951
|
* Advances the frameloop and runs render effects.
|
|
2683
1952
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2684
1953
|
*
|
|
1954
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
1955
|
+
* registered root is stepped for backwards compatibility.
|
|
1956
|
+
*
|
|
2685
1957
|
* @param timestamp - The timestamp to use for this frame
|
|
2686
1958
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2687
|
-
* @param state -
|
|
2688
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
1959
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2689
1960
|
*
|
|
2690
1961
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2691
1962
|
*/
|
|
2692
|
-
declare function advance(timestamp: number): void;
|
|
1963
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2693
1964
|
|
|
2694
1965
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2695
1966
|
declare function ReactReconciler<
|
|
@@ -3734,6 +3005,7 @@ declare namespace ReactReconciler {
|
|
|
3734
3005
|
|
|
3735
3006
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3736
3007
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3008
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3737
3009
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3738
3010
|
|
|
3739
3011
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3758,13 +3030,9 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
|
|
|
3758
3030
|
declare function flushSync<R>(fn: () => R): R;
|
|
3759
3031
|
|
|
3760
3032
|
declare const context: React$1.Context<RootStore>;
|
|
3033
|
+
|
|
3761
3034
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3762
3035
|
|
|
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
3036
|
/**
|
|
3769
3037
|
* An SSR-friendly useLayoutEffect.
|
|
3770
3038
|
*
|
|
@@ -4016,7 +3284,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
|
|
|
4016
3284
|
declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
|
|
4017
3285
|
/**
|
|
4018
3286
|
* Triggers an update for an instance.
|
|
4019
|
-
*
|
|
3287
|
+
* Invalidates the frame if the root is in demand mode.
|
|
4020
3288
|
*
|
|
4021
3289
|
* @param instance - Instance to invalidate
|
|
4022
3290
|
*/
|
|
@@ -4182,29 +3450,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
4182
3450
|
* Used to identify values that should be resolved from refs after mount.
|
|
4183
3451
|
*/
|
|
4184
3452
|
declare const FROM_REF: unique symbol;
|
|
3453
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3454
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3455
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3456
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3457
|
+
transform?: (value: T) => R;
|
|
3458
|
+
}
|
|
4185
3459
|
/**
|
|
4186
3460
|
* Defers prop application until the referenced object is available.
|
|
4187
3461
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
4188
3462
|
*
|
|
3463
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3464
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3465
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3466
|
+
* what gets assigned.
|
|
3467
|
+
*
|
|
4189
3468
|
* @param ref - React ref object to resolve at mount time
|
|
4190
|
-
* @
|
|
3469
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3470
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
4191
3471
|
*
|
|
4192
3472
|
* @example
|
|
4193
3473
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
4194
3474
|
*
|
|
4195
3475
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
4196
3476
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3477
|
+
*
|
|
3478
|
+
* @example
|
|
3479
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3480
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
4197
3481
|
*/
|
|
4198
3482
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3483
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
4199
3484
|
/**
|
|
4200
3485
|
* Type guard to check if a value is a fromRef marker.
|
|
4201
3486
|
*
|
|
4202
3487
|
* @param value - Value to check
|
|
4203
3488
|
* @returns True if value is a fromRef marker
|
|
4204
3489
|
*/
|
|
4205
|
-
declare function isFromRef(value: unknown): value is
|
|
4206
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
4207
|
-
};
|
|
3490
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
4208
3491
|
|
|
4209
3492
|
/**
|
|
4210
3493
|
* Symbol marker for mount-only method calls.
|
|
@@ -4231,7 +3514,15 @@ declare const ONCE: unique symbol;
|
|
|
4231
3514
|
* // No arguments
|
|
4232
3515
|
* <geometry center={once()} />
|
|
4233
3516
|
*/
|
|
4234
|
-
declare function once<
|
|
3517
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3518
|
+
/**
|
|
3519
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3520
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3521
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3522
|
+
*
|
|
3523
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3524
|
+
*/
|
|
3525
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
4235
3526
|
/**
|
|
4236
3527
|
* Type guard to check if a value is a once marker.
|
|
4237
3528
|
*
|
|
@@ -4243,10 +3534,31 @@ declare function isOnce(value: unknown): value is {
|
|
|
4243
3534
|
};
|
|
4244
3535
|
|
|
4245
3536
|
/**
|
|
4246
|
-
*
|
|
4247
|
-
*
|
|
3537
|
+
* @fileoverview Legacy entry point - WebGL only
|
|
3538
|
+
*
|
|
3539
|
+
* This entry point is for apps that want to use the legacy WebGLRenderer.
|
|
3540
|
+
* No WebGPU features are available from this import path.
|
|
3541
|
+
* Auto-extends THREE with WebGL-only constructors (no node materials).
|
|
3542
|
+
*
|
|
3543
|
+
* Usage:
|
|
3544
|
+
* import { Canvas, useFrame } from '@react-three/fiber/legacy'
|
|
4248
3545
|
*/
|
|
4249
|
-
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
4250
3546
|
|
|
4251
|
-
|
|
4252
|
-
|
|
3547
|
+
/** `useThree` narrowed to legacy state — `state.renderer` is a `WebGLRenderer`. */
|
|
3548
|
+
type UseThreeLegacy = <T = LegacyRootState>(selector?: (state: LegacyRootState) => T, equalityFn?: <U>(state: U, newState: U) => boolean) => T;
|
|
3549
|
+
/** `useFrame` narrowed to legacy state — the callback's `state.renderer` is a `WebGLRenderer`. */
|
|
3550
|
+
type UseFrameLegacy = (callback?: FrameCallback$1<LegacyRootState>, priorityOrOptions?: number | UseFrameNextOptions) => FrameNextControls;
|
|
3551
|
+
declare const useThree: UseThreeLegacy;
|
|
3552
|
+
declare const useFrame: UseFrameLegacy;
|
|
3553
|
+
|
|
3554
|
+
/** Canvas props on the legacy entry: `onCreated` receives `LegacyRootState`. */
|
|
3555
|
+
type LegacyCanvasProps = Omit<CanvasProps, 'onCreated'> & {
|
|
3556
|
+
/** Callback after the canvas has rendered (but not yet committed); `state.renderer` is a `WebGLRenderer` */
|
|
3557
|
+
onCreated?: (state: LegacyRootState) => void;
|
|
3558
|
+
};
|
|
3559
|
+
|
|
3560
|
+
/** `Canvas` narrowed to legacy state — the same component, `onCreated` typed against `LegacyRootState`. */
|
|
3561
|
+
declare const Canvas: (props: LegacyCanvasProps) => JSX.Element;
|
|
3562
|
+
|
|
3563
|
+
export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, registerRootExtension, removeInteractivity, resolve, setRenderOverride, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
|
|
3564
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, Camera, CameraProps, LegacyCanvasProps as 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, LegacyCanvasProps, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootExtension, LegacyRootState as RootState, RootStore, SetBlock, Size, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseFrameLegacy, UseTextureOptions, UseTexturesReturn, UseThreeLegacy, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|