@react-three/fiber 8.16.8 → 8.17.1

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

@@ -1,58 +0,0 @@
-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

@@ -1,138 +0,0 @@
-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

@@ -1,134 +0,0 @@
-/// <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

@@ -1,12 +0,0 @@
-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 } from './web/events';
-export type { GlobalRenderCallback, GlobalEffectType } from './core/loop';
-export * from './core';

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

@@ -1,14 +0,0 @@
-import * as React from 'react';
-import { View, ViewProps, 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

@@ -1,5 +0,0 @@
-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

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

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

@@ -1,12 +0,0 @@
-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 './native/Canvas';
-export { createTouchEvents as events } from './native/events';
-export type { GlobalRenderCallback, GlobalEffectType } from './core/loop';
-export * from './core';