@onerjs/core 8.56.4 → 9.0.1

package/Particles/thinParticleSystem.pure.js

@@ -1,5 +1,6 @@
 /** This file must only contain pure code and pure imports */
 import { ColorGradient, Color3Gradient, GradientHelper } from "../Misc/gradients.js";
+import { Logger } from "../Misc/logger.js";
 import { Observable } from "../Misc/observable.pure.js";
 import { Vector3, Matrix, TmpVectors } from "../Maths/math.vector.pure.js";
 import { VertexBuffer, Buffer } from "../Buffers/buffer.pure.js";
@@ -19,6 +20,7 @@ import { Lerp } from "../Maths/math.scalar.functions.js";
 import { PrepareSamplersForImageProcessing, PrepareUniformsForImageProcessing } from "../Materials/imageProcessingConfiguration.functions.js";
 import { _CreateAngleData, _CreateAngleGradientsData, _CreateColorData, _CreateColorDeadData, _CreateColorGradientsData, _CreateCustomDirectionData, _CreateCustomPositionData, _CreateDirectionData, _CreateDragData, _CreateEmitPowerData, _CreateIsLocalData, _CreateLifeGradientsData, _CreateLifetimeData, _CreateLimitVelocityGradients, _CreateNoiseData, _CreatePositionData, _CreateRampData, _CreateSheetData, _CreateSizeData, _CreateSizeGradientsData, _CreateStartSizeGradientsData, _CreateVelocityGradients, _ProcessAngularSpeed, _ProcessAngularSpeedGradients, _ProcessColor, _ProcessColorGradients, _ProcessDirection, _ProcessDragGradients, _ProcessGravity, _ProcessLimitVelocityGradients, _ProcessNoise, _ProcessPosition, _ProcessRemapGradients, _ProcessSizeGradients, _ProcessVelocityGradients, } from "./thinParticleSystem.function.js";
 import { _ConnectAfter, _ConnectBefore, _RemoveFromQueue } from "./Queue/executionQueue.js";
+import { MaterialHelperGeometryRendering } from "../Materials/materialHelper.geometryrendering.js";
 /**
  * This represents a thin particle system in Babylon.
  * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
@@ -269,6 +271,13 @@ export class ThinParticleSystem extends BaseParticleSystem {
             return;
         }
         this._noiseTexture = value ?? null;
+        // Invalidate the cached readback: a buffer and its dimensions must always come from the same texture.
+        this._noiseTextureSize = null;
+        this._noiseTextureData = null;
+        // A pending readback belongs to the previous assignment: discard its completion and free the gate.
+        this._noiseTextureFetchToken++;
+        this._noiseTextureFetchInFlight = null;
+        this._noiseTextureFetchInternalTexture = null;
         if (!value) {
             if (this._noiseCreation) {
                 _RemoveFromQueue(this._noiseCreation);
@@ -338,10 +347,15 @@ export class ThinParticleSystem extends BaseParticleSystem {
         this._noiseTextureSize = null;
         /** @internal */
         this._noiseTextureData = null;
+        this._noiseTextureFetchInFlight = null;
+        this._noiseTextureFetchInternalTexture = null;
+        this._noiseTextureFetchToken = 0;
+        this._noiseTextureReadbackFailureLogged = false;
         this._particles = new Array();
         this._stockParticles = new Array();
         this._newPartsExcess = 0;
         this._vertexBuffers = {};
+        this._renderPassObserver = null;
         /** @internal */
         this._scaledColorStep = new Color4(0, 0, 0, 0);
         /** @internal */
