@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/index.d.cts
CHANGED
|
@@ -1,16 +1,18 @@
|
|
|
1
|
-
import * as
|
|
2
|
-
import
|
|
1
|
+
import * as three_examples_jsm_inspector_Inspector_js from 'three/examples/jsm/inspector/Inspector.js';
|
|
2
|
+
import * as webgpu from 'three/webgpu';
|
|
3
|
+
import { CubeRenderTarget, RenderTarget, WebGPURenderer, CanvasTarget, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Object3D, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Frustum, OrthographicCamera } from 'three/webgpu';
|
|
3
4
|
import * as THREE$1 from 'three';
|
|
4
|
-
import { WebGLRenderTarget, WebGLRenderer, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
|
|
5
|
+
import { WebGLCubeRenderTarget, WebGLRenderTarget, WebGLRenderer, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
|
|
5
6
|
import { WebGLRendererParameters } from 'three/src/renderers/WebGLRenderer.js';
|
|
6
7
|
import { Inspector } from 'three/addons/inspector/Inspector.js';
|
|
7
8
|
import * as React$1 from 'react';
|
|
8
9
|
import { ReactNode, Component, RefObject, JSX } from 'react';
|
|
9
10
|
import { StoreApi } from 'zustand';
|
|
10
11
|
import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
|
|
12
|
+
import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
|
|
13
|
+
export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
|
|
11
14
|
import { Options } from 'react-use-measure';
|
|
12
15
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
13
|
-
import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
|
|
14
16
|
import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
|
|
15
17
|
|
|
16
18
|
function _mergeNamespaces(n, m) {
|
|
@@ -46,16 +48,23 @@ function _mergeNamespaces(n, m) {
|
|
|
46
48
|
declare const R3F_BUILD_LEGACY = true;
|
|
47
49
|
declare const R3F_BUILD_WEBGPU = true;
|
|
48
50
|
|
|
51
|
+
/** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
|
|
52
|
+
declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
|
|
53
|
+
|
|
49
54
|
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
50
55
|
__proto__: null,
|
|
56
|
+
CubeRenderTarget: CubeRenderTarget,
|
|
57
|
+
CubeRenderTargetCompat: CubeRenderTarget,
|
|
51
58
|
Inspector: Inspector,
|
|
52
59
|
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
53
60
|
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
54
61
|
RenderTargetCompat: RenderTarget,
|
|
62
|
+
WebGLCubeRenderTarget: WebGLCubeRenderTarget,
|
|
55
63
|
WebGLRenderTarget: WebGLRenderTarget,
|
|
56
64
|
WebGLRenderer: WebGLRenderer,
|
|
57
|
-
WebGLRendererParameters: WebGLRendererParameters
|
|
58
|
-
|
|
65
|
+
WebGLRendererParameters: WebGLRendererParameters,
|
|
66
|
+
loadInspector: loadInspector
|
|
67
|
+
}, [webgpu]);
|
|
59
68
|
|
|
60
69
|
//* Utility Types ==============================
|
|
61
70
|
|
|
@@ -149,6 +158,8 @@ interface IntersectionEvent<TSourceEvent> extends Intersection {
|
|
|
149
158
|
unprojectedPoint: THREE$1.Vector3
|
|
150
159
|
/** Normalized event coordinates */
|
|
151
160
|
pointer: THREE$1.Vector2
|
|
161
|
+
/** pointerId of the original event for multiple pointer events */
|
|
162
|
+
pointerId: number
|
|
152
163
|
/** Delta between first click and this event */
|
|
153
164
|
delta: number
|
|
154
165
|
/** The ray that pierced it */
|
|
@@ -225,6 +236,18 @@ interface EventHandlers {
|
|
|
225
236
|
type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
|
|
226
237
|
type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
|
|
227
238
|
|
|
239
|
+
/** Configuration for XR pointer registration (controllers/hands) */
|
|
240
|
+
interface XRPointerConfig {
|
|
241
|
+
/** Ray origin (updated each frame by XR system) */
|
|
242
|
+
ray: THREE$1.Ray
|
|
243
|
+
/** Optional: custom compute function for this pointer */
|
|
244
|
+
compute?: (state: RootState) => void
|
|
245
|
+
/** Pointer type identifier */
|
|
246
|
+
type: 'controller' | 'hand' | 'gaze'
|
|
247
|
+
/** Which hand (for controller/hand types) */
|
|
248
|
+
handedness?: 'left' | 'right'
|
|
249
|
+
}
|
|
250
|
+
|
|
228
251
|
interface EventManager<TTarget> {
|
|
229
252
|
/** Determines if the event layer is active */
|
|
230
253
|
enabled: boolean
|
|
@@ -244,8 +267,21 @@ interface EventManager<TTarget> {
|
|
|
244
267
|
disconnect?: () => void
|
|
245
268
|
/** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
|
|
246
269
|
* explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
|
|
270
|
+
* @param pointerId - Optional pointer ID to update specific pointer only
|
|
247
271
|
*/
|
|
248
|
-
update?: () => void
|
|
272
|
+
update?: (pointerId?: number) => void
|
|
273
|
+
/** Defer pointer move raycasting to frame start (default: true) */
|
|
274
|
+
frameTimedRaycasts?: boolean
|
|
275
|
+
/** Always fire raycaster immediately on scroll events (default: true) */
|
|
276
|
+
alwaysFireOnScroll?: boolean
|
|
277
|
+
/** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
|
|
278
|
+
updateOnFrame?: boolean
|
|
279
|
+
/** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
|
|
280
|
+
flush?: () => void
|
|
281
|
+
/** Register an XR pointer (controller/hand). Returns assigned pointerId */
|
|
282
|
+
registerPointer?: (config: XRPointerConfig) => number
|
|
283
|
+
/** Unregister an XR pointer */
|
|
284
|
+
unregisterPointer?: (pointerId: number) => void
|
|
249
285
|
}
|
|
250
286
|
|
|
251
287
|
interface PointerCaptureTarget {
|
|
@@ -265,228 +301,33 @@ interface VisibilityEntry {
|
|
|
265
301
|
}
|
|
266
302
|
|
|
267
303
|
//* Scheduler Types (useFrame) ==============================
|
|
304
|
+
//
|
|
305
|
+
// The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
|
|
306
|
+
// This file re-exports them and layers r3f's RootState-aware frame state on top,
|
|
307
|
+
// so existing `#types` imports across the codebase keep resolving unchanged.
|
|
268
308
|
|
|
269
309
|
|
|
270
310
|
|
|
271
|
-
//
|
|
272
|
-
|
|
273
|
-
/**
|
|
274
|
-
* Options for useFrame hook
|
|
275
|
-
*/
|
|
276
|
-
interface UseFrameNextOptions {
|
|
277
|
-
/** Optional stable id for the job. Auto-generated if not provided */
|
|
278
|
-
id?: string
|
|
279
|
-
/** Named phase to run in. Default: 'update' */
|
|
280
|
-
phase?: string
|
|
281
|
-
/** Run before this phase or job id */
|
|
282
|
-
before?: string | string[]
|
|
283
|
-
/** Run after this phase or job id */
|
|
284
|
-
after?: string | string[]
|
|
285
|
-
/** Priority within phase. Higher runs first. Default: 0 */
|
|
286
|
-
priority?: number
|
|
287
|
-
/** Max frames per second for this job */
|
|
288
|
-
fps?: number
|
|
289
|
-
/** If true, skip frames when behind. If false, try to catch up. Default: true */
|
|
290
|
-
drop?: boolean
|
|
291
|
-
/** Enable/disable without unregistering. Default: true */
|
|
292
|
-
enabled?: boolean
|
|
293
|
-
}
|
|
294
|
-
|
|
295
|
-
/** Alias for UseFrameNextOptions */
|
|
296
|
-
type UseFrameOptions = UseFrameNextOptions
|
|
297
|
-
|
|
298
|
-
/**
|
|
299
|
-
* Options for addPhase
|
|
300
|
-
*/
|
|
301
|
-
interface AddPhaseOptions {
|
|
302
|
-
/** Insert this phase before the specified phase */
|
|
303
|
-
before?: string
|
|
304
|
-
/** Insert this phase after the specified phase */
|
|
305
|
-
after?: string
|
|
306
|
-
}
|
|
307
|
-
|
|
308
|
-
// Frame State --------------------------------
|
|
309
|
-
|
|
310
|
-
/**
|
|
311
|
-
* Timing-only state for independent/outside mode (no RootState)
|
|
312
|
-
*/
|
|
313
|
-
interface FrameTimingState {
|
|
314
|
-
/** High-resolution timestamp from RAF (ms) */
|
|
315
|
-
time: number
|
|
316
|
-
/** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
|
|
317
|
-
delta: number
|
|
318
|
-
/** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
|
|
319
|
-
elapsed: number
|
|
320
|
-
/** Incrementing frame counter */
|
|
321
|
-
frame: number
|
|
322
|
-
}
|
|
311
|
+
// Frame State (r3f-specific) --------------------------------
|
|
323
312
|
|
|
324
313
|
/**
|
|
325
|
-
* State passed to useFrame callbacks (extends RootState with timing)
|
|
314
|
+
* State passed to useFrame callbacks (extends RootState with timing).
|
|
326
315
|
*/
|
|
327
316
|
interface FrameNextState extends RootState, FrameTimingState {}
|
|
328
317
|
|
|
329
318
|
/** Alias for FrameNextState */
|
|
330
319
|
type FrameState = FrameNextState
|
|
331
320
|
|
|
332
|
-
//
|
|
321
|
+
// Callback Types (r3f-specific) --------------------------------
|
|
333
322
|
|
|
334
323
|
/**
|
|
335
|
-
*
|
|
324
|
+
* Callback function for useFrame. Receives the full r3f RootState plus timing.
|
|
336
325
|
*/
|
|
337
|
-
|
|
338
|
-
/** State provider for callbacks. Optional in independent mode. */
|
|
339
|
-
getState?: () => any
|
|
340
|
-
/** Error handler for job errors. Falls back to console.error if not provided. */
|
|
341
|
-
onError?: (error: Error) => void
|
|
342
|
-
}
|
|
343
|
-
|
|
344
|
-
// Callback Types --------------------------------
|
|
345
|
-
|
|
346
|
-
/**
|
|
347
|
-
* Callback function for useFrame
|
|
348
|
-
*/
|
|
349
|
-
type FrameNextCallback = (state: FrameNextState, delta: number) => void
|
|
326
|
+
type FrameNextCallback = FrameCallback$1<RootState>
|
|
350
327
|
|
|
351
328
|
/** Alias for FrameNextCallback */
|
|
352
329
|
type FrameCallback = FrameNextCallback
|
|
353
330
|
|
|
354
|
-
// Controls returned from useFrame --------------------------------
|
|
355
|
-
|
|
356
|
-
/**
|
|
357
|
-
* Controls object returned from useFrame hook
|
|
358
|
-
*/
|
|
359
|
-
interface FrameNextControls {
|
|
360
|
-
/** The job's unique ID */
|
|
361
|
-
id: string
|
|
362
|
-
/** Access to the global scheduler for frame loop control */
|
|
363
|
-
scheduler: SchedulerApi
|
|
364
|
-
/** Manually step this job only (bypasses FPS limiting) */
|
|
365
|
-
step(timestamp?: number): void
|
|
366
|
-
/** Manually step ALL jobs in the scheduler */
|
|
367
|
-
stepAll(timestamp?: number): void
|
|
368
|
-
/** Pause this job (set enabled=false) */
|
|
369
|
-
pause(): void
|
|
370
|
-
/** Resume this job (set enabled=true) */
|
|
371
|
-
resume(): void
|
|
372
|
-
/** Reactive paused state - automatically triggers re-render when changed */
|
|
373
|
-
isPaused: boolean
|
|
374
|
-
}
|
|
375
|
-
|
|
376
|
-
/** Alias for FrameNextControls */
|
|
377
|
-
type FrameControls = FrameNextControls
|
|
378
|
-
|
|
379
|
-
// Scheduler Interface --------------------------------
|
|
380
|
-
|
|
381
|
-
/**
|
|
382
|
-
* Public interface for the global Scheduler
|
|
383
|
-
*/
|
|
384
|
-
interface SchedulerApi {
|
|
385
|
-
//* Phase Management --------------------------------
|
|
386
|
-
|
|
387
|
-
/** Add a named phase to the scheduler */
|
|
388
|
-
addPhase(name: string, options?: AddPhaseOptions): void
|
|
389
|
-
/** Get the ordered list of phase names */
|
|
390
|
-
readonly phases: string[]
|
|
391
|
-
/** Check if a phase exists */
|
|
392
|
-
hasPhase(name: string): boolean
|
|
393
|
-
|
|
394
|
-
//* Root Management --------------------------------
|
|
395
|
-
|
|
396
|
-
/** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
|
|
397
|
-
registerRoot(id: string, options?: RootOptions): () => void
|
|
398
|
-
/** Unregister a root */
|
|
399
|
-
unregisterRoot(id: string): void
|
|
400
|
-
/** Generate a unique root ID */
|
|
401
|
-
generateRootId(): string
|
|
402
|
-
/** Get the number of registered roots */
|
|
403
|
-
getRootCount(): number
|
|
404
|
-
/** Check if any root is registered and ready */
|
|
405
|
-
readonly isReady: boolean
|
|
406
|
-
/** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
|
|
407
|
-
onRootReady(callback: () => void): () => void
|
|
408
|
-
|
|
409
|
-
//* Job Registration --------------------------------
|
|
410
|
-
|
|
411
|
-
/** Register a job with the scheduler (returns unsubscribe function) */
|
|
412
|
-
register(
|
|
413
|
-
callback: FrameNextCallback,
|
|
414
|
-
options?: {
|
|
415
|
-
id?: string
|
|
416
|
-
rootId?: string
|
|
417
|
-
phase?: string
|
|
418
|
-
before?: string | string[]
|
|
419
|
-
after?: string | string[]
|
|
420
|
-
priority?: number
|
|
421
|
-
fps?: number
|
|
422
|
-
drop?: boolean
|
|
423
|
-
enabled?: boolean
|
|
424
|
-
},
|
|
425
|
-
): () => void
|
|
426
|
-
/** Update a job's options */
|
|
427
|
-
updateJob(
|
|
428
|
-
id: string,
|
|
429
|
-
options: {
|
|
430
|
-
priority?: number
|
|
431
|
-
fps?: number
|
|
432
|
-
drop?: boolean
|
|
433
|
-
enabled?: boolean
|
|
434
|
-
phase?: string
|
|
435
|
-
before?: string | string[]
|
|
436
|
-
after?: string | string[]
|
|
437
|
-
},
|
|
438
|
-
): void
|
|
439
|
-
/** Unregister a job by ID */
|
|
440
|
-
unregister(id: string, rootId?: string): void
|
|
441
|
-
/** Get the number of registered jobs */
|
|
442
|
-
getJobCount(): number
|
|
443
|
-
/** Get all job IDs */
|
|
444
|
-
getJobIds(): string[]
|
|
445
|
-
|
|
446
|
-
//* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
|
|
447
|
-
|
|
448
|
-
/** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
|
|
449
|
-
registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
|
|
450
|
-
|
|
451
|
-
//* Idle Callbacks (for legacy addTail) --------------------------------
|
|
452
|
-
|
|
453
|
-
/** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
|
|
454
|
-
onIdle(callback: (timestamp: number) => void): () => void
|
|
455
|
-
|
|
456
|
-
//* Frame Loop Control --------------------------------
|
|
457
|
-
|
|
458
|
-
/** Start the scheduler loop */
|
|
459
|
-
start(): void
|
|
460
|
-
/** Stop the scheduler loop */
|
|
461
|
-
stop(): void
|
|
462
|
-
/** Check if the scheduler is running */
|
|
463
|
-
readonly isRunning: boolean
|
|
464
|
-
/** Get/set the frameloop mode ('always', 'demand', 'never') */
|
|
465
|
-
frameloop: Frameloop
|
|
466
|
-
/** Independent mode - runs without Canvas, callbacks receive timing-only state */
|
|
467
|
-
independent: boolean
|
|
468
|
-
|
|
469
|
-
//* Manual Stepping --------------------------------
|
|
470
|
-
|
|
471
|
-
/** Manually step all jobs once (for frameloop='never' or testing) */
|
|
472
|
-
step(timestamp?: number): void
|
|
473
|
-
/** Manually step a single job by ID */
|
|
474
|
-
stepJob(id: string, timestamp?: number): void
|
|
475
|
-
/** Request frame(s) to be rendered (for frameloop='demand') */
|
|
476
|
-
invalidate(frames?: number): void
|
|
477
|
-
|
|
478
|
-
//* Per-Job Control --------------------------------
|
|
479
|
-
|
|
480
|
-
/** Check if a job is paused */
|
|
481
|
-
isJobPaused(id: string): boolean
|
|
482
|
-
/** Pause a job */
|
|
483
|
-
pauseJob(id: string): void
|
|
484
|
-
/** Resume a job */
|
|
485
|
-
resumeJob(id: string): void
|
|
486
|
-
/** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
|
|
487
|
-
subscribeJobState(id: string, listener: () => void): () => void
|
|
488
|
-
}
|
|
489
|
-
|
|
490
331
|
//* Renderer Types ========================================
|
|
491
332
|
|
|
492
333
|
/** Default renderer type - union of WebGL and WebGPU renderers */
|
|
@@ -500,6 +341,18 @@ type Subscription = {
|
|
|
500
341
|
store: RootStore
|
|
501
342
|
}
|
|
502
343
|
|
|
344
|
+
/** Per-pointer state for multi-touch and XR support */
|
|
345
|
+
type PointerState = {
|
|
346
|
+
/** Objects currently hovered by this pointer */
|
|
347
|
+
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
348
|
+
/** Objects capturing this pointer */
|
|
349
|
+
captured: Map<THREE$1.Object3D, PointerCaptureTarget>
|
|
350
|
+
/** Initial click position [x, y] */
|
|
351
|
+
initialClick: [x: number, y: number]
|
|
352
|
+
/** Objects hit on initial click */
|
|
353
|
+
initialHits: THREE$1.Object3D[]
|
|
354
|
+
}
|
|
355
|
+
|
|
503
356
|
type Dpr = number | [min: number, max: number]
|
|
504
357
|
|
|
505
358
|
interface Size {
|
|
@@ -541,12 +394,21 @@ interface Performance {
|
|
|
541
394
|
|
|
542
395
|
interface InternalState {
|
|
543
396
|
interaction: THREE$1.Object3D[]
|
|
544
|
-
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
545
397
|
subscribers: Subscription[]
|
|
398
|
+
/** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
|
|
399
|
+
pointerMap: Map<number, PointerState>
|
|
400
|
+
/** Pointers needing raycast this frame (used with frameTimedRaycasts) */
|
|
401
|
+
pointerDirty: Map<number, DomEvent>
|
|
402
|
+
/** Last event received (for events.update() compatibility) */
|
|
403
|
+
lastEvent: React$1.RefObject<DomEvent | null>
|
|
404
|
+
/** @deprecated Use pointerMap.get(pointerId).hovered instead */
|
|
405
|
+
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
406
|
+
/** @deprecated Use pointerMap.get(pointerId).captured instead */
|
|
546
407
|
capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
|
|
408
|
+
/** @deprecated Use pointerMap.get(pointerId).initialClick instead */
|
|
547
409
|
initialClick: [x: number, y: number]
|
|
410
|
+
/** @deprecated Use pointerMap.get(pointerId).initialHits instead */
|
|
548
411
|
initialHits: THREE$1.Object3D[]
|
|
549
|
-
lastEvent: React$1.RefObject<DomEvent | null>
|
|
550
412
|
/** Visibility event registry (onFramed, onOccluded, onVisible) */
|
|
551
413
|
visibilityRegistry: Map<string, VisibilityEntry>
|
|
552
414
|
/** Whether occlusion queries are enabled (WebGPU only) */
|
|
@@ -565,6 +427,12 @@ interface InternalState {
|
|
|
565
427
|
actualRenderer: R3FRenderer
|
|
566
428
|
/** Global scheduler reference (for useFrame hook) */
|
|
567
429
|
scheduler: SchedulerApi | null
|
|
430
|
+
/**
|
|
431
|
+
* Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
|
|
432
|
+
* `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
|
|
433
|
+
* render-phase takeover. Used by `useRenderPipeline`.
|
|
434
|
+
*/
|
|
435
|
+
renderOverride?: (() => void) | null
|
|
568
436
|
/** This root's unique ID in the global scheduler */
|
|
569
437
|
rootId?: string
|
|
570
438
|
/** Function to unregister this root from the global scheduler */
|
|
@@ -572,14 +440,31 @@ interface InternalState {
|
|
|
572
440
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
573
441
|
container?: THREE$1.Object3D
|
|
574
442
|
/**
|
|
575
|
-
* CanvasTarget
|
|
576
|
-
*
|
|
443
|
+
* The CanvasTarget this root sizes and renders through.
|
|
444
|
+
*
|
|
445
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
446
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
447
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
448
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
449
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
577
450
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
578
451
|
*/
|
|
579
452
|
canvasTarget?: CanvasTarget
|
|
453
|
+
/**
|
|
454
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
455
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
456
|
+
*
|
|
457
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
458
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
459
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
460
|
+
* invalidate some other canvas's descriptor instead.
|
|
461
|
+
*
|
|
462
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
463
|
+
*/
|
|
464
|
+
canvasTargetSizeDirty?: boolean
|
|
580
465
|
/**
|
|
581
466
|
* Whether multi-canvas rendering is active.
|
|
582
|
-
* True when any canvas uses `
|
|
467
|
+
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
583
468
|
* When true, setCanvasTarget is called before each render.
|
|
584
469
|
*/
|
|
585
470
|
isMultiCanvas?: boolean
|
|
@@ -615,12 +500,13 @@ interface RootState {
|
|
|
615
500
|
/** Get current state */
|
|
616
501
|
get: StoreApi<RootState>['getState']
|
|
617
502
|
/**
|
|
618
|
-
*
|
|
503
|
+
* The store of the canvas that owns this root's renderer.
|
|
619
504
|
* - For primary/independent canvases: points to its own store (self-reference)
|
|
620
505
|
* - For secondary canvases: points to the primary canvas's store
|
|
506
|
+
* - Portals copy it from their parent
|
|
621
507
|
*
|
|
622
|
-
*
|
|
623
|
-
*
|
|
508
|
+
* Anything shared per renderer rather than per canvas (e.g. @react-three/tsl's resources)
|
|
509
|
+
* resolves through it.
|
|
624
510
|
*/
|
|
625
511
|
primaryStore: RootStore
|
|
626
512
|
/** @deprecated Use `renderer` instead. The instance of the renderer (typed as WebGLRenderer for backwards compat) */
|
|
@@ -677,24 +563,16 @@ interface RootState {
|
|
|
677
563
|
setSize: (width?: number, height?: number, top?: number, left?: number) => void
|
|
678
564
|
/** Shortcut to manual setting the pixel ratio */
|
|
679
565
|
setDpr: (dpr: Dpr) => void
|
|
680
|
-
/** Shortcut to setting frameloop flags */
|
|
681
|
-
setFrameloop: (frameloop
|
|
566
|
+
/** Shortcut to setting frameloop flags. No args resets to 'always'. */
|
|
567
|
+
setFrameloop: (frameloop?: Frameloop) => void
|
|
682
568
|
/** Set error state to propagate to error boundary */
|
|
683
569
|
setError: (error: Error | null) => void
|
|
684
570
|
/** Current error state (null when no error) */
|
|
685
571
|
error: Error | null
|
|
686
|
-
/** Global
|
|
687
|
-
|
|
688
|
-
/**
|
|
689
|
-
|
|
690
|
-
/** Global TSL texture nodes - use useTextures() hook for operations */
|
|
691
|
-
textures: Map<string, any>
|
|
692
|
-
/** WebGPU PostProcessing instance - use usePostProcessing() hook */
|
|
693
|
-
postProcessing: any | null // THREE.PostProcessing when available
|
|
694
|
-
/** Global TSL pass nodes for post-processing - use usePostProcessing() hook */
|
|
695
|
-
passes: Record<string, any>
|
|
696
|
-
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
697
|
-
_hmrVersion: number
|
|
572
|
+
/** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
|
|
573
|
+
textures: Map<string, THREE$1.Texture>
|
|
574
|
+
/** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
|
|
575
|
+
_textureRefs: Map<string, number>
|
|
698
576
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
699
577
|
_sizeImperative: boolean
|
|
700
578
|
/** Internal: stored size props from Canvas for reset functionality */
|
|
@@ -741,6 +619,20 @@ interface Renderer {
|
|
|
741
619
|
render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
|
|
742
620
|
}
|
|
743
621
|
|
|
622
|
+
//* Color Management Config ==============================
|
|
623
|
+
|
|
624
|
+
/**
|
|
625
|
+
* Color management configuration shared by both WebGL and WebGPU renderers.
|
|
626
|
+
*/
|
|
627
|
+
interface ColorManagementConfig {
|
|
628
|
+
/**
|
|
629
|
+
* Color space assigned to 8-bit input textures (color maps).
|
|
630
|
+
* Defaults to sRGB. Most textures are authored in sRGB.
|
|
631
|
+
* @default THREE.SRGBColorSpace
|
|
632
|
+
*/
|
|
633
|
+
textureColorSpace?: THREE$1.ColorSpace
|
|
634
|
+
}
|
|
635
|
+
|
|
744
636
|
//* WebGL Renderer Props ==============================
|
|
745
637
|
|
|
746
638
|
type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
|
|
@@ -751,7 +643,7 @@ type GLProps =
|
|
|
751
643
|
| Renderer
|
|
752
644
|
| ((defaultProps: DefaultGLProps) => Renderer)
|
|
753
645
|
| ((defaultProps: DefaultGLProps) => Promise<Renderer>)
|
|
754
|
-
| Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
|
|
646
|
+
| (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
|
|
755
647
|
|
|
756
648
|
//* WebGPU Renderer Props ==============================
|
|
757
649
|
|
|
@@ -766,20 +658,27 @@ type DefaultRendererProps = {
|
|
|
766
658
|
*/
|
|
767
659
|
interface CanvasSchedulerConfig {
|
|
768
660
|
/**
|
|
769
|
-
*
|
|
770
|
-
* Pass the `id` of another canvas.
|
|
661
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
771
662
|
*/
|
|
772
|
-
|
|
663
|
+
before?: string | string[]
|
|
773
664
|
/**
|
|
774
|
-
*
|
|
665
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
666
|
+
*/
|
|
667
|
+
after?: string | string[]
|
|
668
|
+
/**
|
|
669
|
+
* Numeric root order. Lower values run first.
|
|
670
|
+
*/
|
|
671
|
+
order?: number
|
|
672
|
+
/**
|
|
673
|
+
* Limit this Canvas's default render job (frames per second).
|
|
775
674
|
*/
|
|
776
675
|
fps?: number
|
|
777
676
|
}
|
|
778
677
|
|
|
779
678
|
/**
|
|
780
|
-
* Extended renderer configuration for multi-canvas support.
|
|
679
|
+
* Extended renderer configuration for multi-canvas support and color management.
|
|
781
680
|
*/
|
|
782
|
-
interface RendererConfigExtended {
|
|
681
|
+
interface RendererConfigExtended extends ColorManagementConfig {
|
|
783
682
|
/** Share renderer from another canvas (WebGPU only) */
|
|
784
683
|
primaryCanvas?: string
|
|
785
684
|
/** Canvas-level scheduler options */
|
|
@@ -844,8 +743,6 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
844
743
|
* @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
|
|
845
744
|
*/
|
|
846
745
|
shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
|
|
847
|
-
/** Color space assigned to 8-bit input textures (color maps). Defaults to sRGB. Most textures are authored in sRGB. */
|
|
848
|
-
textureColorSpace?: THREE$1.ColorSpace
|
|
849
746
|
/** Creates an orthographic camera */
|
|
850
747
|
orthographic?: boolean
|
|
851
748
|
/**
|
|
@@ -860,14 +757,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
860
757
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
861
758
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
862
759
|
dpr?: Dpr
|
|
863
|
-
/**
|
|
864
|
-
|
|
760
|
+
/**
|
|
761
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
762
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
763
|
+
*/
|
|
764
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
865
765
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
866
766
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
867
767
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
868
768
|
camera?: CameraProps
|
|
869
769
|
/** An R3F event manager to manage elements' pointer events */
|
|
870
|
-
events?: (store: RootStore) => EventManager<
|
|
770
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
871
771
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
872
772
|
onCreated?: (state: RootState) => void
|
|
873
773
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -956,7 +856,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
|
|
|
956
856
|
object?: T
|
|
957
857
|
dispose?: null
|
|
958
858
|
attach?: AttachType<T>
|
|
959
|
-
onUpdate?: (self: T) => void
|
|
960
859
|
}
|
|
961
860
|
|
|
962
861
|
interface Instance<O = any> {
|
|
@@ -971,8 +870,6 @@ interface Instance<O = any> {
|
|
|
971
870
|
attach?: AttachType<O>
|
|
972
871
|
previousAttach?: any
|
|
973
872
|
isHidden: boolean
|
|
974
|
-
/** Deferred ref props to apply in commitMount */
|
|
975
|
-
deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
|
|
976
873
|
/** Set of props that have been applied via once() */
|
|
977
874
|
appliedOnce?: Set<string>
|
|
978
875
|
}
|
|
@@ -1098,7 +995,7 @@ interface CanvasProps
|
|
|
1098
995
|
*/
|
|
1099
996
|
resize?: Options
|
|
1100
997
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1101
|
-
eventSource?:
|
|
998
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1102
999
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1103
1000
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1104
1001
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1206,329 +1103,6 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1206
1103
|
|
|
1207
1104
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1208
1105
|
|
|
1209
|
-
//* Global Types ==============================
|
|
1210
|
-
|
|
1211
|
-
declare global {
|
|
1212
|
-
/** Uniform node type - a Node with a value property (matches Three.js UniformNode) */
|
|
1213
|
-
interface UniformNode<T = unknown> extends Node {
|
|
1214
|
-
value: T
|
|
1215
|
-
}
|
|
1216
|
-
|
|
1217
|
-
/**
|
|
1218
|
-
* ShaderCallable - the return type of Fn()
|
|
1219
|
-
* A callable shader function node that can be invoked with parameters.
|
|
1220
|
-
* The function returns a ShaderNodeObject when called.
|
|
1221
|
-
*
|
|
1222
|
-
* @example
|
|
1223
|
-
* ```tsx
|
|
1224
|
-
* // Define a shader function
|
|
1225
|
-
* const blendColorFn = Fn(([color1, color2, factor]) => {
|
|
1226
|
-
* return mix(color1, color2, factor)
|
|
1227
|
-
* })
|
|
1228
|
-
*
|
|
1229
|
-
* // Type when retrieving from nodes store
|
|
1230
|
-
* const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
|
|
1231
|
-
*
|
|
1232
|
-
* // Or with specific return type
|
|
1233
|
-
* const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
|
|
1234
|
-
* ```
|
|
1235
|
-
*/
|
|
1236
|
-
type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
|
|
1237
|
-
|
|
1238
|
-
/**
|
|
1239
|
-
* ShaderNodeRef - a ShaderNodeObject wrapper around a Node
|
|
1240
|
-
* This is the common return type for TSL operations (add, mul, sin, etc.)
|
|
1241
|
-
*
|
|
1242
|
-
* @example
|
|
1243
|
-
* ```tsx
|
|
1244
|
-
* const { wobble } = nodes as { wobble: ShaderNodeRef }
|
|
1245
|
-
* ```
|
|
1246
|
-
*/
|
|
1247
|
-
type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
|
|
1248
|
-
|
|
1249
|
-
/**
|
|
1250
|
-
* TSLNodeType - Union of all common TSL node types
|
|
1251
|
-
* Used by ScopedStore to properly type node access from the store.
|
|
1252
|
-
*
|
|
1253
|
-
* Includes:
|
|
1254
|
-
* - Node: base Three.js node type
|
|
1255
|
-
* - ShaderCallable: function nodes created with Fn()
|
|
1256
|
-
* - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
|
|
1257
|
-
*
|
|
1258
|
-
* @example
|
|
1259
|
-
* ```tsx
|
|
1260
|
-
* // In useLocalNodes, nodes are typed as TSLNodeType
|
|
1261
|
-
* const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
|
|
1262
|
-
* positionNode: nodes.myPosition, // Works - Node is in union
|
|
1263
|
-
* blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
|
|
1264
|
-
* }))
|
|
1265
|
-
*
|
|
1266
|
-
* // Can narrow with type guard or assertion when needed
|
|
1267
|
-
* if (typeof blendColorFn === 'function') {
|
|
1268
|
-
* blendColorFn(someColor, 0.5)
|
|
1269
|
-
* }
|
|
1270
|
-
* ```
|
|
1271
|
-
*/
|
|
1272
|
-
type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
|
|
1273
|
-
|
|
1274
|
-
/** Flat record of uniform nodes (no nested scopes) */
|
|
1275
|
-
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
1276
|
-
|
|
1277
|
-
/**
|
|
1278
|
-
* Uniform store that can contain both root-level uniforms and scoped uniform objects
|
|
1279
|
-
* Used by state.uniforms which has structure like:
|
|
1280
|
-
* { uTime: UniformNode, player: { uHealth: UniformNode }, enemy: { uHealth: UniformNode } }
|
|
1281
|
-
*/
|
|
1282
|
-
type UniformStore = Record<string, UniformNode | UniformRecord>
|
|
1283
|
-
|
|
1284
|
-
/**
|
|
1285
|
-
* Helper to safely access a uniform node from the store.
|
|
1286
|
-
* Use this when accessing state.uniforms to get proper typing.
|
|
1287
|
-
* @example
|
|
1288
|
-
* const uTime = uniforms.uTime as UniformNode<number>
|
|
1289
|
-
* const uColor = uniforms.uColor as UniformNode<import('three/webgpu').Color>
|
|
1290
|
-
*/
|
|
1291
|
-
type GetUniform<T = unknown> = UniformNode<T>
|
|
1292
|
-
|
|
1293
|
-
/**
|
|
1294
|
-
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1295
|
-
* Supports:
|
|
1296
|
-
* - Primitives: number, string (color), boolean
|
|
1297
|
-
* - Three.js types: Color, Vector2/3/4, Matrix3/4, Euler, Quaternion
|
|
1298
|
-
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1299
|
-
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1300
|
-
* - UniformNode: existing uniforms (reused as-is)
|
|
1301
|
-
*/
|
|
1302
|
-
type UniformValue =
|
|
1303
|
-
| number
|
|
1304
|
-
| string
|
|
1305
|
-
| boolean
|
|
1306
|
-
| three_webgpu.Color
|
|
1307
|
-
| three_webgpu.Vector2
|
|
1308
|
-
| three_webgpu.Vector3
|
|
1309
|
-
| three_webgpu.Vector4
|
|
1310
|
-
| three_webgpu.Matrix3
|
|
1311
|
-
| three_webgpu.Matrix4
|
|
1312
|
-
| three_webgpu.Euler
|
|
1313
|
-
| three_webgpu.Quaternion
|
|
1314
|
-
| { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
|
|
1315
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1316
|
-
| UniformNode
|
|
1317
|
-
|
|
1318
|
-
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1319
|
-
type UniformInputRecord = Record<string, UniformValue>
|
|
1320
|
-
}
|
|
1321
|
-
|
|
1322
|
-
//* Module Augmentation ==============================
|
|
1323
|
-
|
|
1324
|
-
declare module 'three/tsl' {
|
|
1325
|
-
/**
|
|
1326
|
-
* Fn with array parameter destructuring
|
|
1327
|
-
* @example Fn(([uv, skew]) => { ... })
|
|
1328
|
-
*/
|
|
1329
|
-
export function Fn<R extends Node = Node>(
|
|
1330
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1331
|
-
): ShaderCallable<R>
|
|
1332
|
-
|
|
1333
|
-
/**
|
|
1334
|
-
* Fn with object parameter destructuring
|
|
1335
|
-
* @example Fn(({ color, intensity }) => { ... })
|
|
1336
|
-
*/
|
|
1337
|
-
export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
|
|
1338
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1339
|
-
): ShaderCallable<R>
|
|
1340
|
-
|
|
1341
|
-
/**
|
|
1342
|
-
* Fn with array params + layout
|
|
1343
|
-
* @example Fn(([a, b]) => { ... }, { layout: [...] })
|
|
1344
|
-
*/
|
|
1345
|
-
export function Fn<R extends Node = Node>(
|
|
1346
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1347
|
-
layout: { layout?: unknown },
|
|
1348
|
-
): ShaderCallable<R>
|
|
1349
|
-
|
|
1350
|
-
/**
|
|
1351
|
-
* Fn with object params + layout
|
|
1352
|
-
*/
|
|
1353
|
-
export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
|
|
1354
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1355
|
-
layout: { layout?: unknown },
|
|
1356
|
-
): ShaderCallable<R>
|
|
1357
|
-
}
|
|
1358
|
-
|
|
1359
|
-
/**
|
|
1360
|
-
* PostProcessing Types for usePostProcessing hook (WebGPU only)
|
|
1361
|
-
*/
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
declare global {
|
|
1366
|
-
/** Pass record - stores TSL pass nodes for post-processing */
|
|
1367
|
-
type PassRecord = Record<string, any>
|
|
1368
|
-
|
|
1369
|
-
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1370
|
-
type PostProcessingSetupCallback = (state: RootState) => PassRecord | void
|
|
1371
|
-
|
|
1372
|
-
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1373
|
-
type PostProcessingMainCallback = (state: RootState) => PassRecord | void
|
|
1374
|
-
|
|
1375
|
-
/** Return type for usePostProcessing hook */
|
|
1376
|
-
interface UsePostProcessingReturn {
|
|
1377
|
-
/** Current passes from state */
|
|
1378
|
-
passes: PassRecord
|
|
1379
|
-
/** PostProcessing instance (null if not initialized) */
|
|
1380
|
-
postProcessing: any | null // THREE.PostProcessing
|
|
1381
|
-
/** Clear all passes from state */
|
|
1382
|
-
clearPasses: () => void
|
|
1383
|
-
/** Reset PostProcessing entirely (clears PP + passes) */
|
|
1384
|
-
reset: () => void
|
|
1385
|
-
/** Re-run setup/main callbacks with current closure values */
|
|
1386
|
-
rebuild: () => void
|
|
1387
|
-
/** True when PostProcessing is configured and ready */
|
|
1388
|
-
isReady: boolean
|
|
1389
|
-
}
|
|
1390
|
-
}
|
|
1391
|
-
|
|
1392
|
-
//* useFrameNext Types ==============================
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
//* Global Type Declarations ==============================
|
|
1397
|
-
|
|
1398
|
-
declare global {
|
|
1399
|
-
// Job --------------------------------
|
|
1400
|
-
|
|
1401
|
-
/**
|
|
1402
|
-
* Internal job representation in the scheduler
|
|
1403
|
-
*/
|
|
1404
|
-
interface Job {
|
|
1405
|
-
/** Unique identifier */
|
|
1406
|
-
id: string
|
|
1407
|
-
/** The callback to execute */
|
|
1408
|
-
callback: FrameNextCallback
|
|
1409
|
-
/** Phase this job belongs to */
|
|
1410
|
-
phase: string
|
|
1411
|
-
/** Run before these phases/job ids */
|
|
1412
|
-
before: Set<string>
|
|
1413
|
-
/** Run after these phases/job ids */
|
|
1414
|
-
after: Set<string>
|
|
1415
|
-
/** Priority within phase (higher first) */
|
|
1416
|
-
priority: number
|
|
1417
|
-
/** Insertion order for deterministic tie-breaking */
|
|
1418
|
-
index: number
|
|
1419
|
-
/** Max FPS for this job (undefined = no limit) */
|
|
1420
|
-
fps?: number
|
|
1421
|
-
/** Drop frames when behind (true) or catch up (false) */
|
|
1422
|
-
drop: boolean
|
|
1423
|
-
/** Last run timestamp (ms) */
|
|
1424
|
-
lastRun?: number
|
|
1425
|
-
/** Whether job is enabled */
|
|
1426
|
-
enabled: boolean
|
|
1427
|
-
/** Internal flag: system jobs (like default render) don't block user render takeover */
|
|
1428
|
-
system?: boolean
|
|
1429
|
-
}
|
|
1430
|
-
|
|
1431
|
-
// Phase Graph --------------------------------
|
|
1432
|
-
|
|
1433
|
-
/**
|
|
1434
|
-
* A node in the phase graph
|
|
1435
|
-
*/
|
|
1436
|
-
interface PhaseNode {
|
|
1437
|
-
/** Phase name */
|
|
1438
|
-
name: string
|
|
1439
|
-
/** Whether this was auto-generated from a before/after constraint */
|
|
1440
|
-
isAutoGenerated: boolean
|
|
1441
|
-
}
|
|
1442
|
-
|
|
1443
|
-
/**
|
|
1444
|
-
* Options for creating a job from hook options
|
|
1445
|
-
*/
|
|
1446
|
-
interface JobOptions {
|
|
1447
|
-
id?: string
|
|
1448
|
-
phase?: string
|
|
1449
|
-
before?: string | string[]
|
|
1450
|
-
after?: string | string[]
|
|
1451
|
-
priority?: number
|
|
1452
|
-
fps?: number
|
|
1453
|
-
drop?: boolean
|
|
1454
|
-
enabled?: boolean
|
|
1455
|
-
}
|
|
1456
|
-
|
|
1457
|
-
// Frame Loop State --------------------------------
|
|
1458
|
-
|
|
1459
|
-
/**
|
|
1460
|
-
* Internal frame loop state
|
|
1461
|
-
*/
|
|
1462
|
-
interface FrameLoopState {
|
|
1463
|
-
/** Whether the loop is running */
|
|
1464
|
-
running: boolean
|
|
1465
|
-
/** Current RAF handle */
|
|
1466
|
-
rafHandle: number | null
|
|
1467
|
-
/** Last frame timestamp in ms (null = uninitialized) */
|
|
1468
|
-
lastTime: number | null
|
|
1469
|
-
/** Frame counter */
|
|
1470
|
-
frameCount: number
|
|
1471
|
-
/** Elapsed time since first frame in ms */
|
|
1472
|
-
elapsedTime: number
|
|
1473
|
-
/** createdAt timestamp in ms */
|
|
1474
|
-
createdAt: number
|
|
1475
|
-
}
|
|
1476
|
-
|
|
1477
|
-
// Root Entry --------------------------------
|
|
1478
|
-
|
|
1479
|
-
/**
|
|
1480
|
-
* Internal representation of a registered root (Canvas).
|
|
1481
|
-
* Tracks jobs and manages rebuild state for this root.
|
|
1482
|
-
* @internal
|
|
1483
|
-
*/
|
|
1484
|
-
interface RootEntry {
|
|
1485
|
-
/** Unique identifier for this root */
|
|
1486
|
-
id: string
|
|
1487
|
-
/** Function to get the root's current state. Returns any to support independent mode. */
|
|
1488
|
-
getState: () => any
|
|
1489
|
-
/** Map of job IDs to Job objects */
|
|
1490
|
-
jobs: Map<string, Job>
|
|
1491
|
-
/** Cached sorted job list for execution order */
|
|
1492
|
-
sortedJobs: Job[]
|
|
1493
|
-
/** Whether sortedJobs needs rebuilding */
|
|
1494
|
-
needsRebuild: boolean
|
|
1495
|
-
}
|
|
1496
|
-
|
|
1497
|
-
/**
|
|
1498
|
-
* Internal representation of a global job (deprecated API).
|
|
1499
|
-
* Global jobs run once per frame, not per-root.
|
|
1500
|
-
* Used by legacy addEffect/addAfterEffect APIs.
|
|
1501
|
-
* @internal
|
|
1502
|
-
* @deprecated Use useFrame with phases instead
|
|
1503
|
-
*/
|
|
1504
|
-
interface GlobalJob {
|
|
1505
|
-
/** Unique identifier for this global job */
|
|
1506
|
-
id: string
|
|
1507
|
-
/** Callback invoked with RAF timestamp in ms */
|
|
1508
|
-
callback: (timestamp: number) => void
|
|
1509
|
-
}
|
|
1510
|
-
|
|
1511
|
-
// HMR Support --------------------------------
|
|
1512
|
-
|
|
1513
|
-
/**
|
|
1514
|
-
* Hot Module Replacement data structure for preserving scheduler state
|
|
1515
|
-
* @internal
|
|
1516
|
-
*/
|
|
1517
|
-
interface HMRData {
|
|
1518
|
-
/** Shared data object for storing values across reloads */
|
|
1519
|
-
data: Record<string, any>
|
|
1520
|
-
/** Optional function to accept HMR updates */
|
|
1521
|
-
accept?: () => void
|
|
1522
|
-
}
|
|
1523
|
-
|
|
1524
|
-
// Default Phases --------------------------------
|
|
1525
|
-
|
|
1526
|
-
/**
|
|
1527
|
-
* Default phase names for the scheduler
|
|
1528
|
-
*/
|
|
1529
|
-
type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
|
|
1530
|
-
}
|
|
1531
|
-
|
|
1532
1106
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
1533
1107
|
|
|
1534
1108
|
interface MathRepresentation {
|
|
@@ -1605,10 +1179,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1605
1179
|
|
|
1606
1180
|
/**
|
|
1607
1181
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1608
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1182
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1183
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1609
1184
|
*/
|
|
1610
1185
|
type NodeProps<P> = {
|
|
1611
|
-
[K in keyof P as P[K] extends
|
|
1186
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1612
1187
|
}
|
|
1613
1188
|
|
|
1614
1189
|
interface ReactProps<P> {
|
|
@@ -1629,11 +1204,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1629
1204
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1630
1205
|
}
|
|
1631
1206
|
|
|
1207
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1208
|
+
type Object3DMethod = NonNullable<
|
|
1209
|
+
{
|
|
1210
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1211
|
+
}[keyof Object3D]
|
|
1212
|
+
>
|
|
1213
|
+
|
|
1632
1214
|
type ThreeExports = typeof THREE
|
|
1633
1215
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1634
1216
|
|
|
1635
1217
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1636
|
-
|
|
1218
|
+
/**
|
|
1219
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1220
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1221
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1222
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1223
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1224
|
+
*/
|
|
1225
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
|
|
1226
|
+
object: object
|
|
1227
|
+
ref?: React.Ref<any>
|
|
1228
|
+
[prop: string]: unknown
|
|
1229
|
+
}
|
|
1637
1230
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1638
1231
|
threeAudio: ThreeElementsImpl['audio']
|
|
1639
1232
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1674,6 +1267,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1674
1267
|
type three_d_Matrix4 = Matrix4;
|
|
1675
1268
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1676
1269
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1270
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1677
1271
|
type three_d_Quaternion = Quaternion;
|
|
1678
1272
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1679
1273
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1688,7 +1282,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1688
1282
|
type three_d_Vector4 = Vector4;
|
|
1689
1283
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1690
1284
|
declare namespace three_d {
|
|
1691
|
-
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 };
|
|
1285
|
+
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 };
|
|
1692
1286
|
}
|
|
1693
1287
|
|
|
1694
1288
|
/**
|
|
@@ -1698,7 +1292,7 @@ declare namespace three_d {
|
|
|
1698
1292
|
* a single WebGPURenderer using Three.js CanvasTarget API.
|
|
1699
1293
|
*
|
|
1700
1294
|
* Primary canvas: Has `id` prop, creates its own renderer, registers here
|
|
1701
|
-
* Secondary canvas: Has `
|
|
1295
|
+
* Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
|
|
1702
1296
|
*/
|
|
1703
1297
|
|
|
1704
1298
|
interface PrimaryCanvasEntry {
|
|
@@ -1766,12 +1360,23 @@ type EnvironmentLoaderProps = {
|
|
|
1766
1360
|
* const texture = useEnvironment({ preset: 'sunset' })
|
|
1767
1361
|
* ```
|
|
1768
1362
|
*/
|
|
1769
|
-
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture
|
|
1363
|
+
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
|
|
1770
1364
|
declare namespace useEnvironment {
|
|
1771
1365
|
var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
|
|
1772
1366
|
var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
|
|
1773
1367
|
}
|
|
1774
|
-
|
|
1368
|
+
/**
|
|
1369
|
+
* Options accepted by `useEnvironment.preload`.
|
|
1370
|
+
*
|
|
1371
|
+
* `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
|
|
1372
|
+
* applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
|
|
1373
|
+
* advertise an option this function silently ignores.
|
|
1374
|
+
*
|
|
1375
|
+
* This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
|
|
1376
|
+
* `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
|
|
1377
|
+
* type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
|
|
1378
|
+
*/
|
|
1379
|
+
type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
|
|
1775
1380
|
type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
|
|
1776
1381
|
|
|
1777
1382
|
/**
|
|
@@ -1815,9 +1420,9 @@ type EnvironmentProps = {
|
|
|
1815
1420
|
blur?: number;
|
|
1816
1421
|
backgroundBlurriness?: number;
|
|
1817
1422
|
backgroundIntensity?: number;
|
|
1818
|
-
backgroundRotation?: Euler
|
|
1423
|
+
backgroundRotation?: Euler;
|
|
1819
1424
|
environmentIntensity?: number;
|
|
1820
|
-
environmentRotation?: Euler
|
|
1425
|
+
environmentRotation?: Euler;
|
|
1821
1426
|
map?: Texture$1;
|
|
1822
1427
|
preset?: PresetsType;
|
|
1823
1428
|
scene?: Scene | React$1.RefObject<Scene>;
|
|
@@ -1901,7 +1506,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
|
|
|
1901
1506
|
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;
|
|
1902
1507
|
declare module '@react-three/fiber' {
|
|
1903
1508
|
interface ThreeElements {
|
|
1904
|
-
groundProjectedEnvImpl: ThreeElement
|
|
1509
|
+
groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
|
|
1905
1510
|
}
|
|
1906
1511
|
}
|
|
1907
1512
|
/**
|
|
@@ -2001,12 +1606,73 @@ declare module '@react-three/fiber' {
|
|
|
2001
1606
|
*/
|
|
2002
1607
|
declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
2003
1608
|
|
|
1609
|
+
/**
|
|
1610
|
+
* Moves every trace of interactivity from one object to its replacement, for reconstruction.
|
|
1611
|
+
*
|
|
1612
|
+
* When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
|
|
1613
|
+
* instance. Removing the old object from the interaction state and registering the new one from
|
|
1614
|
+
* scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
|
|
1615
|
+
* the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
|
|
1616
|
+
* is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
|
|
1617
|
+
* swap the user never asked to see (#3744).
|
|
1618
|
+
*
|
|
1619
|
+
* Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
|
|
1620
|
+
* left alone — releasing and re-acquiring it is precisely the glitch being avoided.
|
|
1621
|
+
*
|
|
1622
|
+
* Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
|
|
1623
|
+
* the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
|
|
1624
|
+
* cannot outlive the object it described.
|
|
1625
|
+
*/
|
|
1626
|
+
declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
|
|
2004
1627
|
declare function removeInteractivity(store: RootStore, object: Object3D): void;
|
|
2005
1628
|
declare function createEvents(store: RootStore): {
|
|
2006
1629
|
handlePointer: (name: string) => (event: DomEvent) => void;
|
|
1630
|
+
flushDeferredPointers: () => void;
|
|
1631
|
+
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
2007
1632
|
};
|
|
2008
1633
|
/** Default R3F event manager for web */
|
|
2009
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1634
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1635
|
+
|
|
1636
|
+
interface RootExtension {
|
|
1637
|
+
/** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
|
|
1638
|
+
* set up are not set up a second time, but get the new entry's dispose and hmr. */
|
|
1639
|
+
name: string;
|
|
1640
|
+
/**
|
|
1641
|
+
* Called once per root, after its renderer exists and before `onCreated` and the first frame.
|
|
1642
|
+
* `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
|
|
1643
|
+
* to the primary canvas. Return fields to merge into the root's state, or nothing.
|
|
1644
|
+
*/
|
|
1645
|
+
setup?(store: RootStore): Partial<RootState> | void;
|
|
1646
|
+
/** Called when a root this extension set up unmounts. */
|
|
1647
|
+
dispose?(store: RootStore): void;
|
|
1648
|
+
/** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
|
|
1649
|
+
hmr?(store: RootStore): void;
|
|
1650
|
+
}
|
|
1651
|
+
/**
|
|
1652
|
+
* Register an extension. It is set up on every live root immediately, and on every root created
|
|
1653
|
+
* afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
|
|
1654
|
+
* it already set up keep its state and still get its dispose when they unmount.
|
|
1655
|
+
*/
|
|
1656
|
+
declare function registerRootExtension(extension: RootExtension): () => void;
|
|
1657
|
+
/**
|
|
1658
|
+
* Point a root's default render job at a different render function, or back at
|
|
1659
|
+
* `renderer.render(scene, camera)` with `null`.
|
|
1660
|
+
*
|
|
1661
|
+
* The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
|
|
1662
|
+
* boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
|
|
1663
|
+
*/
|
|
1664
|
+
declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
|
|
1665
|
+
|
|
1666
|
+
/**
|
|
1667
|
+
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
1668
|
+
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
1669
|
+
*/
|
|
1670
|
+
declare function useStore(): RootStore;
|
|
1671
|
+
/**
|
|
1672
|
+
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
1673
|
+
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
1674
|
+
*/
|
|
1675
|
+
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
2010
1676
|
|
|
2011
1677
|
/**
|
|
2012
1678
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -2019,389 +1685,27 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
|
|
|
2019
1685
|
* Note: this hook's caller must be wrapped with `React.Suspense`
|
|
2020
1686
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
|
|
2021
1687
|
*/
|
|
2022
|
-
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>;
|
|
1688
|
+
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>;
|
|
2023
1689
|
declare namespace useLoader {
|
|
2024
|
-
var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
|
|
2025
|
-
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
|
|
1690
|
+
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;
|
|
1691
|
+
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
|
|
2026
1692
|
var loader: typeof getLoader;
|
|
2027
1693
|
}
|
|
2028
1694
|
|
|
2029
|
-
/**
|
|
2030
|
-
* Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
|
|
2031
|
-
*
|
|
2032
|
-
* Features:
|
|
2033
|
-
* - Single RAF loop for entire application
|
|
2034
|
-
* - Root registration (multiple Canvas support)
|
|
2035
|
-
* - Global phases for addEffect/addAfterEffect (deprecated)
|
|
2036
|
-
* - Per-root job management with phases, priorities, FPS throttling
|
|
2037
|
-
* - onIdle callbacks for addTail (deprecated)
|
|
2038
|
-
* - Demand mode support via invalidate()
|
|
2039
|
-
*/
|
|
2040
|
-
declare class Scheduler {
|
|
2041
|
-
private static readonly INSTANCE_KEY;
|
|
2042
|
-
private static get instance();
|
|
2043
|
-
private static set instance(value);
|
|
2044
|
-
/**
|
|
2045
|
-
* Get the global scheduler instance (creates if doesn't exist).
|
|
2046
|
-
* Uses HMR data to preserve instance across hot reloads.
|
|
2047
|
-
* @returns {Scheduler} The singleton scheduler instance
|
|
2048
|
-
*/
|
|
2049
|
-
static get(): Scheduler;
|
|
2050
|
-
/**
|
|
2051
|
-
* Reset the singleton instance. Stops the loop and clears all state.
|
|
2052
|
-
* Primarily used for testing to ensure clean state between tests.
|
|
2053
|
-
* @returns {void}
|
|
2054
|
-
*/
|
|
2055
|
-
static reset(): void;
|
|
2056
|
-
private roots;
|
|
2057
|
-
private phaseGraph;
|
|
2058
|
-
private loopState;
|
|
2059
|
-
private stoppedTime;
|
|
2060
|
-
private nextRootIndex;
|
|
2061
|
-
private globalBeforeJobs;
|
|
2062
|
-
private globalAfterJobs;
|
|
2063
|
-
private nextGlobalIndex;
|
|
2064
|
-
private idleCallbacks;
|
|
2065
|
-
private nextJobIndex;
|
|
2066
|
-
private jobStateListeners;
|
|
2067
|
-
private pendingFrames;
|
|
2068
|
-
private _frameloop;
|
|
2069
|
-
private _independent;
|
|
2070
|
-
private errorHandler;
|
|
2071
|
-
private rootReadyCallbacks;
|
|
2072
|
-
get phases(): string[];
|
|
2073
|
-
get frameloop(): Frameloop;
|
|
2074
|
-
set frameloop(mode: Frameloop);
|
|
2075
|
-
get isRunning(): boolean;
|
|
2076
|
-
get isReady(): boolean;
|
|
2077
|
-
get independent(): boolean;
|
|
2078
|
-
set independent(value: boolean);
|
|
2079
|
-
constructor();
|
|
2080
|
-
/**
|
|
2081
|
-
* Register a root (Canvas) with the scheduler.
|
|
2082
|
-
* The first root to register starts the RAF loop (if frameloop='always').
|
|
2083
|
-
* @param {string} id - Unique identifier for this root
|
|
2084
|
-
* @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
|
|
2085
|
-
* @returns {() => void} Unsubscribe function to remove this root
|
|
2086
|
-
*/
|
|
2087
|
-
registerRoot(id: string, options?: RootOptions): () => void;
|
|
2088
|
-
/**
|
|
2089
|
-
* Unregister a root from the scheduler.
|
|
2090
|
-
* Cleans up all job state listeners for this root's jobs.
|
|
2091
|
-
* The last root to unregister stops the RAF loop.
|
|
2092
|
-
* @param {string} id - The root ID to unregister
|
|
2093
|
-
* @returns {void}
|
|
2094
|
-
*/
|
|
2095
|
-
unregisterRoot(id: string): void;
|
|
2096
|
-
/**
|
|
2097
|
-
* Subscribe to be notified when a root becomes available.
|
|
2098
|
-
* Fires immediately if a root already exists.
|
|
2099
|
-
* @param {() => void} callback - Function called when first root registers
|
|
2100
|
-
* @returns {() => void} Unsubscribe function
|
|
2101
|
-
*/
|
|
2102
|
-
onRootReady(callback: () => void): () => void;
|
|
2103
|
-
/**
|
|
2104
|
-
* Notify all registered root-ready callbacks.
|
|
2105
|
-
* Called when the first root registers.
|
|
2106
|
-
* @returns {void}
|
|
2107
|
-
* @private
|
|
2108
|
-
*/
|
|
2109
|
-
private notifyRootReady;
|
|
2110
|
-
/**
|
|
2111
|
-
* Ensure a default root exists for independent mode.
|
|
2112
|
-
* Creates a minimal root with no state provider.
|
|
2113
|
-
* @returns {void}
|
|
2114
|
-
* @private
|
|
2115
|
-
*/
|
|
2116
|
-
private ensureDefaultRoot;
|
|
2117
|
-
/**
|
|
2118
|
-
* Trigger error handling for job errors.
|
|
2119
|
-
* Uses the bound error handler if available, otherwise logs to console.
|
|
2120
|
-
* @param {Error} error - The error to handle
|
|
2121
|
-
* @returns {void}
|
|
2122
|
-
*/
|
|
2123
|
-
triggerError(error: Error): void;
|
|
2124
|
-
/**
|
|
2125
|
-
* Add a named phase to the scheduler's execution order.
|
|
2126
|
-
* Marks all roots for rebuild to incorporate the new phase.
|
|
2127
|
-
* @param {string} name - The phase name (e.g., 'physics', 'postprocess')
|
|
2128
|
-
* @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
|
|
2129
|
-
* @returns {void}
|
|
2130
|
-
* @example
|
|
2131
|
-
* scheduler.addPhase('physics', { before: 'update' });
|
|
2132
|
-
* scheduler.addPhase('postprocess', { after: 'render' });
|
|
2133
|
-
*/
|
|
2134
|
-
addPhase(name: string, options?: AddPhaseOptions): void;
|
|
2135
|
-
/**
|
|
2136
|
-
* Check if a phase exists in the scheduler.
|
|
2137
|
-
* @param {string} name - The phase name to check
|
|
2138
|
-
* @returns {boolean} True if the phase exists
|
|
2139
|
-
*/
|
|
2140
|
-
hasPhase(name: string): boolean;
|
|
2141
|
-
/**
|
|
2142
|
-
* Register a global job that runs once per frame (not per-root).
|
|
2143
|
-
* Used internally by deprecated addEffect/addAfterEffect APIs.
|
|
2144
|
-
* @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
|
|
2145
|
-
* @param {string} id - Unique identifier for this global job
|
|
2146
|
-
* @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
|
|
2147
|
-
* @returns {() => void} Unsubscribe function to remove this global job
|
|
2148
|
-
* @deprecated Use useFrame with phases instead
|
|
2149
|
-
*/
|
|
2150
|
-
registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
|
|
2151
|
-
/**
|
|
2152
|
-
* Register an idle callback that fires when the loop stops.
|
|
2153
|
-
* Used internally by deprecated addTail API.
|
|
2154
|
-
* @param {(timestamp: number) => void} callback - Function called when loop becomes idle
|
|
2155
|
-
* @returns {() => void} Unsubscribe function to remove this idle callback
|
|
2156
|
-
* @deprecated Use demand mode with invalidate() instead
|
|
2157
|
-
*/
|
|
2158
|
-
onIdle(callback: (timestamp: number) => void): () => void;
|
|
2159
|
-
/**
|
|
2160
|
-
* Notify all registered idle callbacks.
|
|
2161
|
-
* Called when the loop stops in demand mode.
|
|
2162
|
-
* @param {number} timestamp - The RAF timestamp when idle occurred
|
|
2163
|
-
* @returns {void}
|
|
2164
|
-
* @private
|
|
2165
|
-
*/
|
|
2166
|
-
private notifyIdle;
|
|
2167
|
-
/**
|
|
2168
|
-
* Register a job (frame callback) with a specific root.
|
|
2169
|
-
* This is the core registration method used by useFrame internally.
|
|
2170
|
-
* @param {FrameNextCallback} callback - The function to call each frame
|
|
2171
|
-
* @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
|
|
2172
|
-
* @param {string} [options.rootId] - Target root ID (defaults to first registered root)
|
|
2173
|
-
* @param {string} [options.id] - Unique job ID (auto-generated if not provided)
|
|
2174
|
-
* @param {string} [options.phase] - Execution phase (defaults to 'update')
|
|
2175
|
-
* @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
|
|
2176
|
-
* @param {number} [options.fps] - FPS throttle limit
|
|
2177
|
-
* @param {boolean} [options.drop] - Drop frames when behind (default true)
|
|
2178
|
-
* @param {boolean} [options.enabled] - Whether job is active (default true)
|
|
2179
|
-
* @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
|
|
2180
|
-
* @returns {() => void} Unsubscribe function to remove this job
|
|
2181
|
-
*/
|
|
2182
|
-
register(callback: FrameNextCallback, options?: JobOptions & {
|
|
2183
|
-
rootId?: string;
|
|
2184
|
-
system?: boolean;
|
|
2185
|
-
}): () => void;
|
|
2186
|
-
/**
|
|
2187
|
-
* Unregister a job by its ID.
|
|
2188
|
-
* Searches all roots if rootId is not provided.
|
|
2189
|
-
* @param {string} id - The job ID to unregister
|
|
2190
|
-
* @param {string} [rootId] - Optional root ID to search (searches all if not provided)
|
|
2191
|
-
* @returns {void}
|
|
2192
|
-
*/
|
|
2193
|
-
unregister(id: string, rootId?: string): void;
|
|
2194
|
-
/**
|
|
2195
|
-
* Update a job's options dynamically.
|
|
2196
|
-
* Searches all roots to find the job by ID.
|
|
2197
|
-
* Phase/constraint changes trigger a rebuild of the sorted job list.
|
|
2198
|
-
* @param {string} id - The job ID to update
|
|
2199
|
-
* @param {Partial<JobOptions>} options - The options to update
|
|
2200
|
-
* @returns {void}
|
|
2201
|
-
*/
|
|
2202
|
-
updateJob(id: string, options: Partial<JobOptions>): void;
|
|
2203
|
-
/**
|
|
2204
|
-
* Check if a job is currently paused (disabled).
|
|
2205
|
-
* @param {string} id - The job ID to check
|
|
2206
|
-
* @returns {boolean} True if the job exists and is paused
|
|
2207
|
-
*/
|
|
2208
|
-
isJobPaused(id: string): boolean;
|
|
2209
|
-
/**
|
|
2210
|
-
* Subscribe to state changes for a specific job.
|
|
2211
|
-
* Listener is called when job is paused or resumed.
|
|
2212
|
-
* @param {string} id - The job ID to subscribe to
|
|
2213
|
-
* @param {() => void} listener - Callback invoked on state changes
|
|
2214
|
-
* @returns {() => void} Unsubscribe function
|
|
2215
|
-
*/
|
|
2216
|
-
subscribeJobState(id: string, listener: () => void): () => void;
|
|
2217
|
-
/**
|
|
2218
|
-
* Notify all listeners that a job's state has changed.
|
|
2219
|
-
* @param {string} id - The job ID that changed
|
|
2220
|
-
* @returns {void}
|
|
2221
|
-
* @private
|
|
2222
|
-
*/
|
|
2223
|
-
private notifyJobStateChange;
|
|
2224
|
-
/**
|
|
2225
|
-
* Pause a job by ID (sets enabled=false).
|
|
2226
|
-
* Notifies any subscribed state listeners.
|
|
2227
|
-
* @param {string} id - The job ID to pause
|
|
2228
|
-
* @returns {void}
|
|
2229
|
-
*/
|
|
2230
|
-
pauseJob(id: string): void;
|
|
2231
|
-
/**
|
|
2232
|
-
* Resume a paused job by ID (sets enabled=true).
|
|
2233
|
-
* Resets job timing to prevent frame accumulation.
|
|
2234
|
-
* Notifies any subscribed state listeners.
|
|
2235
|
-
* @param {string} id - The job ID to resume
|
|
2236
|
-
* @returns {void}
|
|
2237
|
-
*/
|
|
2238
|
-
resumeJob(id: string): void;
|
|
2239
|
-
/**
|
|
2240
|
-
* Start the requestAnimationFrame loop.
|
|
2241
|
-
* Resets timing state (elapsedTime, frameCount) on start.
|
|
2242
|
-
* No-op if already running.
|
|
2243
|
-
* @returns {void}
|
|
2244
|
-
*/
|
|
2245
|
-
start(): void;
|
|
2246
|
-
/**
|
|
2247
|
-
* Stop the requestAnimationFrame loop.
|
|
2248
|
-
* Cancels any pending RAF callback.
|
|
2249
|
-
* No-op if not running.
|
|
2250
|
-
* @returns {void}
|
|
2251
|
-
*/
|
|
2252
|
-
stop(): void;
|
|
2253
|
-
/**
|
|
2254
|
-
* Request frames to be rendered in demand mode.
|
|
2255
|
-
* Accumulates pending frames (capped at 60) and starts the loop if not running.
|
|
2256
|
-
* No-op if frameloop is not 'demand'.
|
|
2257
|
-
* @param {number} [frames=1] - Number of frames to request
|
|
2258
|
-
* @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
|
|
2259
|
-
* - `false` (default): Sets pending frames to the specified value (replaces existing count)
|
|
2260
|
-
* - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
|
|
2261
|
-
* @returns {void}
|
|
2262
|
-
* @example
|
|
2263
|
-
* // Request a single frame render
|
|
2264
|
-
* scheduler.invalidate();
|
|
2265
|
-
*
|
|
2266
|
-
* @example
|
|
2267
|
-
* // Request 5 frames (e.g., for animations)
|
|
2268
|
-
* scheduler.invalidate(5);
|
|
2269
|
-
*
|
|
2270
|
-
* @example
|
|
2271
|
-
* // Set pending frames to exactly 3 (don't stack with existing)
|
|
2272
|
-
* scheduler.invalidate(3, false);
|
|
2273
|
-
*
|
|
2274
|
-
* @example
|
|
2275
|
-
* // Add 2 more frames to existing pending count
|
|
2276
|
-
* scheduler.invalidate(2, true);
|
|
2277
|
-
*/
|
|
2278
|
-
invalidate(frames?: number, stackFrames?: boolean): void;
|
|
2279
|
-
/**
|
|
2280
|
-
* Reset timing state for deterministic testing.
|
|
2281
|
-
* Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
|
|
2282
|
-
* @returns {void}
|
|
2283
|
-
*/
|
|
2284
|
-
resetTiming(): void;
|
|
2285
|
-
/**
|
|
2286
|
-
* Manually execute a single frame for all roots.
|
|
2287
|
-
* Useful for frameloop='never' mode or testing scenarios.
|
|
2288
|
-
* @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
|
|
2289
|
-
* @returns {void}
|
|
2290
|
-
* @example
|
|
2291
|
-
* // Manual control mode
|
|
2292
|
-
* scheduler.frameloop = 'never';
|
|
2293
|
-
* scheduler.step(); // Execute one frame
|
|
2294
|
-
*/
|
|
2295
|
-
step(timestamp?: number): void;
|
|
2296
|
-
/**
|
|
2297
|
-
* Manually execute a single job by its ID.
|
|
2298
|
-
* Useful for testing individual job callbacks in isolation.
|
|
2299
|
-
* @param {string} id - The job ID to step
|
|
2300
|
-
* @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
|
|
2301
|
-
* @returns {void}
|
|
2302
|
-
*/
|
|
2303
|
-
stepJob(id: string, timestamp?: number): void;
|
|
2304
|
-
/**
|
|
2305
|
-
* Main RAF loop callback.
|
|
2306
|
-
* Executes frame, handles demand mode, and schedules next frame.
|
|
2307
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2308
|
-
* @returns {void}
|
|
2309
|
-
* @private
|
|
2310
|
-
*/
|
|
2311
|
-
private loop;
|
|
2312
|
-
/**
|
|
2313
|
-
* Execute a single frame across all roots.
|
|
2314
|
-
* Order: globalBefore → each root's jobs → globalAfter
|
|
2315
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2316
|
-
* @returns {void}
|
|
2317
|
-
* @private
|
|
2318
|
-
*/
|
|
2319
|
-
private executeFrame;
|
|
2320
|
-
/**
|
|
2321
|
-
* Run all global jobs from a job map.
|
|
2322
|
-
* Catches and logs errors without stopping execution.
|
|
2323
|
-
* @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
|
|
2324
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2325
|
-
* @returns {void}
|
|
2326
|
-
* @private
|
|
2327
|
-
*/
|
|
2328
|
-
private runGlobalJobs;
|
|
2329
|
-
/**
|
|
2330
|
-
* Execute all jobs for a single root in sorted order.
|
|
2331
|
-
* Rebuilds sorted job list if needed, then dispatches each job.
|
|
2332
|
-
* Errors are caught and propagated via triggerError.
|
|
2333
|
-
* @param {RootEntry} root - The root entry to tick
|
|
2334
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2335
|
-
* @param {number} delta - Time since last frame in seconds
|
|
2336
|
-
* @returns {void}
|
|
2337
|
-
* @private
|
|
2338
|
-
*/
|
|
2339
|
-
private tickRoot;
|
|
2340
|
-
/**
|
|
2341
|
-
* Get the total number of registered jobs across all roots.
|
|
2342
|
-
* Includes both per-root jobs and global before/after jobs.
|
|
2343
|
-
* @returns {number} Total job count
|
|
2344
|
-
*/
|
|
2345
|
-
getJobCount(): number;
|
|
2346
|
-
/**
|
|
2347
|
-
* Get all registered job IDs across all roots.
|
|
2348
|
-
* Includes both per-root jobs and global before/after jobs.
|
|
2349
|
-
* @returns {string[]} Array of all job IDs
|
|
2350
|
-
*/
|
|
2351
|
-
getJobIds(): string[];
|
|
2352
|
-
/**
|
|
2353
|
-
* Get the number of registered roots (Canvas instances).
|
|
2354
|
-
* @returns {number} Number of registered roots
|
|
2355
|
-
*/
|
|
2356
|
-
getRootCount(): number;
|
|
2357
|
-
/**
|
|
2358
|
-
* Check if any user (non-system) jobs are registered in a specific phase.
|
|
2359
|
-
* Used by the default render job to know if a user has taken over rendering.
|
|
2360
|
-
*
|
|
2361
|
-
* @param phase The phase to check
|
|
2362
|
-
* @param rootId Optional root ID to check (checks all roots if not provided)
|
|
2363
|
-
* @returns true if any user jobs exist in the phase
|
|
2364
|
-
*/
|
|
2365
|
-
hasUserJobsInPhase(phase: string, rootId?: string): boolean;
|
|
2366
|
-
/**
|
|
2367
|
-
* Generate a unique root ID for automatic root registration.
|
|
2368
|
-
* @returns {string} A unique root ID in the format 'root_N'
|
|
2369
|
-
*/
|
|
2370
|
-
generateRootId(): string;
|
|
2371
|
-
/**
|
|
2372
|
-
* Generate a unique job ID.
|
|
2373
|
-
* @returns {string} A unique job ID in the format 'job_N'
|
|
2374
|
-
* @private
|
|
2375
|
-
*/
|
|
2376
|
-
private generateJobId;
|
|
2377
|
-
/**
|
|
2378
|
-
* Normalize before/after constraints to a Set.
|
|
2379
|
-
* Handles undefined, single string, or array inputs.
|
|
2380
|
-
* @param {string | string[] | undefined} value - The constraint value(s)
|
|
2381
|
-
* @returns {Set<string>} Normalized Set of constraint strings
|
|
2382
|
-
* @private
|
|
2383
|
-
*/
|
|
2384
|
-
private normalizeConstraints;
|
|
2385
|
-
}
|
|
2386
|
-
/**
|
|
2387
|
-
* Get the global scheduler instance.
|
|
2388
|
-
* Creates one if it doesn't exist.
|
|
2389
|
-
*/
|
|
2390
|
-
declare const getScheduler: () => Scheduler;
|
|
2391
|
-
|
|
2392
1695
|
/**
|
|
2393
1696
|
* Frame hook with phase-based ordering, priority, and FPS throttling.
|
|
2394
1697
|
*
|
|
2395
|
-
*
|
|
2396
|
-
* - Inside Canvas: Full RootState (
|
|
2397
|
-
* - Outside Canvas
|
|
2398
|
-
*
|
|
1698
|
+
* Always delivers full RootState — works both inside and outside Canvas context:
|
|
1699
|
+
* - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
|
|
1700
|
+
* - Outside Canvas: The job registers immediately but the callback is held until a
|
|
1701
|
+
* Canvas adopts it, then runs with full RootState. For hostless / standalone
|
|
1702
|
+
* frame loops with no Canvas, use `@pmndrs/scheduler` directly.
|
|
2399
1703
|
*
|
|
2400
1704
|
* Returns a controls object for manual stepping, pausing, and resuming.
|
|
2401
1705
|
*
|
|
2402
1706
|
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
2403
1707
|
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
2404
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
1708
|
+
* @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
|
|
2405
1709
|
*
|
|
2406
1710
|
* @example
|
|
2407
1711
|
* // Simple priority (backwards compat)
|
|
@@ -2412,16 +1716,16 @@ declare const getScheduler: () => Scheduler;
|
|
|
2412
1716
|
* useFrame((state, delta) => { ... }, { phase: 'physics' })
|
|
2413
1717
|
*
|
|
2414
1718
|
* @example
|
|
2415
|
-
* // Outside Canvas - waits for Canvas
|
|
1719
|
+
* // Outside Canvas - callback waits for a Canvas, then always has full state
|
|
2416
1720
|
* function UI() {
|
|
2417
1721
|
* useFrame((state, delta) => { syncUI(state.camera) });
|
|
2418
1722
|
* return <button>...</button>;
|
|
2419
1723
|
* }
|
|
2420
1724
|
*
|
|
2421
1725
|
* @example
|
|
2422
|
-
* //
|
|
2423
|
-
* getScheduler
|
|
2424
|
-
*
|
|
1726
|
+
* // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
|
|
1727
|
+
* import { getScheduler } from '@pmndrs/scheduler'
|
|
1728
|
+
* getScheduler().register((state, delta) => { updateGame(delta) })
|
|
2425
1729
|
*
|
|
2426
1730
|
* @example
|
|
2427
1731
|
* // Scheduler-only access (no callback)
|
|
@@ -2444,11 +1748,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2444
1748
|
/** Callback when texture(s) finish loading */
|
|
2445
1749
|
onLoad?: (texture: MappedTextureType<Url>) => void;
|
|
2446
1750
|
/**
|
|
2447
|
-
*
|
|
2448
|
-
* When true:
|
|
1751
|
+
* Register the texture(s) in R3F's global texture registry for access via useTextures().
|
|
1752
|
+
* When true (the default):
|
|
2449
1753
|
* - Textures persist until explicitly disposed
|
|
2450
|
-
* -
|
|
2451
|
-
*
|
|
1754
|
+
* - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
|
|
1755
|
+
*
|
|
1756
|
+
* Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
|
|
1757
|
+
* changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
|
|
1758
|
+
*
|
|
1759
|
+
* Pass `false` to opt out of registry enrollment entirely.
|
|
1760
|
+
* @default true
|
|
2452
1761
|
*/
|
|
2453
1762
|
cache?: boolean;
|
|
2454
1763
|
};
|
|
@@ -2472,15 +1781,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2472
1781
|
* normal: '/normal.png'
|
|
2473
1782
|
* })
|
|
2474
1783
|
*
|
|
2475
|
-
* //
|
|
2476
|
-
* //
|
|
2477
|
-
* const diffuse = useTexture('/diffuse.png'
|
|
1784
|
+
* // Textures are registered in the global registry by default — the same texture
|
|
1785
|
+
* // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
|
|
1786
|
+
* const diffuse = useTexture('/diffuse.png')
|
|
2478
1787
|
* diffuse.colorSpace = THREE.SRGBColorSpace
|
|
2479
1788
|
*
|
|
2480
1789
|
* // Another component gets the SAME texture with colorSpace already set
|
|
2481
|
-
* const sameDiffuse = useTexture('/diffuse.png'
|
|
1790
|
+
* const sameDiffuse = useTexture('/diffuse.png')
|
|
1791
|
+
*
|
|
1792
|
+
* // Opt out of registry enrollment for a one-off texture
|
|
1793
|
+
* const scratch = useTexture('/scratch.png', { cache: false })
|
|
2482
1794
|
*
|
|
2483
|
-
* // Access
|
|
1795
|
+
* // Access the registry directly
|
|
2484
1796
|
* const { get } = useTextures()
|
|
2485
1797
|
* const cached = get('/diffuse.png')
|
|
2486
1798
|
* ```
|
|
@@ -2497,63 +1809,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
|
|
|
2497
1809
|
cache?: boolean;
|
|
2498
1810
|
}) => react_jsx_runtime.JSX.Element;
|
|
2499
1811
|
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
|
|
1812
|
+
/** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
|
|
1813
|
+
type TextureInput = string | string[] | Record<string, string>;
|
|
1814
|
+
/** Result of a `get()` read, mirroring the input shape. */
|
|
1815
|
+
type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
|
|
1816
|
+
[K in keyof Input]: Texture$1 | undefined;
|
|
2503
1817
|
};
|
|
1818
|
+
/** Options for `dispose()`. */
|
|
1819
|
+
interface DisposeOptions {
|
|
1820
|
+
/** Dispose even if the texture still has active references (default false). */
|
|
1821
|
+
force?: boolean;
|
|
1822
|
+
}
|
|
2504
1823
|
interface UseTexturesReturn {
|
|
2505
|
-
/** Map
|
|
2506
|
-
|
|
2507
|
-
/**
|
|
2508
|
-
get
|
|
2509
|
-
/** Check
|
|
2510
|
-
has
|
|
2511
|
-
/**
|
|
2512
|
-
|
|
2513
|
-
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
|
|
2524
|
-
|
|
1824
|
+
/** The live registry Map (key → Texture). Treat as read-only. */
|
|
1825
|
+
readonly all: Map<string, Texture$1>;
|
|
1826
|
+
/** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
|
|
1827
|
+
get<Input extends TextureInput>(input: Input): TextureResult<Input>;
|
|
1828
|
+
/** Check whether a key exists in the registry. */
|
|
1829
|
+
has(key: string): boolean;
|
|
1830
|
+
/**
|
|
1831
|
+
* Register a texture (or a record of textures) that has no URL — e.g. a render
|
|
1832
|
+
* target or procedural texture. URL-loaded textures are registered automatically
|
|
1833
|
+
* by `useTexture` (registry enrollment is on by default).
|
|
1834
|
+
*/
|
|
1835
|
+
add(key: string, texture: Texture$1): void;
|
|
1836
|
+
add(record: Record<string, Texture$1>): void;
|
|
1837
|
+
/**
|
|
1838
|
+
* Dispose a texture's GPU resources and remove it from the registry.
|
|
1839
|
+
* Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
|
|
1840
|
+
* skipped (with a warning) unless `{ force: true }` is passed.
|
|
1841
|
+
* @returns true if disposed, false if skipped.
|
|
1842
|
+
*/
|
|
1843
|
+
dispose(key: string, options?: DisposeOptions): boolean;
|
|
1844
|
+
/** Dispose every texture in the registry and clear it. Use on scene teardown. */
|
|
1845
|
+
disposeAll(): void;
|
|
2525
1846
|
}
|
|
2526
1847
|
/**
|
|
2527
|
-
*
|
|
1848
|
+
* Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
|
|
1849
|
+
*
|
|
1850
|
+
* This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
|
|
1851
|
+
* a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
|
|
1852
|
+
* `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
|
|
2528
1853
|
*
|
|
2529
|
-
*
|
|
2530
|
-
*
|
|
1854
|
+
* The returned handle is **reactive**: the calling component re-renders when the registry
|
|
1855
|
+
* changes. Pass a selector to scope the subscription to a single read.
|
|
2531
1856
|
*
|
|
2532
1857
|
* @example
|
|
2533
1858
|
* ```tsx
|
|
2534
|
-
*
|
|
2535
|
-
*
|
|
2536
|
-
* // Check if texture is already cached
|
|
2537
|
-
* if (!has('/textures/diffuse.png')) {
|
|
2538
|
-
* // Load with useTexture and cache: true, or manually add
|
|
2539
|
-
* const tex = useTexture('/textures/diffuse.png', { cache: true })
|
|
2540
|
-
* }
|
|
1859
|
+
* // Load + register once (anywhere in the tree) — registered by default
|
|
1860
|
+
* useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
2541
1861
|
*
|
|
2542
|
-
* //
|
|
2543
|
-
* const
|
|
2544
|
-
*
|
|
1862
|
+
* // Reach them from another component — record form lands straight into a material
|
|
1863
|
+
* const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
1864
|
+
* return <meshStandardMaterial map={map} normalMap={normalMap} />
|
|
2545
1865
|
*
|
|
2546
|
-
* //
|
|
2547
|
-
*
|
|
1866
|
+
* // A set of heightmaps at once
|
|
1867
|
+
* const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
|
|
2548
1868
|
*
|
|
2549
|
-
* //
|
|
2550
|
-
*
|
|
1869
|
+
* // Register a non-URL texture (render target / procedural)
|
|
1870
|
+
* useTextures().add('rt-main', renderTarget.texture)
|
|
2551
1871
|
*
|
|
2552
|
-
* //
|
|
2553
|
-
*
|
|
1872
|
+
* // Deliberate GPU cleanup (refcount-aware; force to override)
|
|
1873
|
+
* useTextures().dispose('/diffuse.jpg')
|
|
1874
|
+
* useTextures().disposeAll() // scene teardown
|
|
2554
1875
|
* ```
|
|
1876
|
+
*
|
|
1877
|
+
* @remarks
|
|
1878
|
+
* **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
|
|
1879
|
+
* intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
|
|
1880
|
+
* populate the registry without Suspense, at the cost of putting loading back into this hook. It
|
|
1881
|
+
* will be added only if a concrete consumer needs imperative loading; for now, loading lives in
|
|
1882
|
+
* `useTexture`.
|
|
2555
1883
|
*/
|
|
2556
1884
|
declare function useTextures(): UseTexturesReturn;
|
|
1885
|
+
declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
|
|
2557
1886
|
|
|
2558
1887
|
/**
|
|
2559
1888
|
* Creates a render target compatible with the current renderer.
|
|
@@ -2583,20 +1912,10 @@ declare function useTextures(): UseTexturesReturn;
|
|
|
2583
1912
|
* const fbo = useRenderTarget(512, 256, { samples: 4 })
|
|
2584
1913
|
* ```
|
|
2585
1914
|
*/
|
|
2586
|
-
declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget
|
|
2587
|
-
declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget
|
|
2588
|
-
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget
|
|
1915
|
+
declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
|
|
1916
|
+
declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
|
|
1917
|
+
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
|
|
2589
1918
|
|
|
2590
|
-
/**
|
|
2591
|
-
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
2592
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2593
|
-
*/
|
|
2594
|
-
declare function useStore(): RootStore;
|
|
2595
|
-
/**
|
|
2596
|
-
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
2597
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
2598
|
-
*/
|
|
2599
|
-
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
2600
1919
|
/**
|
|
2601
1920
|
* Exposes an object's {@link Instance}.
|
|
2602
1921
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2672,7 +1991,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2672
1991
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2673
1992
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2674
1993
|
*
|
|
2675
|
-
*
|
|
1994
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
1995
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
1996
|
+
*
|
|
1997
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2676
1998
|
* @param frames - Number of frames to request (default: 1)
|
|
2677
1999
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2678
2000
|
*
|
|
@@ -2683,14 +2005,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2683
2005
|
* Advances the frameloop and runs render effects.
|
|
2684
2006
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2685
2007
|
*
|
|
2008
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2009
|
+
* registered root is stepped for backwards compatibility.
|
|
2010
|
+
*
|
|
2686
2011
|
* @param timestamp - The timestamp to use for this frame
|
|
2687
2012
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2688
|
-
* @param state -
|
|
2689
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2013
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2690
2014
|
*
|
|
2691
2015
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2692
2016
|
*/
|
|
2693
|
-
declare function advance(timestamp: number): void;
|
|
2017
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2694
2018
|
|
|
2695
2019
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2696
2020
|
declare function ReactReconciler<
|
|
@@ -3735,6 +3059,7 @@ declare namespace ReactReconciler {
|
|
|
3735
3059
|
|
|
3736
3060
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3737
3061
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3062
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3738
3063
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3739
3064
|
|
|
3740
3065
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3759,13 +3084,9 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
|
|
|
3759
3084
|
declare function flushSync<R>(fn: () => R): R;
|
|
3760
3085
|
|
|
3761
3086
|
declare const context: React$1.Context<RootStore>;
|
|
3087
|
+
|
|
3762
3088
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3763
3089
|
|
|
3764
|
-
/**
|
|
3765
|
-
* Safely flush async effects when testing, simulating a legacy root.
|
|
3766
|
-
* @deprecated Import from React instead. import { act } from 'react'
|
|
3767
|
-
*/
|
|
3768
|
-
declare const act: typeof React$1.act;
|
|
3769
3090
|
/**
|
|
3770
3091
|
* An SSR-friendly useLayoutEffect.
|
|
3771
3092
|
*
|
|
@@ -4017,7 +3338,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
|
|
|
4017
3338
|
declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
|
|
4018
3339
|
/**
|
|
4019
3340
|
* Triggers an update for an instance.
|
|
4020
|
-
*
|
|
3341
|
+
* Invalidates the frame if the root is in demand mode.
|
|
4021
3342
|
*
|
|
4022
3343
|
* @param instance - Instance to invalidate
|
|
4023
3344
|
*/
|
|
@@ -4183,29 +3504,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
4183
3504
|
* Used to identify values that should be resolved from refs after mount.
|
|
4184
3505
|
*/
|
|
4185
3506
|
declare const FROM_REF: unique symbol;
|
|
3507
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3508
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3509
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3510
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3511
|
+
transform?: (value: T) => R;
|
|
3512
|
+
}
|
|
4186
3513
|
/**
|
|
4187
3514
|
* Defers prop application until the referenced object is available.
|
|
4188
3515
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
4189
3516
|
*
|
|
3517
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3518
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3519
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3520
|
+
* what gets assigned.
|
|
3521
|
+
*
|
|
4190
3522
|
* @param ref - React ref object to resolve at mount time
|
|
4191
|
-
* @
|
|
3523
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3524
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
4192
3525
|
*
|
|
4193
3526
|
* @example
|
|
4194
3527
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
4195
3528
|
*
|
|
4196
3529
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
4197
3530
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3531
|
+
*
|
|
3532
|
+
* @example
|
|
3533
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3534
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
4198
3535
|
*/
|
|
4199
3536
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3537
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
4200
3538
|
/**
|
|
4201
3539
|
* Type guard to check if a value is a fromRef marker.
|
|
4202
3540
|
*
|
|
4203
3541
|
* @param value - Value to check
|
|
4204
3542
|
* @returns True if value is a fromRef marker
|
|
4205
3543
|
*/
|
|
4206
|
-
declare function isFromRef(value: unknown): value is
|
|
4207
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
4208
|
-
};
|
|
3544
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
4209
3545
|
|
|
4210
3546
|
/**
|
|
4211
3547
|
* Symbol marker for mount-only method calls.
|
|
@@ -4232,7 +3568,15 @@ declare const ONCE: unique symbol;
|
|
|
4232
3568
|
* // No arguments
|
|
4233
3569
|
* <geometry center={once()} />
|
|
4234
3570
|
*/
|
|
4235
|
-
declare function once<
|
|
3571
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3572
|
+
/**
|
|
3573
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3574
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3575
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3576
|
+
*
|
|
3577
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3578
|
+
*/
|
|
3579
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
4236
3580
|
/**
|
|
4237
3581
|
* Type guard to check if a value is a once marker.
|
|
4238
3582
|
*
|
|
@@ -4249,5 +3593,5 @@ declare function isOnce(value: unknown): value is {
|
|
|
4249
3593
|
*/
|
|
4250
3594
|
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
4251
3595
|
|
|
4252
|
-
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,
|
|
4253
|
-
export type { Act,
|
|
3596
|
+
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 };
|
|
3597
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, FromRefMarker, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootExtension, RootState, RootStore, SetBlock, Size, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|