r3f-vfx 0.0.0 → 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,133 @@
+import * as zustand from 'zustand';
+
+declare const Appearance: Readonly<{
+    DEFAULT: "default";
+    GRADIENT: "gradient";
+    CIRCULAR: "circular";
+}>;
+declare const Blending: Readonly<{
+    NORMAL: any;
+    ADDITIVE: any;
+    MULTIPLY: any;
+    SUBTRACTIVE: any;
+}>;
+declare const EmitterShape: Readonly<{
+    POINT: 0;
+    BOX: 1;
+    SPHERE: 2;
+    CONE: 3;
+    DISK: 4;
+    EDGE: 5;
+}>;
+declare const AttractorType: Readonly<{
+    POINT: 0;
+    VORTEX: 1;
+}>;
+declare const Easing: Readonly<{
+    LINEAR: 0;
+    EASE_IN: 1;
+    EASE_OUT: 2;
+    EASE_IN_OUT: 3;
+}>;
+declare const Lighting: Readonly<{
+    BASIC: "basic";
+    STANDARD: "standard";
+    PHYSICAL: "physical";
+}>;
+declare function bakeCurveToArray(curveData: any, resolution?: number): Float32Array<ArrayBuffer>;
+declare function createCombinedCurveTexture(sizeCurve: any, opacityCurve: any, velocityCurve: any, rotationSpeedCurve: any): any;
+declare const VFXParticles: any;
+
+/**
+ * Higher-order hook for programmatic emitter control
+ *
+ * Usage:
+ * const { emit, burst, start, stop } = useVFXEmitter("sparks");
+ *
+ * // Emit at a position
+ * emit([1, 2, 3], 50);
+ *
+ * // Burst with overrides
+ * burst([0, 0, 0], 100, { colorStart: ["#ff0000"] });
+ */
+declare function useVFXEmitter(name: any): {
+    emit: any;
+    burst: any;
+    start: any;
+    stop: any;
+    clear: any;
+    isEmitting: any;
+    getUniforms: any;
+    getParticles: () => any;
+};
+/**
+ * VFXEmitter - A reusable emitter component that links to a VFXParticles system
+ *
+ * Multiple VFXEmitters can share a single VFXParticles instance without adding
+ * supplementary draw calls. Each emitter just calls spawn() on the shared system.
+ *
+ * The emitter renders a <group> that inherits parent transforms automatically,
+ * so you can place it as a child of any object and it will follow.
+ *
+ * Usage:
+ *
+ * // First, set up a VFXParticles with a name
+ * <VFXParticles name="sparks" maxParticles={1000} autoStart={false} ... />
+ *
+ * // Place emitter as child - it automatically follows parent transforms!
+ * <group ref={playerRef}>
+ *   <VFXEmitter
+ *     name="sparks"
+ *     position={[0, 1, 0]}  // Local offset from parent
+ *     emitCount={5}
+ *     delay={0.1}
+ *   />
+ * </group>
+ *
+ * // Use localDirection to emit relative to parent's rotation
+ * <VFXEmitter
+ *   name="sparks"
+ *   direction={[[0, 0], [0, 0], [-1, -1]]}  // Emit backward in local space
+ *   localDirection={true}  // Direction is transformed by parent's rotation
+ * />
+ *
+ * @param {object} props
+ * @param {string} props.name - Name of the registered VFXParticles system
+ * @param {object} [props.particlesRef] - Direct ref to VFXParticles (alternative to name)
+ * @param {[number, number, number]} [props.position=[0,0,0]] - Local position offset
+ * @param {number} [props.emitCount=10] - Particles to emit per burst
+ * @param {number} [props.delay=0] - Seconds between emissions (0 = every frame)
+ * @param {boolean} [props.autoStart=true] - Start emitting automatically
+ * @param {boolean} [props.loop=true] - Keep emitting (false = emit once)
+ * @param {boolean} [props.localDirection=false] - Transform direction by parent's world rotation
+ * @param {array} [props.direction] - Direction override [[minX,maxX],[minY,maxY],[minZ,maxZ]]
+ * @param {object} [props.overrides] - Per-spawn overrides (size, speed, colors, etc.)
+ * @param {function} [props.onEmit] - Callback fired after each emission
+ */
+declare const VFXEmitter: any;
+
+/**
+ * VFX Store - Centralized management for VFX particle systems
+ *
+ * Allows multiple VFXEmitter components to share a single VFXParticles instance,
+ * avoiding extra draw calls while enabling emission from multiple positions.
+ *
+ * Usage:
+ *
+ * // Register a particle system
+ * <VFXParticles ref={(ref) => registerParticles("sparks", ref)} ... />
+ *
+ * // Or use the VFXParticles name prop with auto-registration
+ * <VFXParticles name="sparks" ... />
+ *
+ * // Emit from anywhere using VFXEmitter (no extra draw calls!)
+ * <VFXEmitter name="sparks" position={[1, 0, 0]} emitCount={10} />
+ * <VFXEmitter name="sparks" position={[-1, 0, 0]} emitCount={5} />
+ *
+ * // Or emit programmatically
+ * const emit = useVFXStore(s => s.emit);
+ * emit("sparks", { x: 0, y: 1, z: 0, count: 20 });
+ */
+declare const useVFXStore: zustand.UseBoundStore<zustand.StoreApi<any>>;
+
+export { Appearance, AttractorType, Blending, Easing, EmitterShape, Lighting, VFXEmitter, VFXParticles, bakeCurveToArray, createCombinedCurveTexture, useVFXEmitter, useVFXStore };