@react-three/drei 11.0.0-alpha.1 → 11.0.0-alpha.3

package/experimental/index.d.mts

@@ -0,0 +1,222 @@
+import * as THREE from 'three';
+import { Color, MeshStandardMaterial, Texture, Matrix4, ColorRepresentation, Object3D } from 'three';
+import { MarchingCubes as MarchingCubes$1 } from 'three/examples/jsm/objects/MarchingCubes';
+import { ThreeElements, ReactThreeFiber, ThreeElement } from '@react-three/fiber';
+import * as React from 'react';
+import { ForwardRefExoticComponent, PropsWithoutRef, RefAttributes } from 'react';
+import { RenderPass } from 'three/examples/jsm/postprocessing/RenderPass';
+import { ShaderPass } from 'three/examples/jsm/postprocessing/ShaderPass';
+import { EffectComposer } from 'three/examples/jsm/postprocessing/EffectComposer';
+import { Line2 } from 'three/examples/jsm/lines/Line2.js';
+
+type ForwardRefComponent<P, T> = ForwardRefExoticComponent<PropsWithoutRef<P> & RefAttributes<T>>;
+
+type MarchingCubesProps = {
+    resolution?: number;
+    maxPolyCount?: number;
+    enableUvs?: boolean;
+    enableColors?: boolean;
+} & Omit<ThreeElements['group'], 'ref'>;
+declare const MarchingCubes: ForwardRefComponent<MarchingCubesProps, MarchingCubes$1>;
+type MarchingCubeProps = {
+    strength?: number;
+    subtract?: number;
+    color?: Color;
+} & ThreeElements['group'];
+declare const MarchingCube: ForwardRefComponent<MarchingCubeProps, THREE.Group>;
+type MarchingPlaneProps = {
+    planeType?: 'x' | 'y' | 'z';
+    strength?: number;
+    subtract?: number;
+} & ThreeElements['group'];
+declare const MarchingPlane: ForwardRefComponent<MarchingPlaneProps, THREE.Group>;
+
+type OutlinesProps = Omit<ThreeElements['group'], 'ref'> & {
+    color?: ReactThreeFiber.Color;
+    screenspace?: boolean;
+    opacity?: number;
+    transparent?: boolean;
+    thickness?: number;
+    angle?: number;
+    clippingPlanes?: THREE.Plane[];
+    toneMapped?: boolean;
+    polygonOffset?: boolean;
+    polygonOffsetFactor?: number;
+    renderOrder?: number;
+};
+declare function Outlines({ color, opacity, transparent, screenspace, toneMapped, polygonOffset, polygonOffsetFactor, renderOrder, thickness, angle, clippingPlanes, ...props }: OutlinesProps): React.JSX.Element;
+
+type SoftShadowMaterialProps = {
+    map: THREE.Texture;
+    color?: ReactThreeFiber.Color;
+    alphaTest?: number;
+    blend?: number;
+};
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        softShadowMaterial: ThreeElements['shaderMaterial'] & SoftShadowMaterialProps;
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        causticsProjectionMaterial: ThreeElements['meshNormalMaterial'] & {
+            viewMatrix?: {
+                value: THREE.Matrix4;
+            };
+            color?: ReactThreeFiber.Color;
+            causticsTexture?: THREE.Texture;
+            causticsTextureB?: THREE.Texture;
+            lightProjMatrix?: THREE.Matrix4;
+            lightViewMatrix?: THREE.Matrix4;
+        };
+    }
+}
+
+type MeshTransmissionMaterialType = Omit<ThreeElements['meshPhysicalMaterial'], 'args' | 'roughness' | 'thickness' | 'transmission'> & {
+    transmission?: number;
+    thickness?: number;
+    roughness?: number;
+    chromaticAberration?: number;
+    anisotropy?: number;
+    anisotropicBlur?: number;
+    distortion?: number;
+    distortionScale?: number;
+    temporalDistortion?: number;
+    buffer?: THREE.Texture;
+    time?: number;
+    args?: [samples: number, transmissionSampler: boolean];
+};
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        meshTransmissionMaterial: MeshTransmissionMaterialType;
+    }
+}
+
+declare class MeshReflectorMaterial extends MeshStandardMaterial {
+    private _tDepth;
+    private _distortionMap;
+    private _tDiffuse;
+    private _tDiffuseBlur;
+    private _textureMatrix;
+    private _hasBlur;
+    private _mirror;
+    private _mixBlur;
+    private _blurStrength;
+    private _minDepthThreshold;
+    private _maxDepthThreshold;
+    private _depthScale;
+    private _depthToBlurRatioBias;
+    private _distortion;
+    private _mixContrast;
+    constructor(parameters?: {});
+    onBeforeCompile(shader: any): void;
+    get tDiffuse(): Texture | null;
+    set tDiffuse(v: Texture | null);
+    get tDepth(): Texture | null;
+    set tDepth(v: Texture | null);
+    get distortionMap(): Texture | null;
+    set distortionMap(v: Texture | null);
+    get tDiffuseBlur(): Texture | null;
+    set tDiffuseBlur(v: Texture | null);
+    get textureMatrix(): Matrix4 | null;
+    set textureMatrix(v: Matrix4 | null);
+    get hasBlur(): boolean;
+    set hasBlur(v: boolean);
+    get mirror(): number;
+    set mirror(v: number);
+    get mixBlur(): number;
+    set mixBlur(v: number);
+    get mixStrength(): number;
+    set mixStrength(v: number);
+    get minDepthThreshold(): number;
+    set minDepthThreshold(v: number);
+    get maxDepthThreshold(): number;
+    set maxDepthThreshold(v: number);
+    get depthScale(): number;
+    set depthScale(v: number);
+    get depthToBlurRatioBias(): number;
+    set depthToBlurRatioBias(v: number);
+    get distortion(): number;
+    set distortion(v: number);
+    get mixContrast(): number;
+    set mixContrast(v: number);
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        meshReflectorMaterialImpl: ThreeElement<typeof MeshReflectorMaterial>;
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        portalMaterialImpl: ThreeElements['shaderMaterial'] & {
+            resolution: ReactThreeFiber.Vector2;
+            blur: number;
+            blend: number;
+            size?: number;
+            sdf?: THREE.Texture;
+            map?: THREE.Texture;
+        };
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        distortMaterialImpl: ThreeElements['meshPhysicalMaterial'] & {
+            time?: number;
+            distort?: number;
+            radius?: number;
+        };
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        wobbleMaterialImpl: ThreeElements['meshStandardMaterial'] & {
+            time?: number;
+            factor?: number;
+            speed?: number;
+        };
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        effectComposer: ThreeElement<typeof EffectComposer>;
+        renderPass: ThreeElement<typeof RenderPass>;
+        shaderPass: ThreeElement<typeof ShaderPass>;
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        segmentObject: ThreeElement<typeof SegmentObject>;
+    }
+}
+declare class SegmentObject {
+    color: THREE.Color;
+    start: THREE.Vector3;
+    end: THREE.Vector3;
+    constructor();
+}
+
+type Settings = {
+    width: number;
+    length: number;
+    decay: number;
+    local: boolean;
+    stride: number;
+    interval: number;
+};
+type TrailProps = {
+    color?: ColorRepresentation;
+    attenuation?: (t: number) => number;
+    target?: React.RefObject<Object3D>;
+} & Partial<Settings>;
+declare function useTrail(target: Object3D, settings: Partial<Settings>, pointCount: number): React.RefObject<Float32Array>;
+declare const Trail: ForwardRefComponent<React.PropsWithChildren<TrailProps>, Line2>;
+
+export { MarchingCube, MarchingCubes, MarchingPlane, Outlines, Trail, useTrail };
+export type { MarchingCubeProps, MarchingCubesProps, MarchingPlaneProps, OutlinesProps, TrailProps };

