@adatechnology/game-vfx-three 0.3.5 → 0.4.0

package/dist/index.d.ts

@@ -49,6 +49,12 @@ interface VfxRendererOptions {
     pointScale?: number;
     /** Multiplies the blast and fire lights. Default `Math.PI`: three.js r155+ lights are physical, the Lab's were not (r128). */
     lightScale?: number;
+    /** Caps on the marks kept on the ground; once one is full the oldest is reused for the next, so nothing grows and nothing is allocated. Defaults: 64 scorch and dirt, 512 rocks, 256 blood. */
+    markLimits?: {
+        readonly maxGroundMarks?: number;
+        readonly maxRocks?: number;
+        readonly maxBlood?: number;
+    };
 }
 /** The world's counters flattened (`lastBlast` becomes `last_puffs`, `last_sparks`, `last_chunks`, `last_lights`), plus `drawCalls`. */
 type VfxRendererStats = Readonly<Record<string, number>>;
@@ -146,7 +152,9 @@ interface MarkLayer {
     /** The shared rock and plate shapes, so the debris and the rim rocks use the same geometry. */
     handle(event: MarkEvent): void;
     update(dt: number): void;
-    /** The meshes in the group right now. */
+    /** Puts the instanced meshes in the scene now, so their shader programs link while loading instead of at the first mark. */
+    prepare(): void;
+    /** The draw calls the marks cost right now. */
     count(): number;
     dispose(): void;
 }
@@ -155,6 +163,12 @@ interface MarkLayerOptions {
     readonly createCanvas: (() => CanvasLike) | undefined;
     readonly rockGeometry: THREE_NS.BufferGeometry;
     readonly plateGeometry: THREE_NS.BufferGeometry;
+    /** Scorch and dirt meshes alive at once; the oldest is reused for the next. Default 64. */
+    readonly maxGroundMarks?: number;
+    /** Rim rocks and plates alive at once (each shape has its own instanced mesh of this size); the oldest is overwritten. Default 512. */
+    readonly maxRocks?: number;
+    /** Blood pools alive at once; the oldest is overwritten. Default 256. */
+    readonly maxBlood?: number;
 }
 /**
  * The scorch, dirt, rim rocks and blood of the Lab as meshes (L443-476). A scorch or dirt mesh follows the ground as it was the moment the mark was