@tresjs/post-processing 2.1.0 → 2.3.0

package/dist/core/pmndrs/BloomPmndrs.vue.d.ts

@@ -1,7 +1,7 @@
 import { BlendFunction, KernelSize, BloomEffect } from 'postprocessing';
 export interface BloomPmndrsProps {
     /**
-     * The blend function of this effect. This prop is not reactive.
+     * The blend function of this effect.
      * @default BlendFunction.SCREEN
      * @type {BlendFunction}
      * @memberof BloomPmndrsProps

package/dist/core/pmndrs/BrightnessContrastPmndrs.vue.d.ts

@@ -0,0 +1,20 @@
+import { BlendFunction, BrightnessContrastEffect } from 'postprocessing';
+export interface BrightnessContrastPmndrsProps {
+    /**
+     * The blend function.
+     */
+    blendFunction?: BlendFunction;
+    /**
+     * The brightness of the effect.
+     */
+    brightness?: number;
+    /**
+     * The contrast of the effect.
+     */
+    contrast?: number;
+}
+declare const _default: import('vue').DefineComponent<BrightnessContrastPmndrsProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<BrightnessContrastEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<BrightnessContrastPmndrsProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/core/pmndrs/ColorDepthPmndrs.vue.d.ts

@@ -0,0 +1,20 @@
+import { BlendFunction, ColorDepthEffect } from 'postprocessing';
+export interface ColorDepthPmndrsProps {
+    /**
+     * The blend function.
+     */
+    blendFunction?: BlendFunction;
+    /**
+     * The color bit depth.
+     */
+    bits?: number;
+    /**
+     * The opacity of the effect.
+     */
+    opacity?: number;
+}
+declare const _default: import('vue').DefineComponent<ColorDepthPmndrsProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<ColorDepthEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<ColorDepthPmndrsProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/core/pmndrs/DepthOfFieldPmndrs.vue.d.ts