package/experimental/index.d.ts

@@ -0,0 +1,222 @@
+import * as THREE from 'three';
+import { Color, MeshStandardMaterial, Texture, Matrix4, ColorRepresentation, Object3D } from 'three';
+import { MarchingCubes as MarchingCubes$1 } from 'three/examples/jsm/objects/MarchingCubes';
+import { ThreeElements, ReactThreeFiber, ThreeElement } from '@react-three/fiber';
+import * as React from 'react';
+import { ForwardRefExoticComponent, PropsWithoutRef, RefAttributes } from 'react';
+import { RenderPass } from 'three/examples/jsm/postprocessing/RenderPass';
+import { ShaderPass } from 'three/examples/jsm/postprocessing/ShaderPass';
+import { EffectComposer } from 'three/examples/jsm/postprocessing/EffectComposer';
+import { Line2 } from 'three/examples/jsm/lines/Line2.js';
+
+type ForwardRefComponent<P, T> = ForwardRefExoticComponent<PropsWithoutRef<P> & RefAttributes<T>>;
+
+type MarchingCubesProps = {
+    resolution?: number;
+    maxPolyCount?: number;
+    enableUvs?: boolean;
+    enableColors?: boolean;
+} & Omit<ThreeElements['group'], 'ref'>;
+declare const MarchingCubes: ForwardRefComponent<MarchingCubesProps, MarchingCubes$1>;
+type MarchingCubeProps = {
+    strength?: number;
+    subtract?: number;
+    color?: Color;
+} & ThreeElements['group'];
+declare const MarchingCube: ForwardRefComponent<MarchingCubeProps, THREE.Group>;
+type MarchingPlaneProps = {
+    planeType?: 'x' | 'y' | 'z';
+    strength?: number;
+    subtract?: number;
+} & ThreeElements['group'];
+declare const MarchingPlane: ForwardRefComponent<MarchingPlaneProps, THREE.Group>;
+
+type OutlinesProps = Omit<ThreeElements['group'], 'ref'> & {
+    color?: ReactThreeFiber.Color;
+    screenspace?: boolean;
+    opacity?: number;
+    transparent?: boolean;
+    thickness?: number;
+    angle?: number;
+    clippingPlanes?: THREE.Plane[];
+    toneMapped?: boolean;
+    polygonOffset?: boolean;
+    polygonOffsetFactor?: number;
+    renderOrder?: number;
+};
+declare function Outlines({ color, opacity, transparent, screenspace, toneMapped, polygonOffset, polygonOffsetFactor, renderOrder, thickness, angle, clippingPlanes, ...props }: OutlinesProps): React.JSX.Element;
+
+type SoftShadowMaterialProps = {
+    map: THREE.Texture;
+    color?: ReactThreeFiber.Color;
+    alphaTest?: number;
+    blend?: number;
+};
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        softShadowMaterial: ThreeElements['shaderMaterial'] & SoftShadowMaterialProps;
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        causticsProjectionMaterial: ThreeElements['meshNormalMaterial'] & {
+            viewMatrix?: {
+                value: THREE.Matrix4;
+            };
+            color?: ReactThreeFiber.Color;
+            causticsTexture?: THREE.Texture;
+            causticsTextureB?: THREE.Texture;
+            lightProjMatrix?: THREE.Matrix4;
+            lightViewMatrix?: THREE.Matrix4;
+        };
+    }
+}
+
+type MeshTransmissionMaterialType = Omit<ThreeElements['meshPhysicalMaterial'], 'args' | 'roughness' | 'thickness' | 'transmission'> & {
+    transmission?: number;
+    thickness?: number;
+    roughness?: number;
+    chromaticAberration?: number;
+    anisotropy?: number;
+    anisotropicBlur?: number;
+    distortion?: number;
+    distortionScale?: number;
+    temporalDistortion?: number;
+    buffer?: THREE.Texture;
+    time?: number;
+    args?: [samples: number, transmissionSampler: boolean];
+};
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        meshTransmissionMaterial: MeshTransmissionMaterialType;
+    }
+}
+
+declare class MeshReflectorMaterial extends MeshStandardMaterial {
+    private _tDepth;
+    private _distortionMap;
+    private _tDiffuse;
+    private _tDiffuseBlur;
+    private _textureMatrix;
+    private _hasBlur;
+    private _mirror;
+    private _mixBlur;
+    private _blurStrength;
+    private _minDepthThreshold;
+    private _maxDepthThreshold;
+    private _depthScale;
+    private _depthToBlurRatioBias;
+    private _distortion;
+    private _mixContrast;
+    constructor(parameters?: {});
+    onBeforeCompile(shader: any): void;
+    get tDiffuse(): Texture | null;
+    set tDiffuse(v: Texture | null);
+    get tDepth(): Texture | null;
+    set tDepth(v: Texture | null);
+    get distortionMap(): Texture | null;
+    set distortionMap(v: Texture | null);
+    get tDiffuseBlur(): Texture | null;
+    set tDiffuseBlur(v: Texture | null);
+    get textureMatrix(): Matrix4 | null;
+    set textureMatrix(v: Matrix4 | null);
+    get hasBlur(): boolean;
+    set hasBlur(v: boolean);
+    get mirror(): number;
+    set mirror(v: number);
+    get mixBlur(): number;
+    set mixBlur(v: number);
+    get mixStrength(): number;
+    set mixStrength(v: number);
+    get minDepthThreshold(): number;
+    set minDepthThreshold(v: number);
+    get maxDepthThreshold(): number;
+    set maxDepthThreshold(v: number);
+    get depthScale(): number;
+    set depthScale(v: number);
+    get depthToBlurRatioBias(): number;
+    set depthToBlurRatioBias(v: number);
+    get distortion(): number;
+    set distortion(v: number);
+    get mixContrast(): number;
+    set mixContrast(v: number);
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        meshReflectorMaterialImpl: ThreeElement<typeof MeshReflectorMaterial>;
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        portalMaterialImpl: ThreeElements['shaderMaterial'] & {
+            resolution: ReactThreeFiber.Vector2;
+            blur: number;
+            blend: number;
+            size?: number;
+            sdf?: THREE.Texture;
+            map?: THREE.Texture;
+        };
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        distortMaterialImpl: ThreeElements['meshPhysicalMaterial'] & {
+            time?: number;
+            distort?: number;
+            radius?: number;
+        };
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        wobbleMaterialImpl: ThreeElements['meshStandardMaterial'] & {
+            time?: number;
+            factor?: number;
+            speed?: number;
+        };
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        effectComposer: ThreeElement<typeof EffectComposer>;
+        renderPass: ThreeElement<typeof RenderPass>;
+        shaderPass: ThreeElement<typeof ShaderPass>;
+    }
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        segmentObject: ThreeElement<typeof SegmentObject>;
+    }
+}
+declare class SegmentObject {
+    color: THREE.Color;
+    start: THREE.Vector3;
+    end: THREE.Vector3;
+    constructor();
+}
+
+type Settings = {
+    width: number;
+    length: number;
+    decay: number;
+    local: boolean;
+    stride: number;
+    interval: number;
+};
+type TrailProps = {
+    color?: ColorRepresentation;
+    attenuation?: (t: number) => number;
+    target?: React.RefObject<Object3D>;
+} & Partial<Settings>;
+declare function useTrail(target: Object3D, settings: Partial<Settings>, pointCount: number): React.RefObject<Float32Array>;
+declare const Trail: ForwardRefComponent<React.PropsWithChildren<TrailProps>, Line2>;
+
+export { MarchingCube, MarchingCubes, MarchingPlane, Outlines, Trail, useTrail };
+export type { MarchingCubeProps, MarchingCubesProps, MarchingPlaneProps, OutlinesProps, TrailProps };