@react-three/fiber 8.17.4 → 8.17.6

package/dist/declarations/src/core/events.d.ts

@@ -0,0 +1,93 @@
+import * as THREE from 'three';
+import type { UseBoundStore } from 'zustand';
+import type { RootState } from './store';
+import type { Properties } from '../three-types';
+export interface Intersection extends THREE.Intersection {
+    /** The event source (the object which registered the handler) */
+    eventObject: THREE.Object3D;
+}
+export interface IntersectionEvent<TSourceEvent> extends Intersection {
+    /** The event source (the object which registered the handler) */
+    eventObject: THREE.Object3D;
+    /** An array of intersections */
+    intersections: Intersection[];
+    /** vec3.set(pointer.x, pointer.y, 0).unproject(camera) */
+    unprojectedPoint: THREE.Vector3;
+    /** Normalized event coordinates */
+    pointer: THREE.Vector2;
+    /** Delta between first click and this event */
+    delta: number;
+    /** The ray that pierced it */
+    ray: THREE.Ray;
+    /** The camera that was used by the raycaster */
+    camera: Camera;
+    /** stopPropagation will stop underlying handlers from firing */
+    stopPropagation: () => void;
+    /** The original host event */
+    nativeEvent: TSourceEvent;
+    /** If the event was stopped by calling stopPropagation */
+    stopped: boolean;
+}
+export declare type Camera = THREE.OrthographicCamera | THREE.PerspectiveCamera;
+export declare type ThreeEvent<TEvent> = IntersectionEvent<TEvent> & Properties<TEvent>;
+export declare type DomEvent = PointerEvent | MouseEvent | WheelEvent;
+export declare type Events = {
+    onClick: EventListener;
+    onContextMenu: EventListener;
+    onDoubleClick: EventListener;
+    onWheel: EventListener;
+    onPointerDown: EventListener;
+    onPointerUp: EventListener;
+    onPointerLeave: EventListener;
+    onPointerMove: EventListener;
+    onPointerCancel: EventListener;
+    onLostPointerCapture: EventListener;
+};
+export declare type EventHandlers = {
+    onClick?: (event: ThreeEvent<MouseEvent>) => void;
+    onContextMenu?: (event: ThreeEvent<MouseEvent>) => void;
+    onDoubleClick?: (event: ThreeEvent<MouseEvent>) => void;
+    onPointerUp?: (event: ThreeEvent<PointerEvent>) => void;
+    onPointerDown?: (event: ThreeEvent<PointerEvent>) => void;
+    onPointerOver?: (event: ThreeEvent<PointerEvent>) => void;
+    onPointerOut?: (event: ThreeEvent<PointerEvent>) => void;
+    onPointerEnter?: (event: ThreeEvent<PointerEvent>) => void;
+    onPointerLeave?: (event: ThreeEvent<PointerEvent>) => void;
+    onPointerMove?: (event: ThreeEvent<PointerEvent>) => void;
+    onPointerMissed?: (event: MouseEvent) => void;
+    onPointerCancel?: (event: ThreeEvent<PointerEvent>) => void;
+    onWheel?: (event: ThreeEvent<WheelEvent>) => void;
+};
+export declare type FilterFunction = (items: THREE.Intersection[], state: RootState) => THREE.Intersection[];
+export declare type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void;
+export interface EventManager<TTarget> {
+    /** Determines if the event layer is active */
+    enabled: boolean;
+    /** Event layer priority, higher prioritized layers come first and may stop(-propagate) lower layer  */
+    priority: number;
+    /** The compute function needs to set up the raycaster and an xy- pointer  */
+    compute?: ComputeFunction;
+    /** The filter can re-order or re-structure the intersections  */
+    filter?: FilterFunction;
+    /** The target node the event layer is tied to */
+    connected?: TTarget;
+    /** All the pointer event handlers through which the host forwards native events */
+    handlers?: Events;
+    /** Allows re-connecting to another target */
+    connect?: (target: TTarget) => void;
+    /** Removes all existing events handlers from the target */
+    disconnect?: () => void;
+    /** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
+     *  explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
+     */
+    update?: () => void;
+}
+export interface PointerCaptureTarget {
+    intersection: Intersection;
+    target: Element;
+}
+export declare function getEventPriority(): 1 | 16 | 4;
+export declare function removeInteractivity(store: UseBoundStore<RootState>, object: THREE.Object3D): void;
+export declare function createEvents(store: UseBoundStore<RootState>): {
+    handlePointer: (name: string) => (event: DomEvent) => void;
+};

