Fix background blur with 0 steps

README.md

@@ -259,6 +259,7 @@ interface RenderingOptions
     /**
      * Background blur steps used for background & raindrop refract image.
      * Value should be integer from 0 to log2(backgroundSize).
+     * Set to 0 will not blur the background image.
      * Recommend 3 or 4
      */
     backgroundBlurSteps: number,
@@ -283,7 +284,8 @@ interface RenderingOptions
     /**
      * Background blur steps used for mist.
      * Value should be integer from 0 to log2(backgroundSize).
-     * Recommended value = backgroundBlurSteps + 1
+     * Recommended value = backgroundBlurSteps + 1.
+     * Set to 0 will disable mist blur.
      */
     mistBlurStep: number,
     /**

dist/blur.d.ts

@@ -11,7 +11,7 @@ export declare class BlurRenderer {
     mateiralBlur: MaterialBlur;
     constructor(renderer: ZograRenderer);
     init(texture: Texture): void;
-    blur(texture: Texture, iteration?: number, output?: RenderTexture): RenderTexture;
+    blur(texture: Texture, iteration?: number, output?: RenderTexture): RenderTexture | undefined;
     downSample(input: Texture, iteration: number): void;
     upSample(iteration: number, finalOutput?: RenderTexture): RenderTexture;
 }

dist/renderer.d.ts

@@ -9,6 +9,7 @@ export interface RenderOptions {
     /**
      * Background blur steps used for background & raindrop refract image.
      * Value should be integer from 0 to log2(backgroundSize).
+     * Set to 0 will disable background blur.
      * Recommend 3 or 4
      */
     backgroundBlurSteps: number;
@@ -33,7 +34,8 @@ export interface RenderOptions {
     /**
      * Background blur steps used for mist.
      * Value should be integer from 0 to log2(backgroundSize).
-     * Recommended value = backgroundBlurSteps + 1
+     * Recommended value = backgroundBlurSteps + 1.
+     * Set to 0 will disable mist blur.
      */
     mistBlurStep: number;
     /**

package.json

@@ -1,6 +1,6 @@
 {
   "name": "raindrop-fx",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Rain drop effect with WebGL",
   "main": "dist/index.js",
   "scripts": {

src/blur.ts

@@ -46,6 +46,12 @@ export class BlurRenderer
         if (this.steps[0].width !== texture.width || this.steps[0].height !== texture.height)
             this.steps[0].resize(texture.width, texture.height, TextureResizing.Discard);
 
+        if (iteration == 0)
+        {
+            this.renderer.blit(texture, output);
+            return;
+        }
+
         this.downSample(texture, iteration);
 
         return this.upSample(iteration, output);

src/renderer.ts

@@ -141,6 +141,7 @@ export interface RenderOptions
     /**
      * Background blur steps used for background & raindrop refract image.
      * Value should be integer from 0 to log2(backgroundSize).
+     * Set to 0 will disable background blur.
      * Recommend 3 or 4
      */
     backgroundBlurSteps: number;
@@ -165,7 +166,8 @@ export interface RenderOptions
     /**
      * Background blur steps used for mist.
      * Value should be integer from 0 to log2(backgroundSize).
-     * Recommended value = backgroundBlurSteps + 1
+     * Recommended value = backgroundBlurSteps + 1.
+     * Set to 0 will disable mist blur.
      */
     mistBlurStep: number;
     /**
@@ -397,6 +399,11 @@ export class RaindropRenderer
         }
         else
         {
+            if (this.options.backgroundBlurSteps == 0)
+            {
+                this.blurryBackground = this.background;
+            }
+
             // Downsample to max steps
             // Then upsample from a larger texture before smaller texture to avoid override
             this.blurRenderer.init(this.background);