publish v1.0.49

Author: takuma-hmng8

packages/use-shader-fx/build/use-shader-fx.js

@@ -1,6 +1,6 @@
 {
    "name": "@hmng8/use-shader-fx",
-   "version": "1.0.48",
+   "version": "1.0.49",
    "description": "The only difficult part is coding the shaders",
    "main": "./build/use-shader-fx.umd.cjs",
    "module": "./build/use-shader-fx.js",

packages/use-shader-fx/build/use-shader-fx.js.map

@@ -0,0 +1,34 @@
+import * as THREE from "three";
+import { RootState, Size } from "@react-three/fiber";
+export type HooksProps = {
+    size: Size;
+    dpr: number;
+    /** Defines the count of MSAA samples. Can only be used with WebGL 2. Default is 0. */
+    samples?: number;
+};
+/**
+ * @returns {HooksReturn<T, O>}
+ *  updateFx - A function to be called inside `useFrame` that returns a `THREE.Texture`.
+ *  setParams - A function to update the parameters, useful for performance tuning, etc.
+ *  fxObject - An object containing various FX components such as scene, camera, material, and render target.
+ *
+ * @template T The type for the parameters of the hooks.
+ * @template O The type for the FX object.
+ */
+export type HooksReturn<T, O> = [
+    /**
+     * An update function that returns THREE.Texture. Call it inside useFrame
+     * @param props RootState
+     * @param params params of hooks
+     */
+    (props: RootState, updateParams?: T) => THREE.Texture,
+    /**
+     * Function to update params. It can be used for performance control, etc.
+     * @param params params of hooks
+     */
+    (params: T) => void,
+    /**
+     * Contains each part of FX such as scene, camera, material, render target, etc.
+     */
+    O
+];

packages/use-shader-fx/build/use-shader-fx.umd.cjs

@@ -0,0 +1,34 @@
+import * as THREE from "three";
+import { HooksProps, HooksReturn } from "../types";
+export type BlendingParams = {
+    /** Make this texture Blending , default:THREE.Texture */
+    texture?: THREE.Texture;
+    /** map texture, default:THREE.Texture */
+    map?: THREE.Texture;
+    /** map strength , r,g value are affecting , default:0.3 */
+    mapIntensity?: number;
+    /** Alpha blending is performed using the alpha of the set texture. , default:false */
+    alphaMap?: THREE.Texture | false;
+    /** default:(0.5,0.5,0.5) */
+    brightness?: THREE.Vector3;
+    /** default:0.0 */
+    min?: number;
+    /** default:1.0 */
+    max?: number;
+    /** If set, this value will apply color dodge , default: false */
+    dodgeColor?: THREE.Color | false;
+};
+export type BlendingObject = {
+    scene: THREE.Scene;
+    material: THREE.Material;
+    camera: THREE.Camera;
+    renderTarget: THREE.WebGLRenderTarget;
+    output: THREE.Texture;
+};
+export declare const BLENDING_PARAMS: BlendingParams;
+/**
+ * Blend map to texture. You can set the threshold for blending with brightness. You can set the dodge color by setting color.
+If you don't want to reflect the map's color, you can use useFxBlending instead.
+ * @link https://github.com/takuma-hmng8/use-shader-fx#usage
+ */
+export declare const useBlending: ({ size, dpr, samples, }: HooksProps) => HooksReturn<BlendingParams, BlendingObject>;

packages/use-shader-fx/build/use-shader-fx.umd.cjs.map

@@ -0,0 +1,36 @@
+import * as THREE from "three";
+export declare class BlendingMaterial extends THREE.ShaderMaterial {
+    uniforms: {
+        u_texture: {
+            value: THREE.Texture;
+        };
+        u_map: {
+            value: THREE.Texture;
+        };
+        u_alphaMap: {
+            value: THREE.Texture;
+        };
+        u_isAlphaMap: {
+            value: boolean;
+        };
+        u_mapIntensity: {
+            value: number;
+        };
+        u_brightness: {
+            value: THREE.Vector3;
+        };
+        u_min: {
+            value: number;
+        };
+        u_max: {
+            value: number;
+        };
+        u_dodgeColor: {
+            value: THREE.Color;
+        };
+        u_isDodgeColor: {
+            value: boolean;
+        };
+    };
+}
+export declare const useMesh: (scene: THREE.Scene) => BlendingMaterial;

packages/use-shader-fx/package-lock.json

@@ -0,0 +1,24 @@
+import * as THREE from "three";
+import { HooksProps, HooksReturn } from "../types";
+export type BrightnessPickerParams = {
+    /** pick brightness from this texture , default:THREE.Texture */
+    texture?: THREE.Texture;
+    /** default:(0.5,0.5,0.5) */
+    brightness?: THREE.Vector3;
+    /** default:0.0 */
+    min?: number;
+    /** default:1.0 */
+    max?: number;
+};
+export type BrightnessPickerObject = {
+    scene: THREE.Scene;
+    material: THREE.Material;
+    camera: THREE.Camera;
+    renderTarget: THREE.WebGLRenderTarget;
+    output: THREE.Texture;
+};
+export declare const BRIGHTNESSPICKER_PARAMS: BrightnessPickerParams;
+/**
+ * @link https://github.com/takuma-hmng8/use-shader-fx#usage
+ */
+export declare const useBrightnessPicker: ({ size, dpr, samples, }: HooksProps) => HooksReturn<BrightnessPickerParams, BrightnessPickerObject>;