package/dist/declarations/src/core/hooks.d.ts

@@ -0,0 +1,57 @@
+import * as THREE from 'three';
+import * as React from 'react';
+import { StateSelector, EqualityChecker } from 'zustand';
+import { RootState, RenderCallback } from './store';
+import { ObjectMap } from './utils';
+import { LocalState } from './renderer';
+export interface Loader<T> extends THREE.Loader {
+    load(url: string, onLoad?: (result: T) => void, onProgress?: (event: ProgressEvent) => void, onError?: (event: unknown) => void): unknown;
+    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<T>;
+}
+export declare type LoaderProto<T> = new (...args: any) => Loader<T extends unknown ? any : T>;
+export declare type LoaderReturnType<T, L extends LoaderProto<T>> = T extends unknown ? Awaited<ReturnType<InstanceType<L>['loadAsync']>> : T;
+export declare type LoaderResult<T> = T extends any[] ? Loader<T[number]> : Loader<T>;
+export declare type Extensions<T extends {
+    prototype: LoaderProto<any>;
+}> = (loader: T['prototype']) => void;
+export declare type ConditionalType<Child, Parent, Truthy, Falsy> = Child extends Parent ? Truthy : Falsy;
+export declare type BranchingReturn<T, Parent, Coerced> = ConditionalType<T, Parent, Coerced, T>;
+/**
+ * Exposes an object's {@link LocalState}.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
+ *
+ * **Note**: this is an escape hatch to react-internal fields. Expect this to change significantly between versions.
+ */
+export declare function useInstanceHandle<O>(ref: React.MutableRefObject<O>): React.MutableRefObject<LocalState>;
+export declare function useStore(): import("zustand").UseBoundStore<RootState, import("zustand").StoreApi<RootState>>;
+/**
+ * Accesses R3F's internal state, containing renderer, canvas, scene, etc.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
+ */
+export declare function useThree<T = RootState>(selector?: StateSelector<RootState, T>, equalityFn?: EqualityChecker<T>): T;
+/**
+ * Executes a callback before render in a shared frame loop.
+ * Can order effects with render priority or manually render with a positive priority.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
+ */
+export declare function useFrame(callback: RenderCallback, renderPriority?: number): null;
+/**
+ * Returns a node graph of an object with named nodes & materials.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usegraph
+ */
+export declare function useGraph(object: THREE.Object3D): ObjectMap;
+declare type GLTFLike = {
+    scene: THREE.Object3D;
+};
+/**
+ * Synchronously loads and caches assets with a three loader.
+ *
+ * Note: this hook's caller must be wrapped with `React.Suspense`
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
+ */
+export declare function useLoader<T, U extends string | string[], L extends LoaderProto<T>, R = LoaderReturnType<T, L>>(Proto: L, input: U, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void): U extends any[] ? BranchingReturn<R, GLTFLike, R & ObjectMap>[] : BranchingReturn<R, GLTFLike, R & ObjectMap>;
+export declare namespace useLoader {
+    var preload: <T, U extends string | string[], L extends LoaderProto<T>>(Proto: L, input: U, extensions?: Extensions<L> | undefined) => undefined;
+    var clear: <T, U extends string | string[], L extends LoaderProto<T>>(Proto: L, input: U) => void;
+}
+export {};

package/dist/declarations/src/core/index.d.ts

