@react-three/fiber 8.2.0 → 9.0.0-alpha.0

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

@@ -1,95 +1,110 @@
-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 { Camera } from './utils';
-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;
-    updateStyle?: boolean;
-};
-export declare type Viewport = Size & {
-    initialDpr: number;
-    dpr: number;
-    factor: number;
-    distance: number;
-    aspect: number;
-};
-export declare type RenderCallback = (state: RootState, delta: number, frame?: THREE.XRFrame) => void;
-export declare type Performance = {
-    current: number;
-    min: number;
-    max: number;
-    debounce: number;
-    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: SetState<RootState>;
-    get: GetState<RootState>;
-    gl: THREE.WebGLRenderer;
-    camera: Camera & {
-        manual?: boolean;
-    };
-    scene: THREE.Scene;
-    raycaster: THREE.Raycaster;
-    clock: THREE.Clock;
-    events: EventManager<any>;
-    xr: {
-        connect: () => void;
-        disconnect: () => void;
-    };
-    controls: THREE.EventDispatcher | null;
-    pointer: THREE.Vector2;
-    mouse: THREE.Vector2;
-    legacy: boolean;
-    linear: boolean;
-    flat: boolean;
-    frameloop: 'always' | 'demand' | 'never';
-    performance: Performance;
-    size: Size;
-    viewport: Viewport & {
-        getCurrentViewport: (camera?: Camera, target?: THREE.Vector3 | Parameters<THREE.Vector3['set']>, size?: Size) => Omit<Viewport, 'dpr' | 'initialDpr'>;
-    };
-    invalidate: (frames?: number) => void;
-    advance: (timestamp: number, runGlobalEffects?: boolean) => void;
-    setEvents: (events: Partial<EventManager<any>>) => void;
-    setSize: (width: number, height: number, updateStyle?: boolean, top?: number, left?: number) => void;
-    setDpr: (dpr: Dpr) => void;
-    setFrameloop: (frameloop?: 'always' | 'demand' | 'never') => void;
-    onPointerMissed?: (event: MouseEvent) => void;
-    previousRoot?: UseBoundStore<RootState, StoreApi<RootState>>;
-    internal: InternalState;
-};
-declare const context: React.Context<UseBoundStore<RootState, StoreApi<RootState>>>;
-declare const createStore: (invalidate: (state?: RootState | undefined, frames?: number | undefined) => void, advance: (timestamp: number, runGlobalEffects?: boolean | undefined, state?: RootState | undefined, frame?: THREE.XRFrame | undefined) => void) => UseBoundStore<RootState>;
-export { createStore, context };
+/// <reference types="webxr" />
+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 { Camera } from './utils';
+import { FixedStage, Stage } from './stages';
+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;
+    updateStyle?: boolean;
+};
+export declare type Viewport = Size & {
+    initialDpr: number;
+    dpr: number;
+    factor: number;
+    distance: number;
+    aspect: number;
+};
+export declare type RenderCallback = (state: RootState, delta: number, frame?: XRFrame) => void;
+declare type LegacyAlways = 'always';
+export declare type FrameloopMode = LegacyAlways | 'auto' | 'demand' | 'never';
+declare type FrameloopRender = 'auto' | 'manual';
+export declare type FrameloopLegacy = 'always' | 'demand' | 'never';
+export declare type Frameloop = FrameloopLegacy | {
+    mode?: FrameloopMode;
+    render?: FrameloopRender;
+    maxDelta?: number;
+};
+export declare type Performance = {
+    current: number;
+    min: number;
+    max: number;
+    debounce: number;
+    regress: () => void;
+};
+export declare type Renderer = {
+    render: (scene: THREE.Scene, camera: THREE.Camera) => any;
+};
+export declare const isRenderer: (def: any) => boolean;
+export declare type StageTypes = Stage | FixedStage;
+export declare type InternalState = {
+    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[];
+    lastEvent: React.MutableRefObject<DomEvent | null>;
+    active: boolean;
+    priority: number;
+    frames: number;
+    stages: StageTypes[];
+    render: 'auto' | 'manual';
+    maxDelta: number;
+    subscribe: (callback: React.MutableRefObject<RenderCallback>, priority: number, store: UseBoundStore<RootState, StoreApi<RootState>>) => () => void;
+};
+export declare type RootState = {
+    set: SetState<RootState>;
+    get: GetState<RootState>;
+    gl: THREE.WebGLRenderer;
+    camera: Camera & {
+        manual?: boolean;
+    };
+    scene: THREE.Scene;
+    raycaster: THREE.Raycaster;
+    clock: THREE.Clock;
+    events: EventManager<any>;
+    xr: {
+        connect: () => void;
+        disconnect: () => void;
+    };
+    controls: THREE.EventDispatcher | null;
+    pointer: THREE.Vector2;
+    mouse: THREE.Vector2;
+    legacy: boolean;
+    linear: boolean;
+    flat: boolean;
+    frameloop: FrameloopLegacy;
+    performance: Performance;
+    size: Size;
+    viewport: Viewport & {
+        getCurrentViewport: (camera?: Camera, target?: THREE.Vector3 | Parameters<THREE.Vector3['set']>, size?: Size) => Omit<Viewport, 'dpr' | 'initialDpr'>;
+    };
+    invalidate: (frames?: number) => void;
+    advance: (timestamp: number, runGlobalEffects?: boolean) => void;
+    setEvents: (events: Partial<EventManager<any>>) => void;
+    setSize: (width: number, height: number, updateStyle?: boolean, top?: number, left?: number) => void;
+    setDpr: (dpr: Dpr) => void;
+    setFrameloop: (frameloop: Frameloop) => void;
+    onPointerMissed?: (event: MouseEvent) => void;
+    previousRoot?: UseBoundStore<RootState, StoreApi<RootState>>;
+    internal: InternalState;
+};
+declare const context: React.Context<UseBoundStore<RootState, StoreApi<RootState>>>;
+declare const createStore: (invalidate: (state?: RootState | undefined, frames?: number | undefined) => void, advance: (timestamp: number, runGlobalEffects?: boolean | undefined, state?: RootState | undefined, frame?: XRFrame | undefined) => void) => UseBoundStore<RootState>;
+export { createStore, context };

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

