sparcoon 0.2.0 → 0.3.1

package/dist/nodes/color/FXColorOverLifeNode.js

@@ -0,0 +1,44 @@
+import { buildGradientTexture } from '../../miscellaneous/miscellaneous.js';
+import { checkSRGBSupport } from '../../miscellaneous/webglCapabilities.js';
+import { FXColorNode } from './FXColorNode.js';
+
+const INSTANCES = [];
+class FXColorOverLifeNode extends FXColorNode {
+    constructor(colors) {
+        if (colors.length === 0) {
+            throw new Error("FXColorOverLifeNode: colors array cannot be empty");
+        }
+        super();
+        INSTANCES.push(this);
+        const uniformName = `u_ColorOverLife_${INSTANCES.length - 1}`;
+        this._private_gradientTexture = buildGradientTexture(colors);
+        this.affectsDepth = true;
+        this.cacheKey = "color-over-life";
+        this.uniformDeclarations = [`uniform sampler2D ${uniformName};`];
+        this.uniforms = {
+            [uniformName]: { value: this._private_gradientTexture },
+        };
+        this.helperFunctions = `
+      vec4 sampleColorOverLife(sampler2D gradientTexture) {
+        // Normalized particle age [0, 1] maps to the gradient texture's x-axis
+        float lifetimeRatio = clamp(PARTICLE_AGE / PARTICLE_LIFETIME, 0.0, 1.0);
+        vec4 color = texture2D(gradientTexture, vec2(lifetimeRatio, 0.5));
+
+        // Apply gamma correction when sRGB textures are not natively supported
+        ${checkSRGBSupport() ? "" : "color = vec4(pow(color.rgb, vec3(2.2)), color.a);"}
+
+        return color;
+      }
+    `;
+        this.colorExpression = `sampleColorOverLife(${uniformName})`;
+    }
+    destroy() {
+        this._private_gradientTexture.dispose();
+        const index = INSTANCES.indexOf(this);
+        if (index !== -1) {
+            INSTANCES.splice(index, 1);
+        }
+    }
+}
+
+export { FXColorOverLifeNode };

package/dist/nodes/normal/FXFlatNormalNode.d.ts

@@ -0,0 +1,4 @@
+import { FXNormalNode } from "./FXNormalNode";
+export declare class FXFlatNormalNode extends FXNormalNode {
+    constructor();
+}

package/dist/nodes/normal/FXFlatNormalNode.js

@@ -0,0 +1,14 @@
+import { FXNormalNode } from './FXNormalNode.js';
+
+class FXFlatNormalNode extends FXNormalNode {
+    constructor() {
+        super();
+        this.cacheKey = "flat";
+        this.uniformDeclarations = [];
+        this.uniforms = {};
+        this.helperFunctions = "";
+        this.normalExpression = "vec3(0.0, 0.0, 1.0)";
+    }
+}
+
+export { FXFlatNormalNode };

package/dist/nodes/normal/FXNormalNode.d.ts

@@ -0,0 +1,3 @@
+export declare abstract class FXNormalNode {
+    destroy?(): void;
+}

package/dist/nodes/normal/FXNormalNode.js

@@ -0,0 +1,4 @@
+class FXNormalNode {
+}
+
+export { FXNormalNode };

package/dist/nodes/normal/FXSphericalNormalNode.d.ts

@@ -0,0 +1,4 @@
+import { FXNormalNode } from "./FXNormalNode";
+export declare class FXSphericalNormalNode extends FXNormalNode {
+    constructor();
+}

package/dist/nodes/normal/FXSphericalNormalNode.js

@@ -0,0 +1,19 @@
+import { FXNormalNode } from './FXNormalNode.js';
+
+class FXSphericalNormalNode extends FXNormalNode {
+    constructor() {
+        super();
+        this.cacheKey = "spherical";
+        this.uniformDeclarations = [];
+        this.uniforms = {};
+        this.helperFunctions = `
+      vec3 fxComputeSphericalNormal(vec2 uv) {
+        vec2 centeredUV = uv * 2.0 - 1.0;
+        return normalize(vec3(centeredUV, sqrt(max(0.0, 1.0 - dot(centeredUV, centeredUV)))));
+      }
+    `;
+        this.normalExpression = "fxComputeSphericalNormal(p_uv)";
+    }
+}
+
+export { FXSphericalNormalNode };