@@ -0,0 +1,94 @@
+/// <reference types="offscreencanvas" />
+import * as THREE from 'three';
+import * as React from 'react';
+import { UseBoundStore } from 'zustand';
+import * as ReactThreeFiber from '../three-types';
+import { Renderer, context, RootState, Size, Dpr, Performance, PrivateKeys } from './store';
+import { extend, Root } from './renderer';
+import { addEffect, addAfterEffect, addTail, flushGlobalEffects, Invalidate, Advance } from './loop';
+import { EventManager, ComputeFunction } from './events';
+import { dispose, getRootState, Camera, buildGraph } from './utils';
+import type { Properties } from '../three-types';
+declare type Canvas = HTMLCanvasElement | OffscreenCanvas;
+declare const roots: Map<Canvas, Root>;
+declare const invalidate: Invalidate, advance: Advance;
+declare const reconciler: import("react-reconciler").Reconciler<UseBoundStore<RootState, import("zustand").StoreApi<RootState>>, import("./renderer").Instance, void, import("./renderer").Instance, import("./renderer").Instance>, applyProps: typeof import("./utils").applyProps;
+declare type GLProps = Renderer | ((canvas: Canvas) => Renderer) | Partial<Properties<THREE.WebGLRenderer> | THREE.WebGLRendererParameters> | undefined;
+export declare type RenderProps<TCanvas extends Canvas> = {
+    /** A threejs renderer instance or props that go into the default renderer */
+    gl?: GLProps;
+    /** Dimensions to fit the renderer to. Will measure canvas dimensions if omitted */
+    size?: Size;
+    /**
+     * Enables shadows (by default PCFsoft). Can accept `gl.shadowMap` options for fine-tuning,
+     * but also strings: 'basic' | 'percentage' | 'soft' | 'variance'.
+     * @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
+     */
+    shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE.WebGLShadowMap>;
+    /**
+     * Disables three r139 color management.
+     * @see https://threejs.org/docs/#manual/en/introduction/Color-management
+     */
+    legacy?: boolean;
+    /** Switch off automatic sRGB color space and gamma correction */
+    linear?: boolean;
+    /** Use `THREE.NoToneMapping` instead of `THREE.ACESFilmicToneMapping` */
+    flat?: boolean;
+    /** Creates an orthographic camera */
+    orthographic?: boolean;
+    /**
+     * R3F's render mode. Set to `demand` to only render on state change or `never` to take control.
+     * @see https://docs.pmnd.rs/react-three-fiber/advanced/scaling-performance#on-demand-rendering
+     */
+    frameloop?: 'always' | 'demand' | 'never';
+    /**
+     * R3F performance options for adaptive performance.
+     * @see https://docs.pmnd.rs/react-three-fiber/advanced/scaling-performance#movement-regression
+     */
+    performance?: Partial<Omit<Performance, 'regress'>>;
+    /** Target pixel ratio. Can clamp between a range: `[min, max]` */
+    dpr?: Dpr;
+    /** Props that go into the default raycaster */
+    raycaster?: Partial<THREE.Raycaster>;
+    /** A `THREE.Scene` instance or props that go into the default scene */
+    scene?: THREE.Scene | Partial<ReactThreeFiber.Object3DNode<THREE.Scene, typeof THREE.Scene>>;
+    /** A `THREE.Camera` instance or props that go into the default camera */
+    camera?: (Camera | Partial<ReactThreeFiber.Object3DNode<THREE.Camera, typeof THREE.Camera> & ReactThreeFiber.Object3DNode<THREE.PerspectiveCamera, typeof THREE.PerspectiveCamera> & ReactThreeFiber.Object3DNode<THREE.OrthographicCamera, typeof THREE.OrthographicCamera>>) & {
+        /** Flags the camera as manual, putting projection into your own hands */
+        manual?: boolean;
+    };
+    /** An R3F event manager to manage elements' pointer events */
+    events?: (store: UseBoundStore<RootState>) => EventManager<HTMLElement>;
+    /** Callback after the canvas has rendered (but not yet committed) */
+    onCreated?: (state: RootState) => void;
+    /** Response for pointer clicks that have missed any target */
+    onPointerMissed?: (event: MouseEvent) => void;
+};
+export declare type ReconcilerRoot<TCanvas extends Canvas> = {
+    configure: (config?: RenderProps<TCanvas>) => ReconcilerRoot<TCanvas>;
+    render: (element: React.ReactNode) => UseBoundStore<RootState>;
+    unmount: () => void;
+};
+declare function createRoot<TCanvas extends Canvas>(canvas: TCanvas): ReconcilerRoot<TCanvas>;
+declare function render<TCanvas extends Canvas>(children: React.ReactNode, canvas: TCanvas, config: RenderProps<TCanvas>): UseBoundStore<RootState>;
+declare function unmountComponentAtNode<TCanvas extends Canvas>(canvas: TCanvas, callback?: (canvas: TCanvas) => void): void;
+export declare type InjectState = Partial<Omit<RootState, PrivateKeys> & {
+    events?: {
+        enabled?: boolean;
+        priority?: number;
+        compute?: ComputeFunction;
+        connected?: any;
+    };
+    size?: Size;
+}>;
+declare function createPortal(children: React.ReactNode, container: THREE.Object3D, state?: InjectState): JSX.Element;
+/**
+ * Force React to flush any updates inside the provided callback synchronously and immediately.
+ * All the same caveats documented for react-dom's `flushSync` apply here (see https://react.dev/reference/react-dom/flushSync).
+ * Nevertheless, sometimes one needs to render synchronously, for example to keep DOM and 3D changes in lock-step without
+ * having to revert to a non-React solution.
+ */
+declare function flushSync<R>(fn: () => R): R;
+declare const act: any;
+export * from './hooks';
+export { context, render, createRoot, unmountComponentAtNode, createPortal, reconciler, applyProps, dispose, invalidate, advance, extend, addEffect, addAfterEffect, addTail, flushGlobalEffects, flushSync, getRootState, act, buildGraph, roots as _roots, };

