@itwin/frontend-devtools 4.0.0-dev.48 → 4.0.0-dev.51

package/lib/cjs/effects/Saturation.js

@@ -1,86 +1,86 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Effects
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SaturationConfig = exports.SaturationEffect = void 0;
-const core_frontend_1 = require("@itwin/core-frontend");
-const parseArgs_1 = require("../tools/parseArgs");
-const EffectTools_1 = require("./EffectTools");
-/** Adjusts the saturation of colors in a viewport.
- * @beta
- */
-class SaturationEffect extends EffectTools_1.AddEffectTool {
-    get effectName() { return "Saturation"; }
-    get textureCoordFromPosition() { return true; }
-    get source() {
-        // rgb <-> hsl conversion routines from https://gamedev.stackexchange.com/questions/59797/glsl-shader-change-hue-saturation-brightness
-        return {
-            // Vertex shader simply computes texture coordinate for source pixel.
-            vertex: `
-        void effectMain(vec4 pos) {
-          v_texCoord = textureCoordFromPosition(pos);
-        }`,
-            // Fragment shader converts color to HSV, adjusts the saturation, and converts back to RGB.
-            fragment: `
-        vec3 rgb2hsv(vec3 c) {
-          vec4 K = vec4(0.0, -1.0 / 3.0, 2.0 / 3.0, -1.0);
-          vec4 p = mix(vec4(c.bg, K.wz), vec4(c.gb, K.xy), step(c.b, c.g));
-          vec4 q = mix(vec4(p.xyw, c.r), vec4(c.r, p.yzx), step(p.x, c.r));
-
-          float d = q.x - min(q.w, q.y);
-          float e = 1.0e-10;
-          return vec3(abs(q.z + (q.w - q.y) / (6.0 * d + e)), d / (q.x + e), q.x);
-        }
-
-        vec3 hsv2rgb(vec3 c) {
-          vec4 K = vec4(1.0, 2.0 / 3.0, 1.0 / 3.0, 3.0);
-          vec3 p = abs(fract(c.xxx + K.xyz) * 6.0 - K.www);
-          return c.z * mix(K.xxx, clamp(p - K.xxx, 0.0, 1.0), c.y);
-        }
-
-        vec4 effectMain() {
-          vec4 color = TEXTURE(u_diffuse, v_texCoord);
-          color.rgb = rgb2hsv(color.rgb);
-          color.rgb.y = color.rgb.y * u_saturationMult;
-          color.rgb = hsv2rgb(color.rgb);
-          return color;
-        }`,
-        };
-    }
-    defineEffect(builder) {
-        builder.addVarying("v_texCoord", core_frontend_1.VaryingType.Vec2);
-        builder.addUniform({
-            name: "u_saturationMult",
-            type: core_frontend_1.UniformType.Float,
-            bind: (uniform) => uniform.setUniform1f(SaturationConfig.multiplier),
-        });
-    }
-}
-exports.SaturationEffect = SaturationEffect;
-SaturationEffect.toolId = "SaturationEffect";
-/** Configures the [[SaturationEffect]].
- * @beta
- */
-class SaturationConfig extends core_frontend_1.Tool {
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 1; }
-    async run(multiplier) {
-        SaturationConfig.multiplier = multiplier ?? 2.0;
-        (0, EffectTools_1.refreshViewportsForEffect)("fdt Saturation");
-        return true;
-    }
-    async parseAndRun(...input) {
-        const args = (0, parseArgs_1.parseArgs)(input);
-        return this.run(args.getFloat("s"));
-    }
-}
-exports.SaturationConfig = SaturationConfig;
-SaturationConfig.toolId = "SaturationConfig";
-/** Multiplier applied to the saturation of each color in the source image. */
-SaturationConfig.multiplier = 2.0;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Effects
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SaturationConfig = exports.SaturationEffect = void 0;
+const core_frontend_1 = require("@itwin/core-frontend");
+const parseArgs_1 = require("../tools/parseArgs");
+const EffectTools_1 = require("./EffectTools");
+/** Adjusts the saturation of colors in a viewport.
+ * @beta
+ */
+class SaturationEffect extends EffectTools_1.AddEffectTool {
+    get effectName() { return "Saturation"; }
+    get textureCoordFromPosition() { return true; }
+    get source() {
+        // rgb <-> hsl conversion routines from https://gamedev.stackexchange.com/questions/59797/glsl-shader-change-hue-saturation-brightness
+        return {
+            // Vertex shader simply computes texture coordinate for source pixel.
+            vertex: `
+        void effectMain(vec4 pos) {
+          v_texCoord = textureCoordFromPosition(pos);
+        }`,
+            // Fragment shader converts color to HSV, adjusts the saturation, and converts back to RGB.
+            fragment: `
+        vec3 rgb2hsv(vec3 c) {
+          vec4 K = vec4(0.0, -1.0 / 3.0, 2.0 / 3.0, -1.0);
+          vec4 p = mix(vec4(c.bg, K.wz), vec4(c.gb, K.xy), step(c.b, c.g));
+          vec4 q = mix(vec4(p.xyw, c.r), vec4(c.r, p.yzx), step(p.x, c.r));
+
+          float d = q.x - min(q.w, q.y);
+          float e = 1.0e-10;
+          return vec3(abs(q.z + (q.w - q.y) / (6.0 * d + e)), d / (q.x + e), q.x);
+        }
+
+        vec3 hsv2rgb(vec3 c) {
+          vec4 K = vec4(1.0, 2.0 / 3.0, 1.0 / 3.0, 3.0);
+          vec3 p = abs(fract(c.xxx + K.xyz) * 6.0 - K.www);
+          return c.z * mix(K.xxx, clamp(p - K.xxx, 0.0, 1.0), c.y);
+        }
+
+        vec4 effectMain() {
+          vec4 color = TEXTURE(u_diffuse, v_texCoord);
+          color.rgb = rgb2hsv(color.rgb);
+          color.rgb.y = color.rgb.y * u_saturationMult;
+          color.rgb = hsv2rgb(color.rgb);
+          return color;
+        }`,
+        };
+    }
+    defineEffect(builder) {
+        builder.addVarying("v_texCoord", core_frontend_1.VaryingType.Vec2);
+        builder.addUniform({
+            name: "u_saturationMult",
+            type: core_frontend_1.UniformType.Float,
+            bind: (uniform) => uniform.setUniform1f(SaturationConfig.multiplier),
+        });
+    }
+}
+exports.SaturationEffect = SaturationEffect;
+SaturationEffect.toolId = "SaturationEffect";
+/** Configures the [[SaturationEffect]].
+ * @beta
+ */
+class SaturationConfig extends core_frontend_1.Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async run(multiplier) {
+        SaturationConfig.multiplier = multiplier ?? 2.0;
+        (0, EffectTools_1.refreshViewportsForEffect)("fdt Saturation");
+        return true;
+    }
+    async parseAndRun(...input) {
+        const args = (0, parseArgs_1.parseArgs)(input);
+        return this.run(args.getFloat("s"));
+    }
+}
+exports.SaturationConfig = SaturationConfig;
+SaturationConfig.toolId = "SaturationConfig";
+/** Multiplier applied to the saturation of each color in the source image. */
+SaturationConfig.multiplier = 2.0;
 //# sourceMappingURL=Saturation.js.map