@@ -1,82 +1,81 @@
-import * as THREE from 'three';
-import * as React from 'react';
-import { AttachType, Instance, InstanceProps, LocalState } from './renderer';
-import { Dpr, RootState, Size } from './store';
-export declare type Camera = THREE.OrthographicCamera | THREE.PerspectiveCamera;
-export declare const isOrthographicCamera: (def: Camera) => def is THREE.OrthographicCamera;
-export declare const useIsomorphicLayoutEffect: typeof React.useEffect;
-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<any>;
-    children: React.ReactNode;
-}, {
-    error: boolean;
-}> {
-    state: {
-        error: boolean;
-    };
-    static getDerivedStateFromError: () => {
-        error: boolean;
-    };
-    componentDidCatch(error: any): void;
-    render(): React.ReactNode;
-}
-export declare const DEFAULT = "__default";
-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;
-export declare const getRootState: (obj: THREE.Object3D) => RootState | undefined;
-export declare type EquConfig = {
-    arrays?: 'reference' | 'shallow';
-    objects?: 'reference' | 'shallow';
-    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;
-};
-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;
-export declare function diffProps(instance: Instance, { children: cN, key: kN, ref: rN, ...props }: InstanceProps, { children: cP, key: kP, ref: rP, ...previous }?: InstanceProps, remove?: boolean): DiffSet;
-export declare function applyProps(instance: Instance, data: InstanceProps | DiffSet): Instance;
-export declare function invalidateInstance(instance: Instance): void;
-export declare function updateInstance(instance: Instance): void;
-export declare function updateCamera(camera: Camera & {
-    manual?: boolean;
-}, size: Size): void;
-export declare function setDeep(obj: any, value: any, keys: string[]): any;
+import * as THREE from 'three';
+import * as React from 'react';
+import { AttachType, Instance, InstanceProps, LocalState } from './renderer';
+import { Dpr, RootState, Size } from './store';
+export declare type Camera = THREE.OrthographicCamera | THREE.PerspectiveCamera;
+export declare const isOrthographicCamera: (def: Camera) => def is THREE.OrthographicCamera;
+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<any>;
+    children: React.ReactNode;
+}, {
+    error: boolean;
+}> {
+    state: {
+        error: boolean;
+    };
+    static getDerivedStateFromError: () => {
+        error: boolean;
+    };
+    componentDidCatch(error: any): void;
+    render(): React.ReactNode;
+}
+export declare const DEFAULT = "__default";
+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;
+export declare const getRootState: (obj: THREE.Object3D) => RootState | undefined;
+export declare type EquConfig = {
+    arrays?: 'reference' | 'shallow';
+    objects?: 'reference' | 'shallow';
+    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;
+};
+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;
+export declare function diffProps(instance: Instance, { children: cN, key: kN, ref: rN, ...props }: InstanceProps, { children: cP, key: kP, ref: rP, ...previous }?: InstanceProps, remove?: boolean): DiffSet;
+export declare function applyProps(instance: Instance, data: InstanceProps | DiffSet): Instance;
+export declare function invalidateInstance(instance: Instance): void;
+export declare function updateInstance(instance: Instance): void;
+export declare function updateCamera(camera: Camera & {
+    manual?: boolean;
+}, size: Size): void;

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