package/dist/nodes/texture/FXAnimatedTextureNode.d.ts

@@ -0,0 +1,12 @@
+import type { Texture } from "three";
+import { FXTextureNode } from "./FXTextureNode";
+export interface FXAnimatedTextureNodeOptions {
+    texture: Texture;
+    columns: number;
+    rows: number;
+    interpolate?: boolean;
+}
+export declare class FXAnimatedTextureNode extends FXTextureNode {
+    constructor({ texture, columns, rows, interpolate }: FXAnimatedTextureNodeOptions);
+    destroy(): void;
+}

package/dist/nodes/texture/FXAnimatedTextureNode.js

@@ -0,0 +1,88 @@
+import { checkSRGBSupport } from '../../miscellaneous/webglCapabilities.js';
+import { FXTextureNode } from './FXTextureNode.js';
+
+const INSTANCES = [];
+class FXAnimatedTextureNode extends FXTextureNode {
+    constructor({ texture, columns, rows, interpolate = false }) {
+        super();
+        INSTANCES.push(this);
+        const idx = INSTANCES.length - 1;
+        const uniformTexture = `u_AnimatedTexture_${idx}`;
+        const uniformColumns = `u_AnimatedTextureColumns_${idx}`;
+        const uniformRows = `u_AnimatedTextureRows_${idx}`;
+        const gammaCorrection = checkSRGBSupport()
+            ? ""
+            : "color = vec4(pow(color.rgb, vec3(2.2)), color.a);";
+        this.affectsDepth = true;
+        this.cacheKey = interpolate ? "animated-interpolated" : "animated";
+        this.uniformDeclarations = [
+            `uniform sampler2D ${uniformTexture};`,
+            `uniform float ${uniformColumns};`,
+            `uniform float ${uniformRows};`,
+        ];
+        this.uniforms = {
+            [uniformTexture]: { value: texture },
+            [uniformColumns]: { value: columns },
+            [uniformRows]: { value: rows },
+        };
+        this.helperFunctions = interpolate
+            ? `
+        vec2 frameToUV(vec2 uv, float frame, float columns, float rows) {
+          float column = mod(frame, columns);
+          float row = floor(frame / columns);
+          return vec2((column + uv.x) / columns, 1.0 - (row + 1.0 - uv.y) / rows);
+        }
+
+        vec4 sampleAnimatedTexture(sampler2D spriteSheet, vec2 uv, float columns, float rows) {
+          float totalFrames = columns * rows;
+
+          // Fractional frame position drives both frame selection and blend weight
+          float exactFrame = PARTICLE_AGE / PARTICLE_LIFETIME * totalFrames;
+          float currentFrame = clamp(floor(exactFrame), 0.0, totalFrames - 1.0);
+          float nextFrame    = clamp(currentFrame + 1.0, 0.0, totalFrames - 1.0);
+          float blendWeight  = fract(exactFrame);
+
+          vec4 color = mix(
+            texture2D(spriteSheet, frameToUV(uv, currentFrame, columns, rows)),
+            texture2D(spriteSheet, frameToUV(uv, nextFrame,    columns, rows)),
+            blendWeight
+          );
+
+          // Apply gamma correction when sRGB textures are not natively supported
+          ${gammaCorrection}
+
+          return color;
+        }
+      `
+            : `
+        vec4 sampleAnimatedTexture(sampler2D spriteSheet, vec2 uv, float columns, float rows) {
+          // Determine which frame to display based on normalized particle age
+          float totalFrames = columns * rows;
+          float frame = floor(PARTICLE_AGE / PARTICLE_LIFETIME * totalFrames);
+          frame = clamp(frame, 0.0, totalFrames - 1.0);
+
+          // Locate the frame's column and row in the sprite sheet grid
+          float column = mod(frame, columns);
+          float row = floor(frame / columns);
+
+          // Remap UV to the frame's tile region within the sprite sheet
+          vec2 frameUV = vec2((column + uv.x) / columns, 1.0 - (row + 1.0 - uv.y) / rows);
+          vec4 color = texture2D(spriteSheet, frameUV);
+
+          // Apply gamma correction when sRGB textures are not natively supported
+          ${gammaCorrection}
+
+          return color;
+        }
+      `;
+        this.colorExpression = `sampleAnimatedTexture(${uniformTexture}, p_uv, ${uniformColumns}, ${uniformRows})`;
+    }
+    destroy() {
+        const index = INSTANCES.indexOf(this);
+        if (index !== -1) {
+            INSTANCES.splice(index, 1);
+        }
+    }
+}
+
+export { FXAnimatedTextureNode };