package/dist/declarations/src/core/loop.d.ts

@@ -0,0 +1,38 @@
+import { Root } from './renderer';
+import { RootState } from './store';
+import { _XRFrame } from './utils';
+export declare type GlobalRenderCallback = (timeStamp: number) => void;
+/**
+ * Adds a global render callback which is called each frame.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#addEffect
+ */
+export declare const addEffect: (callback: GlobalRenderCallback) => () => void;
+/**
+ * Adds a global after-render callback which is called each frame.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#addAfterEffect
+ */
+export declare const addAfterEffect: (callback: GlobalRenderCallback) => () => void;
+/**
+ * Adds a global callback which is called when rendering stops.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#addTail
+ */
+export declare const addTail: (callback: GlobalRenderCallback) => () => void;
+export declare type GlobalEffectType = 'before' | 'after' | 'tail';
+export declare function flushGlobalEffects(type: GlobalEffectType, timestamp: number): void;
+export declare type Invalidate = (state?: RootState, frames?: number) => void;
+export declare type Advance = (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: _XRFrame) => void;
+interface Loop {
+    loop: (timestamp: number) => void;
+    /**
+     * Invalidates the view, requesting a frame to be rendered. Will globally invalidate unless passed a root's state.
+     * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#invalidate
+     */
+    invalidate: Invalidate;
+    /**
+     * Advances the frameloop and runs render effects, useful for when manually rendering via `frameloop="never"`.
+     * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
+     */
+    advance: Advance;
+}
+export declare function createLoop<TCanvas>(roots: Map<TCanvas, Root>): Loop;
+export {};

package/dist/declarations/src/core/renderer.d.ts