package/lib/cjs/effects/Saturation.js.map

@@ -1 +1 @@
-{"version":3,"file":"Saturation.js","sourceRoot":"","sources":["../../../src/effects/Saturation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAgG;AAChG,kDAA+C;AAC/C,+CAAyE;AAEzE;;GAEG;AACH,MAAa,gBAAiB,SAAQ,2BAAa;IAGjD,IAAc,UAAU,KAAK,OAAO,YAAY,CAAC,CAAC,CAAC;IACnD,IAAc,wBAAwB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzD,IAAc,MAAM;QAClB,sIAAsI;QACtI,OAAO;YACL,qEAAqE;YACrE,MAAM,EAAE;;;UAGJ;YACJ,2FAA2F;YAC3F,QAAQ,EAAE;;;;;;;;;;;;;;;;;;;;;;;UAuBN;SACL,CAAC;IACJ,CAAC;IAES,YAAY,CAAC,OAAiC;QACtD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,2BAAW,CAAC,IAAI,CAAC,CAAC;QACnD,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE,2BAAW,CAAC,KAAK;YACvB,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,gBAAgB,CAAC,UAAU,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;;AAjDH,4CAkDC;AAjDwB,uBAAM,GAAG,kBAAkB,CAAC;AAmDrD;;GAEG;AACH,MAAa,gBAAiB,SAAQ,oBAAI;IAEjC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAKlC,KAAK,CAAC,GAAG,CAAC,UAAmB;QAC3C,gBAAgB,CAAC,UAAU,GAAG,UAAU,IAAI,GAAG,CAAC;QAChD,IAAA,uCAAyB,EAAC,gBAAgB,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,KAAe;QAClD,MAAM,IAAI,GAAG,IAAA,qBAAS,EAAC,KAAK,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,CAAC;;AAjBH,4CAkBC;AAjBwB,uBAAM,GAAG,kBAAkB,CAAC;AAInD,8EAA8E;AAChE,2BAAU,GAAG,GAAG,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Effects\n */\n\nimport { ScreenSpaceEffectBuilder, Tool, UniformType, VaryingType } from \"@itwin/core-frontend\";\nimport { parseArgs } from \"../tools/parseArgs\";\nimport { AddEffectTool, refreshViewportsForEffect } from \"./EffectTools\";\n\n/** Adjusts the saturation of colors in a viewport.\n * @beta\n */\nexport class SaturationEffect extends AddEffectTool {\n  public static override toolId = \"SaturationEffect\";\n\n  protected get effectName() { return \"Saturation\"; }\n  protected get textureCoordFromPosition() { return true; }\n\n  protected get source() {\n    // rgb <-> hsl conversion routines from https://gamedev.stackexchange.com/questions/59797/glsl-shader-change-hue-saturation-brightness\n    return {\n      // Vertex shader simply computes texture coordinate for source pixel.\n      vertex: `\n        void effectMain(vec4 pos) {\n          v_texCoord = textureCoordFromPosition(pos);\n        }`,\n      // Fragment shader converts color to HSV, adjusts the saturation, and converts back to RGB.\n      fragment: `\n        vec3 rgb2hsv(vec3 c) {\n          vec4 K = vec4(0.0, -1.0 / 3.0, 2.0 / 3.0, -1.0);\n          vec4 p = mix(vec4(c.bg, K.wz), vec4(c.gb, K.xy), step(c.b, c.g));\n          vec4 q = mix(vec4(p.xyw, c.r), vec4(c.r, p.yzx), step(p.x, c.r));\n\n          float d = q.x - min(q.w, q.y);\n          float e = 1.0e-10;\n          return vec3(abs(q.z + (q.w - q.y) / (6.0 * d + e)), d / (q.x + e), q.x);\n        }\n\n        vec3 hsv2rgb(vec3 c) {\n          vec4 K = vec4(1.0, 2.0 / 3.0, 1.0 / 3.0, 3.0);\n          vec3 p = abs(fract(c.xxx + K.xyz) * 6.0 - K.www);\n          return c.z * mix(K.xxx, clamp(p - K.xxx, 0.0, 1.0), c.y);\n        }\n\n        vec4 effectMain() {\n          vec4 color = TEXTURE(u_diffuse, v_texCoord);\n          color.rgb = rgb2hsv(color.rgb);\n          color.rgb.y = color.rgb.y * u_saturationMult;\n          color.rgb = hsv2rgb(color.rgb);\n          return color;\n        }`,\n    };\n  }\n\n  protected defineEffect(builder: ScreenSpaceEffectBuilder): void {\n    builder.addVarying(\"v_texCoord\", VaryingType.Vec2);\n    builder.addUniform({\n      name: \"u_saturationMult\",\n      type: UniformType.Float,\n      bind: (uniform) => uniform.setUniform1f(SaturationConfig.multiplier),\n    });\n  }\n}\n\n/** Configures the [[SaturationEffect]].\n * @beta\n */\nexport class SaturationConfig extends Tool {\n  public static override toolId = \"SaturationConfig\";\n  public static override get minArgs() { return 0; }\n  public static override get maxArgs() { return 1; }\n\n  /** Multiplier applied to the saturation of each color in the source image. */\n  public static multiplier = 2.0;\n\n  public override async run(multiplier?: number): Promise<boolean> {\n    SaturationConfig.multiplier = multiplier ?? 2.0;\n    refreshViewportsForEffect(\"fdt Saturation\");\n    return true;\n  }\n\n  public override async parseAndRun(...input: string[]): Promise<boolean> {\n    const args = parseArgs(input);\n    return this.run(args.getFloat(\"s\"));\n  }\n}\n\n"]}
+{"version":3,"file":"Saturation.js","sourceRoot":"","sources":["../../../src/effects/Saturation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAgG;AAChG,kDAA+C;AAC/C,+CAAyE;AAEzE;;GAEG;AACH,MAAa,gBAAiB,SAAQ,2BAAa;IAGjD,IAAc,UAAU,KAAK,OAAO,YAAY,CAAC,CAAC,CAAC;IACnD,IAAc,wBAAwB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzD,IAAc,MAAM;QAClB,sIAAsI;QACtI,OAAO;YACL,qEAAqE;YACrE,MAAM,EAAE;;;UAGJ;YACJ,2FAA2F;YAC3F,QAAQ,EAAE;;;;;;;;;;;;;;;;;;;;;;;UAuBN;SACL,CAAC;IACJ,CAAC;IAES,YAAY,CAAC,OAAiC;QACtD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,2BAAW,CAAC,IAAI,CAAC,CAAC;QACnD,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE,2BAAW,CAAC,KAAK;YACvB,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,gBAAgB,CAAC,UAAU,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;;AAjDH,4CAkDC;AAjDwB,uBAAM,GAAG,kBAAkB,CAAC;AAmDrD;;GAEG;AACH,MAAa,gBAAiB,SAAQ,oBAAI;IAEjC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAKlC,KAAK,CAAC,GAAG,CAAC,UAAmB;QAC3C,gBAAgB,CAAC,UAAU,GAAG,UAAU,IAAI,GAAG,CAAC;QAChD,IAAA,uCAAyB,EAAC,gBAAgB,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,KAAe;QAClD,MAAM,IAAI,GAAG,IAAA,qBAAS,EAAC,KAAK,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,CAAC;;AAjBH,4CAkBC;AAjBwB,uBAAM,GAAG,kBAAkB,CAAC;AAInD,8EAA8E;AAChE,2BAAU,GAAG,GAAG,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Effects\r\n */\r\n\r\nimport { ScreenSpaceEffectBuilder, Tool, UniformType, VaryingType } from \"@itwin/core-frontend\";\r\nimport { parseArgs } from \"../tools/parseArgs\";\r\nimport { AddEffectTool, refreshViewportsForEffect } from \"./EffectTools\";\r\n\r\n/** Adjusts the saturation of colors in a viewport.\r\n * @beta\r\n */\r\nexport class SaturationEffect extends AddEffectTool {\r\n  public static override toolId = \"SaturationEffect\";\r\n\r\n  protected get effectName() { return \"Saturation\"; }\r\n  protected get textureCoordFromPosition() { return true; }\r\n\r\n  protected get source() {\r\n    // rgb <-> hsl conversion routines from https://gamedev.stackexchange.com/questions/59797/glsl-shader-change-hue-saturation-brightness\r\n    return {\r\n      // Vertex shader simply computes texture coordinate for source pixel.\r\n      vertex: `\r\n        void effectMain(vec4 pos) {\r\n          v_texCoord = textureCoordFromPosition(pos);\r\n        }`,\r\n      // Fragment shader converts color to HSV, adjusts the saturation, and converts back to RGB.\r\n      fragment: `\r\n        vec3 rgb2hsv(vec3 c) {\r\n          vec4 K = vec4(0.0, -1.0 / 3.0, 2.0 / 3.0, -1.0);\r\n          vec4 p = mix(vec4(c.bg, K.wz), vec4(c.gb, K.xy), step(c.b, c.g));\r\n          vec4 q = mix(vec4(p.xyw, c.r), vec4(c.r, p.yzx), step(p.x, c.r));\r\n\r\n          float d = q.x - min(q.w, q.y);\r\n          float e = 1.0e-10;\r\n          return vec3(abs(q.z + (q.w - q.y) / (6.0 * d + e)), d / (q.x + e), q.x);\r\n        }\r\n\r\n        vec3 hsv2rgb(vec3 c) {\r\n          vec4 K = vec4(1.0, 2.0 / 3.0, 1.0 / 3.0, 3.0);\r\n          vec3 p = abs(fract(c.xxx + K.xyz) * 6.0 - K.www);\r\n          return c.z * mix(K.xxx, clamp(p - K.xxx, 0.0, 1.0), c.y);\r\n        }\r\n\r\n        vec4 effectMain() {\r\n          vec4 color = TEXTURE(u_diffuse, v_texCoord);\r\n          color.rgb = rgb2hsv(color.rgb);\r\n          color.rgb.y = color.rgb.y * u_saturationMult;\r\n          color.rgb = hsv2rgb(color.rgb);\r\n          return color;\r\n        }`,\r\n    };\r\n  }\r\n\r\n  protected defineEffect(builder: ScreenSpaceEffectBuilder): void {\r\n    builder.addVarying(\"v_texCoord\", VaryingType.Vec2);\r\n    builder.addUniform({\r\n      name: \"u_saturationMult\",\r\n      type: UniformType.Float,\r\n      bind: (uniform) => uniform.setUniform1f(SaturationConfig.multiplier),\r\n    });\r\n  }\r\n}\r\n\r\n/** Configures the [[SaturationEffect]].\r\n * @beta\r\n */\r\nexport class SaturationConfig extends Tool {\r\n  public static override toolId = \"SaturationConfig\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  /** Multiplier applied to the saturation of each color in the source image. */\r\n  public static multiplier = 2.0;\r\n\r\n  public override async run(multiplier?: number): Promise<boolean> {\r\n    SaturationConfig.multiplier = multiplier ?? 2.0;\r\n    refreshViewportsForEffect(\"fdt Saturation\");\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...input: string[]): Promise<boolean> {\r\n    const args = parseArgs(input);\r\n    return this.run(args.getFloat(\"s\"));\r\n  }\r\n}\r\n\r\n"]}