package/dist/nodes/texture/FXStaticTextureNode.d.ts

@@ -0,0 +1,6 @@
+import type { Texture } from "three";
+import { FXTextureNode } from "./FXTextureNode";
+export declare class FXStaticTextureNode extends FXTextureNode {
+    constructor(texture: Texture);
+    destroy(): void;
+}

package/dist/nodes/texture/FXStaticTextureNode.js

@@ -0,0 +1,34 @@
+import { checkSRGBSupport } from '../../miscellaneous/webglCapabilities.js';
+import { FXTextureNode } from './FXTextureNode.js';
+
+const INSTANCES = [];
+class FXStaticTextureNode extends FXTextureNode {
+    constructor(texture) {
+        super();
+        INSTANCES.push(this);
+        const uniformName = `u_StaticTexture_${INSTANCES.length - 1}`;
+        this.affectsDepth = true;
+        this.cacheKey = "static";
+        this.uniformDeclarations = [`uniform sampler2D ${uniformName};`];
+        this.uniforms = {
+            [uniformName]: { value: texture },
+        };
+        this.helperFunctions = `
+      vec4 sampleStaticTexture(sampler2D colorTexture, vec2 uv) {
+        vec4 color = texture2D(colorTexture, uv);
+        // Apply gamma correction when sRGB textures are not natively supported
+        ${checkSRGBSupport() ? "" : "color = vec4(pow(color.rgb, vec3(2.2)), color.a);"}
+        return color;
+      }
+    `;
+        this.colorExpression = `sampleStaticTexture(${uniformName}, p_uv)`;
+    }
+    destroy() {
+        const index = INSTANCES.indexOf(this);
+        if (index !== -1) {
+            INSTANCES.splice(index, 1);
+        }
+    }
+}
+
+export { FXStaticTextureNode };

package/dist/nodes/texture/FXTextureNode.d.ts

@@ -0,0 +1,3 @@
+export declare abstract class FXTextureNode {
+    destroy?(): void;
+}

package/dist/nodes/texture/FXTextureNode.js

