@tresjs/post-processing 1.0.0-next.0 → 1.0.0

package/README.md

@@ -57,10 +57,6 @@ And then to run the development server on http://localhost:5173
 pnpm run playground
 ```
 
-### Test
-
-TODO...
-
 ### Docs
 
 To run de docs in dev mode

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

@@ -0,0 +1,61 @@
+import { BlendFunction, KernelSize, BloomEffect } from 'postprocessing';
+export interface BloomProps {
+    /**
+     * The blend function of this effect. This prop is not reactive.
+     * @default BlendFunction.SCREEN
+     * @type {BlendFunction}
+     * @memberof BloomProps
+    */
+    blendFunction?: BlendFunction;
+    /**
+     * The intensity of the bloom effect.
+     *
+     * @default 1
+     * @type {number}
+     * @memberof BloomProps
+     */
+    intensity?: number;
+    /**
+     * The kernel size.
+     *
+     * @default KernelSize.LARGE
+     *
+     * @type {KernelSize}
+     * @memberof BloomProps
+     */
+    kernelSize?: KernelSize;
+    /**
+     * The luminance threshold. Raise this value to mask out darker elements in the scene. Range is [0, 1].
+     *
+     * @default 0.9
+     *
+     * @type {number}
+     * @memberof BloomProps
+     */
+    luminanceThreshold?: number;
+    /**
+     * Controls the smoothness of the luminance threshold. Range is [0, 1].
+     *
+     * @default 0.025
+     *
+     * @type {number}
+     * @memberof BloomProps
+     */
+    luminanceSmoothing?: number;
+    /**
+     * Enables mip map blur.
+     *
+     * @default false
+     *
+     * @type {boolean}
+     * @memberof BloomProps
+     */
+    mipmapBlur?: boolean;
+}
+declare const _default: import('vue').DefineComponent<BloomProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<BloomEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<BloomProps> & Readonly<{}>, {
+    mipmapBlur: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

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

@@ -0,0 +1,35 @@
+import { BlendFunction, DepthOfFieldEffect } from 'postprocessing';
+export interface DepthOfFieldProps {
+    /**
+     * The blend function of this effect. This prop is not reactive.
+     */
+    blendFunction?: BlendFunction;
+    /**
+     * The focus distance in world units.
+     */
+    worldFocusDistance?: number;
+    /**
+     * The focus range in world units.
+     */
+    worldFocusRange?: number;
+    /**
+     * The normalized focus distance. Range is [0.0, 1.0].
+     */
+    focusDistance?: number;
+    /**
+     * The focus range. Range is [0.0, 1.0].
+     */
+    focusRange?: number;
+    /**
+     * The scale of the bokeh blur.
+     */
+    bokehScale?: number;
+    resolutionScale?: number;
+    resolutionX?: number;
+    resolutionY?: number;
+}
+declare const _default: import('vue').DefineComponent<DepthOfFieldProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<DepthOfFieldEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<DepthOfFieldProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

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

@@ -0,0 +1,36 @@
+import { EffectComposer } from 'postprocessing';
+import { InjectionKey, ShallowRef } from 'vue';
+export declare const effectComposerInjectionKey: InjectionKey<ShallowRef<EffectComposer | null>>;
+export interface EffectComposerProps {
+    enabled?: boolean;
+    depthBuffer?: boolean;
+    disableNormalPass?: boolean;
+    stencilBuffer?: boolean;
+    resolutionScale?: number;
+    autoClear?: boolean;
+    multisampling?: number;
+    frameBufferType?: number;
+}
+declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<EffectComposerProps, {
+    composer: ShallowRef<EffectComposer | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    render: (...args: any[]) => void;
+}, string, import('vue').PublicProps, Readonly<EffectComposerProps> & Readonly<{
+    onRender?: ((...args: any[]) => any) | undefined;
+}>, {
+    enabled: boolean;
+    depthBuffer: boolean;
+    disableNormalPass: boolean;
+    stencilBuffer: boolean;
+    autoClear: boolean;
+    multisampling: number;
+    frameBufferType: number;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,51 @@
+import { BlendFunction, GlitchEffect, GlitchMode } from 'postprocessing';
+import { Texture, Vector2 } from 'three';
+export interface GlitchProps {
+    blendFunction?: BlendFunction;
+    /**
+     *  The minimum and maximum delay between glitch activations in seconds.
+     */
+    delay?: Vector2;
+    /**
+     * The minimum and maximum duration of a glitch in seconds.
+     */
+    duration?: Vector2;
+    /**
+     * The strength of weak and strong glitches.
+     */
+    strength?: Vector2;
+    /**
+     * The glitch mode. Can be DISABLED | SPORADIC | CONSTANT_MILD | CONSTANT_WILD.
+     */
+    mode?: GlitchMode;
+    /**
+     * Turn the effect on and off.
+     */
+    active?: boolean;
+    /**
+     *
+     * The threshold for strong glitches.
+     */
+    ratio?: number;
+    /**
+     * The scale of the blocky glitch columns.
+     */
+    columns?: number;
+    /**
+     * A chromatic aberration offset. If provided, the glitch effect will influence this offset.
+     */
+    chromaticAberrationOffset?: Vector2;
+    /**
+     * A perturbation map. If none is provided, a noise texture will be created.
+     */
+    perturbationMap?: Texture;
+    /**
+     * The size of the generated noise map. Will be ignored if a perturbation map is provided.
+     */
+    dtSize?: number;
+}
+declare const _default: import('vue').DefineComponent<GlitchProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<GlitchEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<GlitchProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

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

@@ -0,0 +1,16 @@
+import { BlendFunction, NoiseEffect } from 'postprocessing';
+export interface NoiseProps {
+    /**
+     * Whether the noise should be multiplied with the input color.
+     */
+    premultiply?: boolean;
+    blendFunction?: BlendFunction;
+}
+declare const _default: import('vue').DefineComponent<NoiseProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<NoiseEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<NoiseProps> & Readonly<{}>, {
+    blendFunction: BlendFunction;
+    premultiply: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

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

@@ -0,0 +1,46 @@
+import { TresColor } from '@tresjs/core';
+import { BlendFunction, KernelSize, OutlineEffect } from 'postprocessing';
+import { Object3D, Texture } from 'three';
+export interface OutlineProps {
+    /**
+     * The objects in the scene which should have an outline.
+     */
+    outlinedObjects: Object3D[];
+    blur?: boolean;
+    /**
+     * Whether occluded parts of selected objects should be visible
+     */
+    xRay?: boolean;
+    /**
+     * The blur kernel size. Must be used with blur being true.
+     */
+    kernelSize?: KernelSize;
+    /**
+     * The pulse speed. A value of zero disables the pulse effect.
+     */
+    pulseSpeed?: number;
+    resolutionX?: number;
+    resolutionY?: number;
+    edgeStrength?: number;
+    patternScale?: number;
+    /**
+     * 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;
+    hiddenEdgeColor?: TresColor;
+    visibleEdgeColor?: TresColor;
+}
+declare const _default: import('vue').DefineComponent<OutlineProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<OutlineEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<OutlineProps> & Readonly<{}>, {
+    blur: boolean;
+    xRay: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

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

@@ -0,0 +1,12 @@
+import { PixelationEffect } from 'postprocessing';
+export interface PixelationProps {
+    /**
+     * The pixel granularity.
+     */
+    granularity?: number;
+}
+declare const _default: import('vue').DefineComponent<PixelationProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<PixelationEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<PixelationProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

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

@@ -0,0 +1,20 @@
+import { BlendFunction, VignetteEffect, VignetteTechnique } from 'postprocessing';
+export interface VignetteProps {
+    /**
+     * Whether the noise should be multiplied with the input color.
+     */
+    technique?: VignetteTechnique;
+    blendFunction?: BlendFunction;
+    offset: number;
+    darkness: number;
+}
+declare const _default: import('vue').DefineComponent<VignetteProps, {
+    pass: import('vue').ShallowRef<import('postprocessing').EffectPass | null>;
+    effect: import('vue').ShallowRef<VignetteEffect | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<VignetteProps> & Readonly<{}>, {
+    blendFunction: BlendFunction;
+    technique: VignetteTechnique;
+    offset: number;
+    darkness: number;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

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

@@ -0,0 +1,6 @@
+import { Effect, EffectPass } from 'postprocessing';
+import { Reactive, ShallowRef } from 'vue';
+export declare const useEffect: <T extends Effect>(newEffectFunction: () => T, passDependencies: Reactive<object>) => {
+    pass: ShallowRef<EffectPass | null>;
+    effect: ShallowRef<T | null>;
+};

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

@@ -0,0 +1,10 @@
+import { default as Bloom, BloomProps } from './Bloom.vue';
+import { useEffect } from './composables/useEffect';
+import { default as DepthOfField, DepthOfFieldProps } from './DepthOfField.vue';
+import { default as EffectComposer, EffectComposerProps } from './EffectComposer.vue';
+import { default as Glitch, GlitchProps } from './Glitch.vue';
+import { default as Noise, NoiseProps } from './Noise.vue';
+import { default as Outline, OutlineProps } from './Outline.vue';
+import { default as Pixelation, PixelationProps } from './Pixelation.vue';
+import { default as Vignette, VignetteProps } from './Vignette.vue';
+export { Bloom, DepthOfField, EffectComposer, Glitch, Noise, Outline, Pixelation, useEffect, Vignette, BloomProps, DepthOfFieldProps, EffectComposerProps, GlitchProps, NoiseProps, OutlineProps, PixelationProps, VignetteProps, };

package/dist/core/three/EffectComposer.vue.d.ts

@@ -0,0 +1,20 @@
+import { EffectComposer } from 'three/examples/jsm/postprocessing/EffectComposer.js';
+import { InjectionKey, ShallowRef } from 'vue';
+export declare const effectComposerInjectionKey: InjectionKey<ShallowRef<EffectComposer | null>>;
+export interface EffectComposerProps {
+    enabled?: boolean;
+    withoutRenderPass?: boolean;
+}
+declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<EffectComposerProps, {
+    composer: ShallowRef<EffectComposer | null>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<EffectComposerProps> & Readonly<{}>, {
+    enabled: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/core/three/Glitch.vue.d.ts

@@ -0,0 +1,15 @@
+import { GlitchPass } from 'three/examples/jsm/postprocessing/GlitchPass.js';
+export interface GlitchProps {
+    /**
+     * The size of the generated noise map
+     */
+    dtSize?: number;
+    /**
+     * If true, the glitch effect will be more wild 🤪
+     */
+    goWild?: boolean;
+}
+declare const _default: import('vue').DefineComponent<GlitchProps, {
+    pass: import('vue').ShallowRef<GlitchPass>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<GlitchProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/core/three/Halftone.vue.d.ts

@@ -0,0 +1,23 @@
+import { Blending } from 'three/src/constants.js';
+import { HalftonePass } from 'three/examples/jsm/postprocessing/HalftonePass.js';
+export declare enum HalftoneShape {
+    Dot = 1,
+    Ellipse = 2,
+    Line = 3,
+    Square = 4
+}
+export interface HalftoneProps {
+    shape?: HalftoneShape;
+    radius?: number;
+    rotateR?: number;
+    rotateG?: number;
+    rotateB?: number;
+    scatter?: number;
+    blending?: number;
+    greyscale?: boolean;
+    blendingMode?: Blending;
+}
+declare const _default: import('vue').DefineComponent<HalftoneProps, {
+    pass: import('vue').ShallowRef<HalftonePass>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<HalftoneProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/core/three/Output.vue.d.ts

@@ -0,0 +1,5 @@
+import { OutputPass } from 'three/examples/jsm/postprocessing/OutputPass.js';
+declare const _default: import('vue').DefineComponent<{}, {
+    pass: import('vue').ShallowRef<OutputPass>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/core/three/Pixelation.vue.d.ts

@@ -0,0 +1,10 @@
+import { RenderPixelatedPass } from 'three/examples/jsm/postprocessing/RenderPixelatedPass.js';
+export interface PixelationProps {
+    pixelSize: number;
+    depthEdgeStrength?: number;
+    normalEdgeStrength?: number;
+}
+declare const _default: import('vue').DefineComponent<PixelationProps, {
+    pass: import('vue').ShallowRef<RenderPixelatedPass>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<PixelationProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/core/three/SMAA.vue.d.ts

@@ -0,0 +1,9 @@
+import { SMAAPass } from 'three/examples/jsm/postprocessing/SMAAPass.js';
+export interface SMAAProps {
+    width?: number;
+    height?: number;
+}
+declare const _default: import('vue').DefineComponent<SMAAProps, {
+    pass: import('vue').ShallowRef<SMAAPass>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<SMAAProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/core/three/UnrealBloom.vue.d.ts

@@ -0,0 +1,14 @@
+import { UnrealBloomPass } from 'three/examples/jsm/postprocessing/UnrealBloomPass.js';
+export interface UnrealBloomProps {
+    radius?: number;
+    strength?: number;
+    threshold?: number;
+}
+declare const _default: import('vue').DefineComponent<UnrealBloomProps, {
+    pass: import('vue').ShallowRef<UnrealBloomPass>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<UnrealBloomProps> & Readonly<{}>, {
+    radius: number;
+    strength: number;
+    threshold: number;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

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

@@ -0,0 +1,9 @@
+import { Pass } from 'three/examples/jsm/postprocessing/Pass.js';
+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.
+ */
+export declare const useEffect: <T extends Pass>(newPassFunction: () => T, passDependencies?: Reactive<object>) => {
+    pass: ShallowRef<T>;
+};

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

@@ -0,0 +1,9 @@
+import { useEffect } from './composables/useEffect';
+import { default as EffectComposer, EffectComposerProps } from './EffectComposer.vue';
+import { default as Glitch, GlitchProps } from './Glitch.vue';
+import { default as Halftone, HalftoneProps } from './Halftone.vue';
+import { default as Pixelation, PixelationProps } from './Pixelation.vue';
+import { default as Output } from './Output.vue';
+import { default as SMAA, SMAAProps } from './SMAA.vue';
+import { default as UnrealBloom, UnrealBloomProps } from './UnrealBloom.vue';
+export { EffectComposer, Glitch, Halftone, Output, Pixelation, SMAA, UnrealBloom, useEffect, EffectComposerProps, GlitchProps, HalftoneProps, PixelationProps, SMAAProps, UnrealBloomProps, };

package/dist/pmndrs.d.ts

@@ -0,0 +1,2 @@
+export * from './core/pmndrs/index'
+export {}