@@ -1,11 +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 type { ObjectMap, Camera } from './core/utils';
-export * from './web/Canvas';
-export { createEvents } from './core/events';
-export { createPointerEvents as events } from './web/events';
-export * from './core';
+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 type { ObjectMap, Camera } from './core/utils';
+export * from './web/Canvas';
+export { createEvents } from './core/events';
+export { createPointerEvents as events } from './web/events';
+export * from './core';
+export { Stage, FixedStage, Stages } from './core/stages';

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

@@ -1,8 +1,8 @@
-import * as React from 'react';
-import { View, ViewProps, ViewStyle } from 'react-native';
-import { RenderProps } from '../core';
-export interface Props extends Omit<RenderProps<HTMLCanvasElement>, 'size' | 'dpr'>, ViewProps {
-    children: React.ReactNode;
-    style?: ViewStyle;
-}
-export declare const Canvas: React.ForwardRefExoticComponent<Props & React.RefAttributes<View>>;
+import * as React from 'react';
+import { View, ViewProps, ViewStyle } from 'react-native';
+import { RenderProps } from '../core';
+export interface Props extends Omit<RenderProps<HTMLCanvasElement>, 'size' | 'dpr'>, ViewProps {
+    children: React.ReactNode;
+    style?: ViewStyle;
+}
+export declare const Canvas: React.ForwardRefExoticComponent<Props & React.RefAttributes<View>>;

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

@@ -1,4 +1,4 @@
-import { UseBoundStore } from 'zustand';
-import { RootState } from '../core/store';
-import { EventManager } from '../core/events';
-export declare function createTouchEvents(store: UseBoundStore<RootState>): EventManager<HTMLElement>;
+import { UseBoundStore } from 'zustand';
+import { RootState } from '../core/store';
+import { EventManager } from '../core/events';
+export declare function createTouchEvents(store: UseBoundStore<RootState>): EventManager<HTMLElement>;

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

@@ -1 +1 @@
-export declare function polyfills(): (() => void) | undefined;
+export declare function polyfills(): (() => void) | undefined;

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

@@ -1,10 +1,10 @@
-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 type { ObjectMap, Camera } from './core/utils';
-export * from './native/Canvas';
-export { createTouchEvents as events } from './native/events';
-export * from './core';
+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 type { ObjectMap, Camera } from './core/utils';
+export * from './native/Canvas';
+export { createTouchEvents as events } from './native/events';
+export * from './core';