@@ -0,0 +1,8 @@
+class FXTextureNode {
+    constructor() {
+        /** @internal */
+        this.affectsDepth = false;
+    }
+}
+
+export { FXTextureNode };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sparcoon",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "",
   "keywords": [
     "particles",

package/dist/materials/FXMaterial.js

@@ -1,21 +0,0 @@
-import { buildDepthMaterial } from './FXMaterial.Internal.js';
-
-class FXMaterial {
-    constructor(options = {}) {
-        this.colorNodes = options.colorNodes ?? [];
-        this._private_depthAlphaTest = options.depthAlphaTest ?? 0.5;
-        this._private_useDepthAlphaHash = options.useDepthAlphaHash ?? false;
-        this._private_useSphericalDepth = options.useSphericalDepth ?? false;
-    }
-    destroy() {
-        for (const node of this.colorNodes) {
-            node.destroy?.();
-        }
-    }
-    /** @internal */
-    buildDepthMaterial() {
-        return buildDepthMaterial(this.colorNodes, this._private_depthAlphaTest, this._private_useDepthAlphaHash, this._private_useSphericalDepth);
-    }
-}
-
-export { FXMaterial };

package/dist/materials/color-nodes/FXAnimatedTextureNode.d.ts

@@ -1,10 +0,0 @@
-import type { Texture } from "three";
-import { FXColorNode } from "./FXColorNode";
-export interface FXAnimatedTextureNodeOptions {
-    texture: Texture;
-    cols: number;
-    rows: number;
-}
-export declare class FXAnimatedTextureNode extends FXColorNode {
-    constructor({ texture, cols, rows }: FXAnimatedTextureNodeOptions);
-}

package/dist/materials/color-nodes/FXAnimatedTextureNode.js

@@ -1,41 +0,0 @@
-import { FXColorNode } from './FXColorNode.js';
-
-class FXAnimatedTextureNode extends FXColorNode {
-    constructor({ texture, cols, rows }) {
-        super();
-        /** @internal */
-        this.cacheKey = "animated";
-        /** @internal */
-        this.uniformDeclarations = [
-            "uniform sampler2D u_AnimatedTexture;",
-            "uniform float u_AnimatedTextureCols;",
-            "uniform float u_AnimatedTextureRows;",
-        ];
-        /** @internal */
-        this.helperFunctions = `
-    vec4 _fx_sampleAnimated(sampler2D tex, vec2 uv, float cols, float rows) {
-      float totalFrames = cols * rows;
-      float frame = floor(PARTICLE_AGE / PARTICLE_LIFETIME * totalFrames);
-      frame = clamp(frame, 0.0, totalFrames - 1.0);
-      float col = mod(frame, cols);
-      float row = floor(frame / cols);
-      vec2 frameUV = vec2((col + uv.x) / cols, 1.0 - (row + 1.0 - uv.y) / rows);
-      return texture2D(tex, frameUV);
-    }
-  `;
-        /** @internal */
-        this.colorExpression = "_fx_sampleAnimated(u_AnimatedTexture, p_uv, u_AnimatedTextureCols, u_AnimatedTextureRows)";
-        /** @internal */
-        this.affectsDepth = true;
-        this.uniforms = {
-            // eslint-disable-next-line @typescript-eslint/naming-convention
-            u_AnimatedTexture: { value: texture },
-            // eslint-disable-next-line @typescript-eslint/naming-convention
-            u_AnimatedTextureCols: { value: cols },
-            // eslint-disable-next-line @typescript-eslint/naming-convention
-            u_AnimatedTextureRows: { value: rows },
-        };
-    }
-}
-
-export { FXAnimatedTextureNode };

package/dist/materials/color-nodes/FXColorOverLifeNode.js

@@ -1,38 +0,0 @@
-import { buildGradientTexture } from '../../miscellaneous/miscellaneous.js';
-import { checkSRGBSupport } from '../../miscellaneous/webglCapabilities.js';
-import { FXColorNode } from './FXColorNode.js';
-
-class FXColorOverLifeNode extends FXColorNode {
-    constructor(colors) {
-        if (colors.length === 0) {
-            throw new Error("FXColorOverLifeNode: colors array cannot be empty");
-        }
-        super();
-        /** @internal */
-        this.affectsDepth = true;
-        /** @internal */
-        this.cacheKey = "color-over-life";
-        /** @internal */
-        this.uniformDeclarations = ["uniform sampler2D u_ColorOverLife;"];
-        /** @internal */
-        this.colorExpression = "_fx_sampleColorOverLife(u_ColorOverLife)";
-        this._private_gradientTexture = buildGradientTexture(colors);
-        this.uniforms = {
-            // eslint-disable-next-line @typescript-eslint/naming-convention
-            u_ColorOverLife: { value: this._private_gradientTexture },
-        };
-        this.helperFunctions = `
-      vec4 _fx_sampleColorOverLife(sampler2D tex) {
-        float t = clamp(PARTICLE_AGE / PARTICLE_LIFETIME, 0.0, 1.0);
-        vec4 c = texture2D(tex, vec2(t, 0.5));
-        ${checkSRGBSupport() ? "" : "c = vec4(pow(c.rgb, vec3(2.2)), c.a);"}
-        return c;
-      }
-    `;
-    }
-    destroy() {
-        this._private_gradientTexture.dispose();
-    }
-}
-
-export { FXColorOverLifeNode };

package/dist/materials/color-nodes/FXStaticTextureNode.d.ts

@@ -1,5 +0,0 @@
-import type { Texture } from "three";
-import { FXColorNode } from "./FXColorNode";
-export declare class FXStaticTextureNode extends FXColorNode {
-    constructor(texture: Texture);
-}

package/dist/materials/color-nodes/FXStaticTextureNode.js

@@ -1,23 +0,0 @@
-import { FXColorNode } from './FXColorNode.js';
-
-class FXStaticTextureNode extends FXColorNode {
-    constructor(texture) {
-        super();
-        /** @internal */
-        this.cacheKey = "static";
-        /** @internal */
-        this.uniformDeclarations = ["uniform sampler2D u_StaticTexture;"];
-        /** @internal */
-        this.helperFunctions = "";
-        /** @internal */
-        this.colorExpression = "texture2D(u_StaticTexture, p_uv)";
-        /** @internal */
-        this.affectsDepth = true;
-        this.uniforms = {
-            // eslint-disable-next-line @typescript-eslint/naming-convention
-            u_StaticTexture: { value: texture },
-        };
-    }
-}
-
-export { FXStaticTextureNode };

package/dist/materials/miscellaneous.d.ts

@@ -1 +0,0 @@
-export declare const PARTICLE_DEFINES = "\n  #define PARTICLE_POSITION_X p_builtin[0][0]\n  #define PARTICLE_POSITION_Y p_builtin[0][1]\n  #define PARTICLE_POSITION_Z p_builtin[0][2]\n\n  #define PARTICLE_VELOCITY_X p_builtin[0][3]\n  #define PARTICLE_VELOCITY_Y p_builtin[1][0]\n  #define PARTICLE_VELOCITY_Z p_builtin[1][1]\n\n  #define PARTICLE_SCALE_X p_builtin[1][2]\n  #define PARTICLE_SCALE_Y p_builtin[1][3]\n  #define PARTICLE_SCALE_Z p_builtin[2][0]\n\n  #define PARTICLE_ROTATION p_builtin[2][1]\n  #define PARTICLE_TORQUE p_builtin[2][2]\n\n  #define PARTICLE_LIFETIME p_builtin[2][3]\n  #define PARTICLE_AGE p_builtin[3][0]\n\n  #define PARTICLE_RANDOM_A p_builtin[3][1]\n  #define PARTICLE_RANDOM_B p_builtin[3][2]\n  #define PARTICLE_RANDOM_C p_builtin[3][3]\n";

package/dist/materials/miscellaneous.js

@@ -1,25 +0,0 @@
-const PARTICLE_DEFINES = `
-  #define PARTICLE_POSITION_X p_builtin[0][0]
-  #define PARTICLE_POSITION_Y p_builtin[0][1]
-  #define PARTICLE_POSITION_Z p_builtin[0][2]
-
-  #define PARTICLE_VELOCITY_X p_builtin[0][3]
-  #define PARTICLE_VELOCITY_Y p_builtin[1][0]
-  #define PARTICLE_VELOCITY_Z p_builtin[1][1]
-
-  #define PARTICLE_SCALE_X p_builtin[1][2]
-  #define PARTICLE_SCALE_Y p_builtin[1][3]
-  #define PARTICLE_SCALE_Z p_builtin[2][0]
-
-  #define PARTICLE_ROTATION p_builtin[2][1]
-  #define PARTICLE_TORQUE p_builtin[2][2]
-
-  #define PARTICLE_LIFETIME p_builtin[2][3]
-  #define PARTICLE_AGE p_builtin[3][0]
-
-  #define PARTICLE_RANDOM_A p_builtin[3][1]
-  #define PARTICLE_RANDOM_B p_builtin[3][2]
-  #define PARTICLE_RANDOM_C p_builtin[3][3]
-`;
-
-export { PARTICLE_DEFINES };