@@ -0,0 +1,58 @@
+import * as THREE from 'three';
+import { UseBoundStore } from 'zustand';
+import Reconciler from 'react-reconciler';
+import { prepare, applyProps } from './utils';
+import { RootState } from './store';
+import { EventHandlers } from './events';
+export declare type Root = {
+    fiber: Reconciler.FiberRoot;
+    store: UseBoundStore<RootState>;
+};
+export declare type LocalState = {
+    type: string;
+    root: UseBoundStore<RootState>;
+    objects: Instance[];
+    parent: Instance | null;
+    primitive?: boolean;
+    eventCount: number;
+    handlers: Partial<EventHandlers>;
+    attach?: AttachType;
+    previousAttach: any;
+    memoizedProps: {
+        [key: string]: any;
+    };
+    autoRemovedBeforeAppend?: boolean;
+};
+export declare type AttachFnType = (parent: Instance, self: Instance) => () => void;
+export declare type AttachType = string | AttachFnType;
+export declare type BaseInstance = Omit<THREE.Object3D, 'children' | 'attach' | 'add' | 'remove' | 'raycast'> & {
+    __r3f: LocalState;
+    children: Instance[];
+    remove: (...object: Instance[]) => Instance;
+    add: (...object: Instance[]) => Instance;
+    raycast?: (raycaster: THREE.Raycaster, intersects: THREE.Intersection[]) => void;
+};
+export declare type Instance = BaseInstance & {
+    [key: string]: any;
+};
+export declare type InstanceProps = {
+    [key: string]: unknown;
+} & {
+    args?: any[];
+    object?: object;
+    visible?: boolean;
+    dispose?: null;
+    attach?: AttachType;
+};
+interface Catalogue {
+    [name: string]: {
+        new (...args: any): Instance;
+    };
+}
+export declare const catalogue: Catalogue;
+declare const extend: (objects: object) => void;
+declare function createRenderer<TCanvas>(_roots: Map<TCanvas, Root>, _getEventPriority?: () => any): {
+    reconciler: Reconciler.Reconciler<UseBoundStore<RootState, import("zustand").StoreApi<RootState>>, Instance, void, Instance, Instance>;
+    applyProps: typeof applyProps;
+};
+export { prepare, createRenderer, extend };

package/dist/declarations/src/core/store.d.ts