package/lib/cjs/effects/Snow.d.ts

@@ -1,77 +1,77 @@
-/** @packageDocumentation
- * @module Effects
- */
-import { Range1d, Range2d, Vector2d } from "@itwin/core-geometry";
-import { DecorateContext, Decorator, ParticleProps, Tool, Viewport } from "@itwin/core-frontend";
-/** Represents one particle displayed by a [[SnowDecorator]].
- * Particle positions are in [CoordSystem.View]($frontend).
- * @beta
- */
-export interface SnowParticle extends ParticleProps {
-    /** Make x, y, and z from ParticleProps writable. */
-    x: number;
-    y: number;
-    z: number;
-    /** Current velocity, in pixels per second. */
-    velocity: Vector2d;
-}
-/** Parameters controlling how a [[SnowDecorator]] works.
- * @beta
- */
-export interface SnowParams {
-    /** The number of snow particles to produce. This could alternatively be expressed as a density so that small viewports would not be more crowded than larger ones. */
-    numParticles: number;
-    /** Range from which to randomly select each particle's size, in pixels. */
-    sizeRange: Range1d;
-    /** Range from which to randomly select each particle's transparency. */
-    transparencyRange: Range1d;
-    /** Range from which to randomly select each particle's initial velocity, in pixels per second. */
-    velocityRange: Range2d;
-    /** Range from which to randomly select an acceleration to apply to each particle's velocity each frame, in pixels per second squared, to simulate wind. */
-    accelerationRange: Range2d;
-    /** Wind velocity in pixels per second in X. */
-    windVelocity: number;
-}
-/** Simulates snowfall in a [Viewport]($frontend) using particle effects.
- * @see [[SnowEffect]] for a [Tool]($frontend) that toggles this decorator.
- * @see [ParticleCollectionBuilder]($frontend) for defining custom particle effects.
- * @beta
- */
-export declare class SnowDecorator implements Decorator {
-    /** The viewport being decorated. */
-    readonly viewport: Viewport;
-    /** Invoked when this decorator is to be destroyed. */
-    readonly dispose: VoidFunction;
-    /** The initial width and height of the viewport, from which we randomly select each particle's initial position. */
-    private readonly _dimensions;
-    /** The list of particles being drawn. */
-    private readonly _particles;
-    /** The image to display for each particle. */
-    private _texture?;
-    /** The last time `updateParticles()` was invoked, in milliseconds. */
-    private _lastUpdateTime;
-    private readonly _params;
-    private constructor();
-    decorate(context: DecorateContext): void;
-    /** Change some of the parameters affecting this decorator. */
-    configure(params: Partial<SnowParams>): void;
-    /** Emit a new particle with randomized properties. */
-    private emit;
-    private updateParticles;
-    private static readonly _decorators;
-    /** Toggle this decorator for the specified viewport.
-     * @param viewport The viewport to which the effect should be applied or removed.
-     * @param enable `true` to enable the effect, `false` to disable it, or `undefined` to toggle the current state.
-     */
-    static toggle(viewport: Viewport, enable?: boolean): Promise<void>;
-}
-/** Toggles a decorator that simulates snow using particle effects.
- * @see [[SnowDecorator]] for the implementation of the decorator.
- * @beta
- */
-export declare class SnowEffect extends Tool {
-    static toolId: string;
-    run(enable?: boolean): Promise<boolean>;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
+/** @packageDocumentation
+ * @module Effects
+ */
+import { Range1d, Range2d, Vector2d } from "@itwin/core-geometry";
+import { DecorateContext, Decorator, ParticleProps, Tool, Viewport } from "@itwin/core-frontend";
+/** Represents one particle displayed by a [[SnowDecorator]].
+ * Particle positions are in [CoordSystem.View]($frontend).
+ * @beta
+ */
+export interface SnowParticle extends ParticleProps {
+    /** Make x, y, and z from ParticleProps writable. */
+    x: number;
+    y: number;
+    z: number;
+    /** Current velocity, in pixels per second. */
+    velocity: Vector2d;
+}
+/** Parameters controlling how a [[SnowDecorator]] works.
+ * @beta
+ */
+export interface SnowParams {
+    /** The number of snow particles to produce. This could alternatively be expressed as a density so that small viewports would not be more crowded than larger ones. */
+    numParticles: number;
+    /** Range from which to randomly select each particle's size, in pixels. */
+    sizeRange: Range1d;
+    /** Range from which to randomly select each particle's transparency. */
+    transparencyRange: Range1d;
+    /** Range from which to randomly select each particle's initial velocity, in pixels per second. */
+    velocityRange: Range2d;
+    /** Range from which to randomly select an acceleration to apply to each particle's velocity each frame, in pixels per second squared, to simulate wind. */
+    accelerationRange: Range2d;
+    /** Wind velocity in pixels per second in X. */
+    windVelocity: number;
+}
+/** Simulates snowfall in a [Viewport]($frontend) using particle effects.
+ * @see [[SnowEffect]] for a [Tool]($frontend) that toggles this decorator.
+ * @see [ParticleCollectionBuilder]($frontend) for defining custom particle effects.
+ * @beta
+ */
+export declare class SnowDecorator implements Decorator {
+    /** The viewport being decorated. */
+    readonly viewport: Viewport;
+    /** Invoked when this decorator is to be destroyed. */
+    readonly dispose: VoidFunction;
+    /** The initial width and height of the viewport, from which we randomly select each particle's initial position. */
+    private readonly _dimensions;
+    /** The list of particles being drawn. */
+    private readonly _particles;
+    /** The image to display for each particle. */
+    private _texture?;
+    /** The last time `updateParticles()` was invoked, in milliseconds. */
+    private _lastUpdateTime;
+    private readonly _params;
+    private constructor();
+    decorate(context: DecorateContext): void;
+    /** Change some of the parameters affecting this decorator. */
+    configure(params: Partial<SnowParams>): void;
+    /** Emit a new particle with randomized properties. */
+    private emit;
+    private updateParticles;
+    private static readonly _decorators;
+    /** Toggle this decorator for the specified viewport.
+     * @param viewport The viewport to which the effect should be applied or removed.
+     * @param enable `true` to enable the effect, `false` to disable it, or `undefined` to toggle the current state.
+     */
+    static toggle(viewport: Viewport, enable?: boolean): Promise<void>;
+}
+/** Toggles a decorator that simulates snow using particle effects.
+ * @see [[SnowDecorator]] for the implementation of the decorator.
+ * @beta
+ */
+export declare class SnowEffect extends Tool {
+    static toolId: string;
+    run(enable?: boolean): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
 //# sourceMappingURL=Snow.d.ts.map