@@ -530,13 +544,55 @@ export class ThinParticleSystem extends BaseParticleSystem {
         this.particleEmitterType = new BoxParticleEmitter();
         // Update
         this.updateFunction = (particles) => {
-            if (this.noiseTexture) {
-                // We need to get texture data back to CPU
-                this._noiseTextureSize = this.noiseTexture.getSize();
-                // eslint-disable-next-line @typescript-eslint/no-floating-promises, github/no-then
-                this.noiseTexture.getContent()?.then((data) => {
-                    this._noiseTextureData = data;
-                });
+            const noiseTexture = this.noiseTexture;
+            const noiseInternalTexture = noiseTexture?.getInternalTexture() ?? null;
+            if (noiseTexture && (this._noiseTextureFetchInFlight !== noiseTexture || this._noiseTextureFetchInternalTexture !== noiseInternalTexture)) {
+                // One readback per render target in flight to avoid piling up a promise per frame.
+                const noiseContent = noiseTexture.getContent();
+                if (noiseContent) {
+                    const textureSize = noiseTexture.getSize();
+                    // getSize() returns a shared object: snapshot it so a later resize cannot mutate the published pair.
+                    const noiseSize = { width: textureSize.width, height: textureSize.height };
+                    // Gate completions on a per-request token: texture identity cannot tell two readbacks apart.
+                    const fetchToken = ++this._noiseTextureFetchToken;
+                    this._noiseTextureFetchInFlight = noiseTexture;
+                    this._noiseTextureFetchInternalTexture = noiseInternalTexture;
+                    // eslint-disable-next-line github/no-then
+                    noiseContent.then((data) => {
+                        if (this._noiseTextureFetchToken !== fetchToken) {
+                            // Superseded by a newer readback.
+                            return;
+                        }
+                        this._noiseTextureFetchInFlight = null;
+                        this._noiseTextureFetchInternalTexture = null;
+                        if (this.noiseTexture !== noiseTexture || noiseTexture.getInternalTexture() !== noiseInternalTexture) {
+                            // Reassigned or resized while pending: discard the stale buffer.
+                            return;
+                        }
+                        this._noiseTextureReadbackFailureLogged = false;
+                        const buffer = data;
+                        if (buffer.length !== noiseSize.width * noiseSize.height * 4) {
+                            // Buffer for another size (texture resized while pending): retry on the next update.
+                            return;
+                        }
+                        this._noiseTextureSize = noiseSize;
+                        this._noiseTextureData = buffer;
+                    }, () => {
+                        if (this._noiseTextureFetchToken !== fetchToken) {
+                            return;
+                        }
+                        this._noiseTextureFetchInFlight = null;
+                        this._noiseTextureFetchInternalTexture = null;
+                        if (this.noiseTexture !== noiseTexture || noiseTexture.getInternalTexture() !== noiseInternalTexture) {
+                            return;
+                        }
+                        // Retry on the next update, reporting the failure once per streak.
+                        if (!this._noiseTextureReadbackFailureLogged) {
+                            this._noiseTextureReadbackFailureLogged = true;
+                            Logger.Warn(`Noise texture readback failed for "${noiseTexture.name}"; it will be retried on the next update`);
+                        }
+                    });
+                }
             }
             const sameParticleArray = particles === this._particles;
             for (let index = 0; index < particles.length; index++) {
@@ -568,7 +624,9 @@ export class ThinParticleSystem extends BaseParticleSystem {
                     // Recycle by swapping with last particle
                     this._emitFromParticle(particle);
                     if (particle._properties.attachedSubEmitters) {
-                        for (const subEmitter of particle._properties.attachedSubEmitters) {
+                        const attachedSubEmitters = particle._properties.attachedSubEmitters;
+                        for (let subEmitterIndex = 0; subEmitterIndex < attachedSubEmitters.length; subEmitterIndex++) {
+                            const subEmitter = attachedSubEmitters[subEmitterIndex];
                             subEmitter.particleSystem.disposeOnStop = true;
                             subEmitter.particleSystem.stop();
                         }
@@ -1425,7 +1483,12 @@ export class ThinParticleSystem extends BaseParticleSystem {
         }
         else {
             const emitterPosition = this.emitter;
-            this._emitterWorldMatrix = Matrix.Translation(emitterPosition.x, emitterPosition.y, emitterPosition.z);
+            // Owned matrix: _emitterWorldMatrix may alias a live mesh world matrix after an emitter switch.
+            if (!this._emitterTranslationMatrix) {
+                this._emitterTranslationMatrix = new Matrix();
+            }
+            Matrix.TranslationToRef(emitterPosition.x, emitterPosition.y, emitterPosition.z, this._emitterTranslationMatrix);
+            this._emitterWorldMatrix = this._emitterTranslationMatrix;
         }
         this._emitterWorldMatrix.invertToRef(this._emitterInverseWorldMatrix);
         this.updateFunction(this._particles);
@@ -1487,6 +1550,9 @@ export class ThinParticleSystem extends BaseParticleSystem {
         if (blendMode === BaseParticleSystem.BLENDMODE_MULTIPLY) {
             defines.push("#define BLENDMULTIPLYMODE");
         }
+        if (this.isLocal) {
+            defines.push("#define LOCAL");
+        }
         if (this._useRampGradients) {
             defines.push("#define RAMPGRADIENT");
         }
@@ -1536,6 +1602,7 @@ export class ThinParticleSystem extends BaseParticleSystem {
      * @internal
      */
     _getWrapper(blendMode) {
+        var _a;
         const customWrapper = this._getCustomDrawWrapper(blendMode);
         if (customWrapper?.effect) {
             return customWrapper;
@@ -1544,9 +1611,22 @@ export class ThinParticleSystem extends BaseParticleSystem {
         this.fillDefines(defines, blendMode);
         // Effect
         const currentRenderPassId = this._engine._features.supportRenderPasses ? this._engine.currentRenderPassId : 0;
+        const geometryRendering = MaterialHelperGeometryRendering._PrepareStringDefines(currentRenderPassId, defines);
+        const geometryRenderingConfiguration = geometryRendering ? MaterialHelperGeometryRendering.GetConfiguration(currentRenderPassId) : undefined;
         let drawWrappers = this._drawWrappers[currentRenderPassId];
         if (!drawWrappers) {
             drawWrappers = this._drawWrappers[currentRenderPassId] = [];
+            if (currentRenderPassId !== 0 && !this._renderPassObserver) {
+                this._renderPassObserver = ((_a = this._engine)._onReleaseRenderPassObservable ?? (_a._onReleaseRenderPassObservable = new Observable())).add((id) => {
+                    const releasedWrappers = this._drawWrappers[id];
+                    if (releasedWrappers) {
+                        for (const wrapper of releasedWrappers) {
+                            wrapper?.dispose();
+                        }
+                        delete this._drawWrappers[id];
+                    }
+                });
+            }
         }
         let drawWrapper = drawWrappers[blendMode];
         if (!drawWrapper) {
@@ -1562,10 +1642,40 @@ export class ThinParticleSystem extends BaseParticleSystem {
             const effectCreationOption = [];
             const samplers = [];
             this.fillUniformsAttributesAndSamplerNames(effectCreationOption, attributesNamesOrOptions, samplers);
-            drawWrapper.setEffect(this._engine.createEffect("particles", attributesNamesOrOptions, effectCreationOption, samplers, join, undefined, undefined, undefined, undefined, this._shaderLanguage), join);
+            if (geometryRendering) {
+                effectCreationOption.push("cameraInfo", "objectId", "meshBlendTag", "geometryZeroAlphaDiscard");
+                if (this.isLocal && geometryRenderingConfiguration?.defines.PREPASS_LOCAL_POSITION_INDEX !== undefined) {
+                    effectCreationOption.push("inverseEmitterWM", "geometryWorldOffset");
+                }
+            }
+            drawWrapper.setEffect(this._engine.createEffect("particles", {
+                attributes: attributesNamesOrOptions,
+                uniformsNames: effectCreationOption,
+                samplers,
+                defines: join,
+                shaderLanguage: this._shaderLanguage,
+                multiTarget: geometryRendering,
+                indexParameters: geometryRendering ? { buffersCount: geometryRenderingConfiguration?._mrtCount ?? 0 } : undefined,
+            }, this._engine), join);
         }
         return drawWrapper;
     }
+    _bindGeometryRendering(effect) {
+        const renderPassId = this._engine._features.supportRenderPasses ? this._engine.currentRenderPassId : 0;
+        const configuration = MaterialHelperGeometryRendering.GetConfiguration(renderPassId);
+        if (!configuration?._defines) {
+            return;
+        }
+        effect.setFloat("objectId", 0);
+        effect.setInt("meshBlendTag", 0);
+        const camera = this._scene?.activeCamera;
+        effect.setFloat2("cameraInfo", camera?.minZ ?? 0, camera?.maxZ ?? 1);
+        if (this.isLocal && configuration.defines.PREPASS_LOCAL_POSITION_INDEX !== undefined) {
+            effect.setMatrix("inverseEmitterWM", this._emitterInverseWorldMatrix);
+            const renderOffset = this.worldOffset.subtractToRef(this._scene?.floatingOriginOffset || Vector3.ZeroReadOnly, TmpVectors.Vector3[0]);
+            effect.setVector3("geometryWorldOffset", renderOffset);
+        }
+    }
     /**
      * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
      * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
@@ -1760,7 +1870,8 @@ export class ThinParticleSystem extends BaseParticleSystem {
         const viewMatrix = this.defaultViewMatrix ?? this._scene.getViewMatrix();
         effect.setTexture("diffuseSampler", this.particleTexture);
         effect.setMatrix("view", viewMatrix);
-        effect.setMatrix("projection", this.defaultProjectionMatrix ?? this._scene.getProjectionMatrix());
+        const projectionMatrix = this.defaultProjectionMatrix ?? this._scene.getProjectionMatrix();
+        effect.setMatrix("projection", projectionMatrix);
         if (this._isAnimationSheetEnabled && this.particleTexture) {
             const baseSize = this.particleTexture.getBaseSize();
             effect.setFloat3("particlesInfos", this.spriteCellWidth / baseSize.width, this.spriteCellHeight / baseSize.height, this.spriteCellWidth / baseSize.width);
@@ -1789,6 +1900,9 @@ export class ThinParticleSystem extends BaseParticleSystem {
             viewMatrix.invertToRef(TmpVectors.Matrix[0]);
             effect.setMatrix("invView", TmpVectors.Matrix[0]);
         }
+        if (effect._multiTarget) {
+            this._bindGeometryRendering(effect);
+        }
         if (this._vertexArrayObject !== undefined) {
             if (this._scene?.forceWireframe) {
                 engine.bindBuffers(this._vertexBuffers, this._linesIndexBufferUseInstancing, effect);
@@ -1819,26 +1933,36 @@ export class ThinParticleSystem extends BaseParticleSystem {
         }
         // Draw order
         this._setEngineBasedOnBlendMode(blendMode);
-        if (this._onBeforeDrawParticlesObservable) {
-            this._onBeforeDrawParticlesObservable.notifyObservers(effect);
-        }
-        if (this._useInstancing) {
-            if (this._scene?.forceWireframe) {
-                engine.drawElementsType(6, 0, 10, this._useFixedCapacityForSnapshot ? this._capacity : this._particles.length);
-            }
-            else {
-                engine.drawArraysType(7, 0, 4, this._useFixedCapacityForSnapshot ? this._capacity : this._particles.length);
+        if (effect._multiTarget) {
+            MaterialHelperGeometryRendering._BindZeroAlphaDiscard(engine, effect);
+        }
+        let rendered = false;
+        try {
+            if (MaterialHelperGeometryRendering._BindAttachmentsForEffect(engine, effect)) {
+                if (this._onBeforeDrawParticlesObservable) {
+                    this._onBeforeDrawParticlesObservable.notifyObservers(effect);
+                }
+                if (this._useInstancing) {
+                    if (this._scene?.forceWireframe) {
+                        engine.drawElementsType(6, 0, 10, this._useFixedCapacityForSnapshot ? this._capacity : this._particles.length);
+                    }
+                    else {
+                        engine.drawArraysType(7, 0, 4, this._useFixedCapacityForSnapshot ? this._capacity : this._particles.length);
+                    }
+                }
+                else if (this._scene?.forceWireframe) {
+                    engine.drawElementsType(1, 0, (this._useFixedCapacityForSnapshot ? this._capacity : this._particles.length) * 10);
+                }
+                else {
+                    engine.drawElementsType(0, 0, (this._useFixedCapacityForSnapshot ? this._capacity : this._particles.length) * 6);
+                }
+                rendered = true;
             }
         }
-        else {
-            if (this._scene?.forceWireframe) {
-                engine.drawElementsType(1, 0, (this._useFixedCapacityForSnapshot ? this._capacity : this._particles.length) * 10);
-            }
-            else {
-                engine.drawElementsType(0, 0, (this._useFixedCapacityForSnapshot ? this._capacity : this._particles.length) * 6);
-            }
+        finally {
+            MaterialHelperGeometryRendering._RestoreAttachments(engine);
         }
-        return this._particles.length;
+        return rendered ? this._particles.length : 0;
     }
     /**
      * Renders the particle system in its current state.
@@ -1878,6 +2002,8 @@ export class ThinParticleSystem extends BaseParticleSystem {
      * @param disposeEndSubEmitters defines if the end type sub-emitters must be disposed as well (false by default)
      */
     dispose(disposeTexture = true, disposeAttachedSubEmitters = false, disposeEndSubEmitters = false) {
+        this._engine._onReleaseRenderPassObservable?.remove(this._renderPassObserver);
+        this._renderPassObserver = null;
         this.resetDrawCache();
         if (this._vertexBuffer) {
             this._vertexBuffer.dispose();