@@ -0,0 +1,138 @@
+import * as THREE from 'three';
+import * as React from 'react';
+import { GetState, SetState, StoreApi, UseBoundStore } from 'zustand';
+import { DomEvent, EventManager, PointerCaptureTarget, ThreeEvent } from './events';
+import { _XRFrame, Camera } from './utils';
+import { Advance, Invalidate } from './loop';
+export declare const privateKeys: readonly ["set", "get", "setSize", "setFrameloop", "setDpr", "events", "invalidate", "advance", "size", "viewport"];
+export declare type PrivateKeys = typeof privateKeys[number];
+export interface Intersection extends THREE.Intersection {
+    eventObject: THREE.Object3D;
+}
+export declare type Subscription = {
+    ref: React.MutableRefObject<RenderCallback>;
+    priority: number;
+    store: UseBoundStore<RootState, StoreApi<RootState>>;
+};
+export declare type Dpr = number | [min: number, max: number];
+export declare type Size = {
+    width: number;
+    height: number;
+    top: number;
+    left: number;
+    /** @deprecated `updateStyle` is now disabled for OffscreenCanvas and will be removed in v9. */
+    updateStyle?: boolean;
+};
+export declare type Viewport = Size & {
+    /** The initial pixel ratio */
+    initialDpr: number;
+    /** Current pixel ratio */
+    dpr: number;
+    /** size.width / viewport.width */
+    factor: number;
+    /** Camera distance */
+    distance: number;
+    /** Camera aspect ratio: width / height */
+    aspect: number;
+};
+export declare type RenderCallback = (state: RootState, delta: number, frame?: _XRFrame) => void;
+export declare type Performance = {
+    /** Current performance normal, between min and max */
+    current: number;
+    /** How low the performance can go, between 0 and max */
+    min: number;
+    /** How high the performance can go, between min and max */
+    max: number;
+    /** Time until current returns to max in ms */
+    debounce: number;
+    /** Sets current to min, puts the system in regression */
+    regress: () => void;
+};
+export declare type Renderer = {
+    render: (scene: THREE.Scene, camera: THREE.Camera) => any;
+};
+export declare const isRenderer: (def: any) => boolean;
+export declare type InternalState = {
+    active: boolean;
+    priority: number;
+    frames: number;
+    lastEvent: React.MutableRefObject<DomEvent | null>;
+    interaction: THREE.Object3D[];
+    hovered: Map<string, ThreeEvent<DomEvent>>;
+    subscribers: Subscription[];
+    capturedMap: Map<number, Map<THREE.Object3D, PointerCaptureTarget>>;
+    initialClick: [x: number, y: number];
+    initialHits: THREE.Object3D[];
+    subscribe: (callback: React.MutableRefObject<RenderCallback>, priority: number, store: UseBoundStore<RootState, StoreApi<RootState>>) => () => void;
+};
+export declare type RootState = {
+    /** Set current state */
+    set: SetState<RootState>;
+    /** Get current state */
+    get: GetState<RootState>;
+    /** The instance of the renderer */
+    gl: THREE.WebGLRenderer;
+    /** Default camera */
+    camera: Camera & {
+        manual?: boolean;
+    };
+    /** Default scene */
+    scene: THREE.Scene;
+    /** Default raycaster */
+    raycaster: THREE.Raycaster;
+    /** Default clock */
+    clock: THREE.Clock;
+    /** Event layer interface, contains the event handler and the node they're connected to */
+    events: EventManager<any>;
+    /** XR interface */
+    xr: {
+        connect: () => void;
+        disconnect: () => void;
+    };
+    /** Currently used controls */
+    controls: THREE.EventDispatcher | null;
+    /** Normalized event coordinates */
+    pointer: THREE.Vector2;
+    /** @deprecated Normalized event coordinates, use "pointer" instead! */
+    mouse: THREE.Vector2;
+    legacy: boolean;
+    /** Shortcut to gl.outputColorSpace = THREE.LinearSRGBColorSpace */
+    linear: boolean;
+    /** Shortcut to gl.toneMapping = NoTonemapping */
+    flat: boolean;
+    /** Render loop flags */
+    frameloop: 'always' | 'demand' | 'never';
+    /** Adaptive performance interface */
+    performance: Performance;
+    /** Reactive pixel-size of the canvas */
+    size: Size;
+    /** Reactive size of the viewport in threejs units */
+    viewport: Viewport & {
+        getCurrentViewport: (camera?: Camera, target?: THREE.Vector3 | Parameters<THREE.Vector3['set']>, size?: Size) => Omit<Viewport, 'dpr' | 'initialDpr'>;
+    };
+    /** Flags the canvas for render, but doesn't render in itself */
+    invalidate: (frames?: number) => void;
+    /** Advance (render) one step */
+    advance: (timestamp: number, runGlobalEffects?: boolean) => void;
+    /** Shortcut to setting the event layer */
+    setEvents: (events: Partial<EventManager<any>>) => void;
+    /**
+     * Shortcut to manual sizing
+     */
+    setSize: (width: number, height: number, 
+    /** @deprecated `updateStyle` is now disabled for OffscreenCanvas and will be removed in v9. */
+    updateStyle?: boolean, top?: number, left?: number) => void;
+    /** Shortcut to manual setting the pixel ratio */
+    setDpr: (dpr: Dpr) => void;
+    /** Shortcut to frameloop flags */
+    setFrameloop: (frameloop?: 'always' | 'demand' | 'never') => void;
+    /** When the canvas was clicked but nothing was hit */
+    onPointerMissed?: (event: MouseEvent) => void;
+    /** If this state model is layered (via createPortal) then this contains the previous layer */
+    previousRoot?: UseBoundStore<RootState, StoreApi<RootState>>;
+    /** Internals */
+    internal: InternalState;
+};
+declare const context: React.Context<UseBoundStore<RootState, StoreApi<RootState>>>;
+declare const createStore: (invalidate: Invalidate, advance: Advance) => UseBoundStore<RootState>;
+export { createStore, context };