@@ -1,7 +1,7 @@
 import { BlendFunction, DepthOfFieldEffect } from 'postprocessing';
 export interface DepthOfFieldPmndrsProps {
     /**
-     * The blend function of this effect. This prop is not reactive.
+     * The blend function of this effect.
      */
     blendFunction?: BlendFunction;
     /**

package/dist/core/pmndrs/DepthPickingPassPmndrs.vue.d.ts

@@ -0,0 +1,18 @@
+import { DepthPackingStrategies } from 'three';
+import { DepthCopyMode, DepthPickingPass } from 'postprocessing';
+export interface DepthPickingPassPmndrsProps {
+    /**
+     * The depth packing strategy.
+     * Default: RGBADepthPacking
+     */
+    depthPacking?: DepthPackingStrategies;
+    /**
+     * The depth copy mode.
+     * Default: DepthCopyMode.SINGLE
+     */
+    mode?: DepthCopyMode;
+}
+declare const _default: import('vue').DefineComponent<DepthPickingPassPmndrsProps, {
+    pass: DepthPickingPass;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<DepthPickingPassPmndrsProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/core/pmndrs/FishEyePmndrs.vue.d.ts

@@ -0,0 +1,30 @@
+import { BlendFunction } from 'postprocessing';
+import { Vector2 } from 'three';
+import { FishEyeEffect } from './custom/fish-eye/index';
+export interface FishEyePmndrsProps {
+    /**
+     * The blend function for the effect.
+     * Determines how this effect blends with other effects.
+     */
+    blendFunction?: BlendFunction;
+    /**
+     * The lens scale.
+     * A Vector2 value or an array of two numbers.
+     */
+    lensS?: Vector2 | [number, number];
+    /**
+     * The lens factor.
+     * A Vector2 value or an array of two numbers.
+     */
+    lensF?: Vector2 | [number, number];
+    /**
+     * The scale of the effect.
+     * A number value.
+     */
+    scale?: number;
+}
+declare const _default: import('vue').DefineComponent<FishEyePmndrsProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<FishEyeEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<FishEyePmndrsProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/core/pmndrs/GodRaysPmndrs.vue.d.ts

@@ -0,0 +1,65 @@
+import { BlendFunction, KernelSize, GodRaysEffect } from 'postprocessing';
+import { Mesh, Points } from 'three';
+export interface GodRaysPmndrsProps {
+    /**
+     * The blend function of this effect.
+     */
+    blendFunction?: BlendFunction;
+    /**
+     * The light source. Must not write depth and has to be flagged as transparent.
+     */
+    lightSource?: Mesh | Points;
+    /**
+     * The opacity of the God Rays.
+     */
+    opacity?: number;
+    /**
+     * The density of the light rays.
+     */
+    density?: number;
+    /**
+     * The decay of the light rays.
+     */
+    decay?: number;
+    /**
+     * The blur kernel size. Has no effect if blur is disabled.
+     */
+    kernelSize?: KernelSize;
+    /**
+     * The resolution scale.
+     */
+    resolutionScale?: number;
+    /**
+     * Whether the god rays should be blurred to reduce artifacts.
+     */
+    blur?: boolean;
+    /**
+     * The horizontal resolution.
+     */
+    resolutionX?: number;
+    /**
+     * The vertical resolution.
+     */
+    resolutionY?: number;
+    /**
+     * The weight of the light rays.
+     */
+    weight?: number;
+    /**
+     * A constant attenuation coefficient.
+     */
+    exposure?: number;
+    /**
+     * The number of samples per pixel.
+     */
+    samples?: number;
+    /**
+     * An upper bound for the saturation of the overall effect.
+     */
+    clampMax?: number;
+}
+declare const _default: import('vue').DefineComponent<GodRaysPmndrsProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<GodRaysEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<GodRaysPmndrsProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/core/pmndrs/GridPmndrs.vue.d.ts

@@ -0,0 +1,20 @@
+import { BlendFunction, GridEffect } from 'postprocessing';
+export interface GridPmndrsProps {
+    /**
+     * The blend function.
+     */
+    blendFunction?: BlendFunction;
+    /**
+     * The scale.
+     */
+    scale?: number;
+    /**
+     * The line width.
+     */
+    lineWidth?: number;
+}
+declare const _default: import('vue').DefineComponent<GridPmndrsProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<GridEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<GridPmndrsProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/core/pmndrs/OutlinePmndrs.vue.d.ts

@@ -27,9 +27,6 @@ export interface OutlinePmndrsProps {
      * The number of samples used for multisample antialiasing. Requires WebGL 2.
      */
     multisampling?: number;
-    /**
-     * The blend function. Use `BlendFunction.ALPHA` for dark outlines.
-     */
     blendFunction?: BlendFunction;
     patternTexture?: Texture;
     resolutionScale?: number;

package/dist/core/pmndrs/composables/useEffectPmndrs.d.ts

@@ -1,6 +1,11 @@
 import { Effect, EffectPass } from 'postprocessing';
 import { Reactive, ShallowRef } from 'vue';
-export declare const useEffectPmndrs: <T extends Effect>(newEffectFunction: () => T, passDependencies: Reactive<object>) => {
+/**
+ * @param newEffectFunction - A function that returns a new effect instance.
+ * @param passDependencies - A reactive object that the pass depends on (usually props). Changes to this object will trigger re-rendering.
+ * @param dependencyFieldsTriggeringRecreation - fields in passDependencies that require effect recreation when changed
+ */
+export declare const useEffectPmndrs: <T extends Effect, D extends Record<PropertyKey, any>>(newEffectFunction: () => T, passDependencies: Reactive<D>, dependencyFieldsTriggeringRecreation?: (keyof D)[]) => {
     pass: ShallowRef<EffectPass | null>;
     effect: ShallowRef<T | null>;
 };

package/dist/core/pmndrs/custom/fish-eye/index.d.ts

@@ -0,0 +1,44 @@
+import { Vector2 } from 'three';
+import { BlendFunction, Effect } from 'postprocessing';
+/**
+ * FishEyeEffect - A custom effect for applying a fish-eye distortion
+ */
+export declare class FishEyeEffect extends Effect {
+    /**
+     * Creates a new FishEyeEffect instance.
+     *
+     * @param {object} [options] - Configuration options for the effect.
+     * @param {BlendFunction} [options.blendFunction] - Blend mode.
+     * @param {Vector2} [options.lensS] - Lens scale.
+     * @param {Vector2} [options.lensF] - Lens factor.
+     * @param {number} [options.scale] - Scale.
+     *
+     */
+    constructor({ blendFunction, lensS, lensF, scale }?: {
+        blendFunction?: BlendFunction | undefined;
+        lensS?: Vector2 | undefined;
+        lensF?: Vector2 | undefined;
+        scale?: number | undefined;
+    });
+    /**
+     * The lensS.
+     *
+     * @type {Vector2}
+     */
+    get lensS(): any;
+    set lensS(value: any);
+    /**
+     * The lensF.
+     *
+     * @type {Vector2}
+     */
+    get lensF(): any;
+    set lensF(value: any);
+    /**
+     * The scale.
+     *
+     * @type {number}
+     */
+    get scale(): any;
+    set scale(value: any);
+}

package/dist/core/pmndrs/index.d.ts

@@ -20,4 +20,10 @@ import { default as TiltShiftPmndrs, TiltShiftPmndrsProps } from './TiltShiftPmn
 import { default as DotScreenPmndrs, DotScreenPmndrsProps } from './DotScreenPmndrs.vue';
 import { default as SepiaPmndrs, SepiaPmndrsProps } from './SepiaPmndrs.vue';
 import { default as LinocutPmndrs, LinocutPmndrsProps } from './LinocutPmndrs.vue';
-export { BloomPmndrs, DepthOfFieldPmndrs, EffectComposerPmndrs, GlitchPmndrs, NoisePmndrs, OutlinePmndrs, PixelationPmndrs, useEffectPmndrs, VignettePmndrs, BarrelBlurPmndrs, HueSaturationPmndrs, ToneMappingPmndrs, ChromaticAberrationPmndrs, ScanlinePmndrs, KuwaharaPmndrs, ColorAveragePmndrs, LensDistortionPmndrs, ShockWavePmndrs, TiltShiftPmndrs, DotScreenPmndrs, SepiaPmndrs, LinocutPmndrs, BloomPmndrsProps, DepthOfFieldPmndrsProps, EffectComposerPmndrsProps, GlitchPmndrsProps, NoisePmndrsProps, OutlinePmndrsProps, PixelationPmndrsProps, VignettePmndrsProps, BarrelBlurPmndrsProps, ToneMappingPmndrsProps, ChromaticAberrationPmndrsProps, HueSaturationPmndrsProps, ScanlinePmndrsProps, KuwaharaPmndrsProps, ColorAveragePmndrsProps, LensDistortionPmndrsProps, ShockWavePmndrsProps, TiltShiftPmndrsProps, DotScreenPmndrsProps, SepiaPmndrsProps, LinocutPmndrsProps, };
+import { default as DepthPickingPassPmndrs, DepthPickingPassPmndrsProps } from './DepthPickingPassPmndrs.vue';
+import { default as GodRaysPmndrs, GodRaysPmndrsProps } from './GodRaysPmndrs.vue';
+import { default as ColorDepthPmndrs, ColorDepthPmndrsProps } from './ColorDepthPmndrs.vue';
+import { default as GridPmndrs, GridPmndrsProps } from './GridPmndrs.vue';
+import { default as FishEyePmndrs, FishEyePmndrsProps } from './FishEyePmndrs.vue';
+import { default as BrightnessContrastPmndrs, BrightnessContrastPmndrsProps } from './BrightnessContrastPmndrs.vue';
+export { BloomPmndrs, DepthOfFieldPmndrs, EffectComposerPmndrs, GlitchPmndrs, NoisePmndrs, OutlinePmndrs, PixelationPmndrs, useEffectPmndrs, VignettePmndrs, BarrelBlurPmndrs, HueSaturationPmndrs, ToneMappingPmndrs, ChromaticAberrationPmndrs, ScanlinePmndrs, KuwaharaPmndrs, ColorAveragePmndrs, LensDistortionPmndrs, ShockWavePmndrs, TiltShiftPmndrs, DotScreenPmndrs, SepiaPmndrs, LinocutPmndrs, DepthPickingPassPmndrs, GodRaysPmndrs, ColorDepthPmndrs, GridPmndrs, FishEyePmndrs, BrightnessContrastPmndrs, BloomPmndrsProps, DepthOfFieldPmndrsProps, EffectComposerPmndrsProps, GlitchPmndrsProps, NoisePmndrsProps, OutlinePmndrsProps, PixelationPmndrsProps, VignettePmndrsProps, BarrelBlurPmndrsProps, ToneMappingPmndrsProps, ChromaticAberrationPmndrsProps, HueSaturationPmndrsProps, ScanlinePmndrsProps, KuwaharaPmndrsProps, ColorAveragePmndrsProps, LensDistortionPmndrsProps, ShockWavePmndrsProps, TiltShiftPmndrsProps, DotScreenPmndrsProps, SepiaPmndrsProps, LinocutPmndrsProps, DepthPickingPassPmndrsProps, GodRaysPmndrsProps, ColorDepthPmndrsProps, GridPmndrsProps, FishEyePmndrsProps, BrightnessContrastPmndrsProps, };

package/dist/core/three/composables/useEffect.d.ts

@@ -3,7 +3,8 @@ import { Reactive, ShallowRef } from 'vue';
 /**
  * @param newPassFunction - A function that returns a new pass instance.
  * @param passDependencies - A reactive object that the pass depends on (usually props). Changes to this object will trigger re-rendering.
+ * @param dependencyFieldsTriggeringRecreation - fields in passDependencies that require effect recreation when changed
  */
-export declare const useEffect: <T extends Pass>(newPassFunction: () => T, passDependencies?: Reactive<object>) => {
+export declare const useEffect: <T extends Pass, D extends Record<PropertyKey, any>>(newPassFunction: () => T, passDependencies?: Reactive<D>, dependencyFieldsTriggeringRecreation?: (keyof D)[]) => {
     pass: ShallowRef<T>;
 };