@tresjs/post-processing 0.3.0 → 0.5.0

package/README.md

@@ -8,21 +8,14 @@
 </p>
 <br/>
 
-# Post-Processing WIP
+# Post-Processing
 
-> Collection of useful helpers and fully functional, ready-made abstractions for Tres
+> Collection of useful helpers and fully functional, ready-made post-processing effects for Tres
 
-- 💡 Build a 3D scene working only with Vue components.
+- 💡 Build your effects with Vue components only.
 - ⚡️ Powered by Vite
-- 🥰 It brings all the updated features of ThreeJS right awayregardless the version
 - 🦾 Fully Typed
 
-Cientos (Spanish word for "hundreds", pronounced /θjentos/ ) is is a collection of useful ready-to-go helpers and components that are not part of the core package. The name uses the word uses in spanish to multiply by 100, to refer to the potential reach of the package to hold a amazing abstractions.
-
-The postprocessing package uses three-stdlib module under the hood instead of the three/examples/jsm module. This means that you don't need to extend the catalogue of components using the extend method from the `core`, postprocessing does it for you.
-
-It just works. 💯
-
 ## Installation
 
 ```bash
@@ -31,7 +24,7 @@ pnpm i @tresjs/post-processing
 
 ## Docs
 
-Checkout the [docs](https://cientos.tresjs.org/)
+Checkout the [docs](https://postprocessing.tresjs.org/)
 
 ## Demos
 
@@ -39,7 +32,7 @@ Checkout the [docs](https://cientos.tresjs.org/)
 
 ## Contributing
 
-We are open to contributions, please read the [contributing guide](/CONTRIBUTING.md) to get started.
+We are open to contributions, please read the [contributing guide](https://github.com/Tresjs/tres/blob/main/CONTRIBUTING.md) to get started.
 
 ### Build
 

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

@@ -1,7 +1,5 @@
-import type { PropType as __PropType } from 'vue';
-import { Scene } from 'three';
-import { TresCamera, TresObject } from '@tresjs/core';
-export type EffectComposerProps = {
+import type { TresObject } from '@tresjs/core';
+export interface EffectComposerProps {
     enabled?: boolean;
     children?: TresObject[];
     depthBuffer?: boolean;
@@ -11,98 +9,54 @@ export type EffectComposerProps = {
     autoClear?: boolean;
     multisampling?: number;
     frameBufferType?: number;
-    scene?: Scene;
-    camera?: TresCamera;
-};
-declare const _sfc_main: import("vue").DefineComponent<{
-    enabled: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-    children: {
-        type: __PropType<TresObject[] | undefined>;
-        required: false;
-    };
-    depthBuffer: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-    disableNormalPass: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-    stencilBuffer: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-    resolutionScale: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    autoClear: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-    multisampling: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    frameBufferType: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    scene: {
-        type: __PropType<Scene | undefined>;
-        required: false;
-    };
-    camera: {
-        type: __PropType<TresCamera | undefined>;
-        required: false;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    enabled: {
-        type: __PropType<boolean | undefined>;
-        required: false;
+}
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<EffectComposerProps>, {
+    enabled: boolean;
+    autoClear: boolean;
+    frameBufferType: 1016;
+    disableNormalPass: boolean;
+    depthBuffer: undefined;
+    multisampling: number;
+    stencilBuffer: undefined;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<EffectComposerProps>, {
+    enabled: boolean;
+    autoClear: boolean;
+    frameBufferType: 1016;
+    disableNormalPass: boolean;
+    depthBuffer: undefined;
+    multisampling: number;
+    stencilBuffer: undefined;
+}>>>, {
+    enabled: boolean;
+    depthBuffer: boolean;
+    disableNormalPass: boolean;
+    stencilBuffer: boolean;
+    autoClear: boolean;
+    multisampling: number;
+    frameBufferType: number;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
     };
-    children: {
-        type: __PropType<TresObject[] | undefined>;
-        required: false;
-    };
-    depthBuffer: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-    disableNormalPass: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-    stencilBuffer: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-    resolutionScale: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    autoClear: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-    multisampling: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    frameBufferType: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    scene: {
-        type: __PropType<Scene | undefined>;
-        required: false;
-    };
-    camera: {
-        type: __PropType<TresCamera | undefined>;
-        required: false;
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
     };
-}>>, {}, {}>;
-export default _sfc_main;
+};

package/dist/core/composables/effect.d.ts

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

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

@@ -1,6 +1,12 @@
-import type { PropType as __PropType } from 'vue';
-import { BlurPass, KernelSize, BlendFunction } from 'postprocessing';
-export type BloomProps = {
+import { BloomEffect } from 'postprocessing';
+import type { KernelSize, BlendFunction } 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.
@@ -10,27 +16,6 @@ export type BloomProps = {
      * @memberof BloomProps
      */
     intensity?: number;
-    /**
-     *  An efficient, incremental blur pass.
-     *
-     * @type {BlurPass}
-     * @memberof BloomProps
-     */
-    blurPass?: BlurPass;
-    /**
-     * The width of the render
-     *
-     * @type {number}
-     * @memberof BloomProps
-     */
-    width?: number;
-    /**
-     * The height of the render
-     *
-     * @type {number}
-     * @memberof BloomProps
-     */
-    height?: number;
     /**
      * The kernel size.
      *
@@ -67,80 +52,32 @@ export type BloomProps = {
      * @memberof BloomProps
      */
     mipmapBlur?: boolean;
-};
-declare const _sfc_main: import("vue").DefineComponent<{
-    blendFunction: {
-        type: __PropType<BlendFunction | undefined>;
-        required: false;
-    };
-    intensity: {
-        type: __PropType<number | undefined>;
-        required: false;
+}
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<BloomProps>, {
+    mipmapBlur: undefined;
+}>, {
+    pass: import("vue").ShallowRef<import("postprocessing").EffectPass | null>;
+    effect: import("vue").ShallowRef<BloomEffect | null>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<BloomProps>, {
+    mipmapBlur: undefined;
+}>>>, {
+    mipmapBlur: boolean;
+}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
     };
-    blurPass: {
-        type: __PropType<import("postprocessing").KawaseBlurPass | undefined>;
-        required: false;
-    };
-    width: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    height: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    kernelSize: {
-        type: __PropType<KernelSize | undefined>;
-        required: false;
-    };
-    luminanceThreshold: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    luminanceSmoothing: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    mipmapBlur: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    blendFunction: {
-        type: __PropType<BlendFunction | undefined>;
-        required: false;
-    };
-    intensity: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    blurPass: {
-        type: __PropType<import("postprocessing").KawaseBlurPass | undefined>;
-        required: false;
-    };
-    width: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    height: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    kernelSize: {
-        type: __PropType<KernelSize | undefined>;
-        required: false;
-    };
-    luminanceThreshold: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    luminanceSmoothing: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    mipmapBlur: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-}>>, {}, {}>;
-export default _sfc_main;
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

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

@@ -0,0 +1,45 @@
+import type { BlendFunction } from 'postprocessing';
+import { 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<__VLS_TypePropsToRuntimeProps<DepthOfFieldProps>, {
+    pass: import("vue").ShallowRef<import("postprocessing").EffectPass | null>;
+    effect: import("vue").ShallowRef<DepthOfFieldEffect | null>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<DepthOfFieldProps>>>, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

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

@@ -1,6 +1,6 @@
-import type { PropType as __PropType } from 'vue';
-import { GlitchMode, BlendFunction } from 'postprocessing';
-import { Vector2, Texture } from 'three';
+import { GlitchMode, GlitchEffect } from 'postprocessing';
+import type { BlendFunction } from 'postprocessing';
+import type { Vector2, Texture } from 'three';
 export interface GlitchProps {
     blendFunction?: BlendFunction;
     /**
@@ -78,7 +78,7 @@ export interface GlitchProps {
      * @type {Texture}
      * @memberof GlitchProps
      */
-    peturbationMap?: Texture;
+    perturbationMap?: Texture;
     /**
      * The size of the generated noise map. Will be ignored if a perturbation map is provided.
      *
@@ -89,95 +89,17 @@ export interface GlitchProps {
      */
     dtSize?: number;
 }
-declare const _sfc_main: import("vue").DefineComponent<{
-    blendFunction: {
-        type: __PropType<BlendFunction | undefined>;
-        required: false;
-    };
-    delay: {
-        type: __PropType<Vector2 | undefined>;
-        required: false;
-    };
-    duration: {
-        type: __PropType<Vector2 | undefined>;
-        required: false;
-    };
-    strength: {
-        type: __PropType<Vector2 | undefined>;
-        required: false;
-    };
-    mode: {
-        type: __PropType<GlitchMode | undefined>;
-        required: false;
-    };
-    active: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-    ratio: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    columns: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    chromaticAberrationOffset: {
-        type: __PropType<Vector2 | undefined>;
-        required: false;
-    };
-    peturbationMap: {
-        type: __PropType<Texture | undefined>;
-        required: false;
-    };
-    dtSize: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    blendFunction: {
-        type: __PropType<BlendFunction | undefined>;
-        required: false;
-    };
-    delay: {
-        type: __PropType<Vector2 | undefined>;
-        required: false;
-    };
-    duration: {
-        type: __PropType<Vector2 | undefined>;
-        required: false;
-    };
-    strength: {
-        type: __PropType<Vector2 | undefined>;
-        required: false;
-    };
-    mode: {
-        type: __PropType<GlitchMode | undefined>;
-        required: false;
-    };
-    active: {
-        type: __PropType<boolean | undefined>;
-        required: false;
-    };
-    ratio: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    columns: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-    chromaticAberrationOffset: {
-        type: __PropType<Vector2 | undefined>;
-        required: false;
-    };
-    peturbationMap: {
-        type: __PropType<Texture | undefined>;
-        required: false;
-    };
-    dtSize: {
-        type: __PropType<number | undefined>;
-        required: false;
-    };
-}>>, {}, {}>;
-export default _sfc_main;
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<GlitchProps>, {
+    pass: import("vue").ShallowRef<import("postprocessing").EffectPass | null>;
+    effect: import("vue").ShallowRef<GlitchEffect | null>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<GlitchProps>>>, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};