package/dist/declarations/src/core/utils.d.ts

@@ -0,0 +1,134 @@
+/// <reference types="webxr" />
+import * as THREE from 'three';
+import * as React from 'react';
+import { UseBoundStore } from 'zustand';
+import { AttachType, Instance, InstanceProps, LocalState } from './renderer';
+import { Dpr, Renderer, RootState, Size } from './store';
+/** @ts-ignore */
+declare type _DeprecatedXRFrame = THREE.XRFrame;
+/** @ts-ignore */
+export declare type _XRFrame = THREE.WebGLRenderTargetOptions extends {
+    samples?: number;
+} ? XRFrame : _DeprecatedXRFrame;
+/**
+ * Returns `true` with correct TS type inference if an object has a configurable color space (since r152).
+ */
+export declare const hasColorSpace: <T extends object | Renderer | THREE.Texture, P = T extends Renderer ? {
+    outputColorSpace: string;
+} : {
+    colorSpace: string;
+}>(object: T) => object is T & P;
+export declare type ColorManagementRepresentation = {
+    enabled: boolean | never;
+} | {
+    legacyMode: boolean | never;
+};
+/**
+ * The current THREE.ColorManagement instance, if present.
+ */
+export declare const getColorManagement: () => ColorManagementRepresentation | null;
+export declare type Camera = THREE.OrthographicCamera | THREE.PerspectiveCamera;
+export declare const isOrthographicCamera: (def: Camera) => def is THREE.OrthographicCamera;
+export declare const isRef: (obj: any) => obj is React.MutableRefObject<unknown>;
+/**
+ * An SSR-friendly useLayoutEffect.
+ *
+ * React currently throws a warning when using useLayoutEffect on the server.
+ * To get around it, we can conditionally useEffect on the server (no-op) and
+ * useLayoutEffect elsewhere.
+ *
+ * @see https://github.com/facebook/react/issues/14927
+ */
+export declare const useIsomorphicLayoutEffect: typeof React.useLayoutEffect;
+export declare function useMutableCallback<T>(fn: T): React.MutableRefObject<T>;
+export declare type SetBlock = false | Promise<null> | null;
+export declare type UnblockProps = {
+    set: React.Dispatch<React.SetStateAction<SetBlock>>;
+    children: React.ReactNode;
+};
+export declare function Block({ set }: Omit<UnblockProps, 'children'>): null;
+export declare class ErrorBoundary extends React.Component<{
+    set: React.Dispatch<Error | undefined>;
+    children: React.ReactNode;
+}, {
+    error: boolean;
+}> {
+    state: {
+        error: boolean;
+    };
+    static getDerivedStateFromError: () => {
+        error: boolean;
+    };
+    componentDidCatch(err: Error): void;
+    render(): React.ReactNode;
+}
+export declare const DEFAULT = "__default";
+export declare const DEFAULTS: Map<any, any>;
+export declare type DiffSet = {
+    memoized: {
+        [key: string]: any;
+    };
+    changes: [key: string, value: unknown, isEvent: boolean, keys: string[]][];
+};
+export declare const isDiffSet: (def: any) => def is DiffSet;
+export declare type ClassConstructor = {
+    new (): void;
+};
+export declare type ObjectMap = {
+    nodes: {
+        [name: string]: THREE.Object3D;
+    };
+    materials: {
+        [name: string]: THREE.Material;
+    };
+};
+export declare function calculateDpr(dpr: Dpr): number;
+/**
+ * Returns instance root state
+ */
+export declare const getRootState: (obj: THREE.Object3D) => RootState | undefined;
+/**
+ * Returns the instances initial (outmost) root
+ */
+export declare function findInitialRoot(child: Instance): UseBoundStore<RootState, import("zustand").StoreApi<RootState>>;
+export declare type EquConfig = {
+    /** Compare arrays by reference equality a === b (default), or by shallow equality */
+    arrays?: 'reference' | 'shallow';
+    /** Compare objects by reference equality a === b (default), or by shallow equality */
+    objects?: 'reference' | 'shallow';
+    /** If true the keys in both a and b must match 1:1 (default), if false a's keys must intersect b's */
+    strict?: boolean;
+};
+export declare const is: {
+    obj: (a: any) => boolean;
+    fun: (a: any) => a is Function;
+    str: (a: any) => a is string;
+    num: (a: any) => a is number;
+    boo: (a: any) => a is boolean;
+    und: (a: any) => boolean;
+    arr: (a: any) => boolean;
+    equ(a: any, b: any, { arrays, objects, strict }?: EquConfig): boolean;
+};
+/**
+ * Collects nodes and materials from a THREE.Object3D.
+ */
+export declare function buildGraph(object: THREE.Object3D): ObjectMap;
+export declare function dispose<TObj extends {
+    dispose?: () => void;
+    type?: string;
+    [key: string]: any;
+}>(obj: TObj): void;
+export declare function prepare<T = THREE.Object3D>(object: T, state?: Partial<LocalState>): T;
+export declare function attach(parent: Instance, child: Instance, type: AttachType): void;
+export declare function detach(parent: Instance, child: Instance, type: AttachType): void;
+declare type MaybeInstance = Omit<Instance, '__r3f'> & {
+    __r3f?: LocalState;
+};
+export declare function diffProps(instance: MaybeInstance, { children: cN, key: kN, ref: rN, ...props }: InstanceProps, { children: cP, key: kP, ref: rP, ...previous }?: InstanceProps, remove?: boolean): DiffSet;
+export declare function applyProps(instance: MaybeInstance, data: InstanceProps | DiffSet): MaybeInstance;
+export declare function invalidateInstance(instance: MaybeInstance): void;
+export declare function updateInstance(instance: MaybeInstance): void;
+export declare function updateCamera(camera: Camera & {
+    manual?: boolean;
+}, size: Size): void;
+export {};

package/dist/declarations/src/index.d.ts

@@ -0,0 +1,12 @@
+export * from './three-types';
+import * as ReactThreeFiber from './three-types';
+export { ReactThreeFiber };
+export type { BaseInstance, LocalState } from './core/renderer';
+export type { Intersection, Subscription, Dpr, Size, Viewport, RenderCallback, Performance, RootState, } from './core/store';
+export type { ThreeEvent, Events, EventManager, ComputeFunction } from './core/events';
+export { createEvents } from './core/events';
+export type { ObjectMap, Camera } from './core/utils';
+export * from './web/Canvas';
+export { createPointerEvents as events, createPointerEvents } from './web/events';
+export type { GlobalRenderCallback, GlobalEffectType } from './core/loop';
+export * from './core';

package/dist/declarations/src/native/Canvas.d.ts

@@ -0,0 +1,14 @@
+import * as React from 'react';
+import { View, type ViewProps, type ViewStyle } from 'react-native';
+import { RenderProps } from '../core';
+export interface CanvasProps extends Omit<RenderProps<HTMLCanvasElement>, 'size' | 'dpr'>, ViewProps {
+    children: React.ReactNode;
+    style?: ViewStyle;
+}
+export interface Props extends CanvasProps {
+}
+/**
+ * A native canvas which accepts threejs elements as children.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/canvas
+ */
+export declare const Canvas: React.ForwardRefExoticComponent<Props & React.RefAttributes<View>>;

package/dist/declarations/src/native/events.d.ts

@@ -0,0 +1,5 @@
+import { UseBoundStore } from 'zustand';
+import { RootState } from '../core/store';
+import { EventManager } from '../core/events';
+/** Default R3F event manager for react-native */
+export declare function createTouchEvents(store: UseBoundStore<RootState>): EventManager<HTMLElement>;

package/dist/declarations/src/native/polyfills.d.ts

@@ -0,0 +1 @@
+export declare function polyfills(): void;