@itwin/frontend-devtools 3.0.0-dev.72

package/lib/effects/FlipImage.d.ts

@@ -0,0 +1,31 @@
+/** @packageDocumentation
+ * @module Effects
+ */
+import { ScreenSpaceEffectBuilder, Tool } from "@itwin/core-frontend";
+import { AddEffectTool } from "./EffectTools";
+/** An extremely simple and mostly useless effect intended to demonstrate the basics of creating a screen-space effect.
+ * It flips the Viewport's image on the x and/or y axis, and/or inverts the color of each pixel.
+ * @beta
+ */
+export declare class FlipImageEffect extends AddEffectTool {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get textureCoordFromPosition(): boolean;
+    protected get source(): {
+        vertex: string;
+        fragment: string;
+        sampleSourcePixel: string;
+    };
+    protected defineEffect(builder: ScreenSpaceEffectBuilder): void;
+}
+/** Configure the [[FlipImageEffect]].
+ * @beta
+ */
+export declare class FlipImageConfig extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(horizontal?: boolean, vertical?: boolean, color?: boolean): Promise<boolean>;
+    parseAndRun(...input: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=FlipImage.d.ts.map

package/lib/effects/FlipImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FlipImage.d.ts","sourceRoot":"","sources":["../../src/effects/FlipImage.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,IAAI,EAA4B,MAAM,sBAAsB,CAAC;AAEhG,OAAO,EAAE,aAAa,EAA6B,MAAM,eAAe,CAAC;AAMzE;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,aAAa;IAChD,OAAuB,MAAM,SAAqB;IAElD,SAAS,KAAK,UAAU,WAAqB;IAC7C,SAAS,KAAK,wBAAwB,YAAmB;IAEzD,SAAS,KAAK,MAAM;;;;MA8BnB;IAED,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI;CAwBhE;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,IAAI;IACvC,OAAuB,MAAM,SAAqB;IAClD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAShF,WAAW,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAIxE"}

package/lib/effects/FlipImage.js

@@ -0,0 +1,100 @@
+"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.FlipImageConfig = exports.FlipImageEffect = void 0;
+const core_frontend_1 = require("@itwin/core-frontend");
+const parseArgs_1 = require("../tools/parseArgs");
+const EffectTools_1 = require("./EffectTools");
+let flipHorizontal = false;
+let flipVertical = false;
+let flipColor = false;
+/** An extremely simple and mostly useless effect intended to demonstrate the basics of creating a screen-space effect.
+ * It flips the Viewport's image on the x and/or y axis, and/or inverts the color of each pixel.
+ * @beta
+ */
+class FlipImageEffect extends EffectTools_1.AddEffectTool {
+    get effectName() { return "flip"; }
+    get textureCoordFromPosition() { return true; }
+    get source() {
+        return {
+            // Compute texture coordinate for use in fragment shader.
+            vertex: `
+        void effectMain(vec4 pos) {
+          vec2 uv = textureCoordFromPosition(pos);
+          if (u_flipHorizontal)
+            uv.x = 1.0 - uv.x;
+
+          if (u_flipVertical)
+            uv.y = 1.0 - uv.y;
+
+          v_uv = uv;
+        }`,
+            // Sample the original image to flip on x and/or y axis, then invert its color.
+            fragment: `
+        vec4 effectMain() {
+          vec4 color = sampleSourcePixel();
+          if (u_flipColor) {
+            color.r = 1.0 - color.r;
+            color.g = 1.0 - color.g;
+            color.b = 1.0 - color.b;
+          }
+
+          return color;
+        }`,
+            // Because we're moving pixels around, we must tell the render system where the source pixel was originally located - otherwise
+            // element locate will not work correctly.
+            sampleSourcePixel: "return TEXTURE(u_diffuse, v_uv);",
+        };
+    }
+    defineEffect(builder) {
+        // Don't bother applying the effect if nothing is to be flipped.
+        builder.shouldApply = (_context) => flipHorizontal || flipVertical || flipColor;
+        // Define the varying for the texture coordinate.
+        builder.addVarying("v_uv", core_frontend_1.VaryingType.Vec2);
+        // Hook up the uniforms.
+        builder.addUniform({
+            name: "u_flipHorizontal",
+            type: core_frontend_1.UniformType.Bool,
+            bind: (uniform, _context) => uniform.setUniform1i(flipHorizontal ? 1 : 0),
+        });
+        builder.addUniform({
+            name: "u_flipVertical",
+            type: core_frontend_1.UniformType.Bool,
+            bind: (uniform, _context) => uniform.setUniform1i(flipVertical ? 1 : 0),
+        });
+        builder.addUniform({
+            name: "u_flipColor",
+            type: core_frontend_1.UniformType.Bool,
+            bind: (uniform, _context) => uniform.setUniform1i(flipColor ? 1 : 0),
+        });
+    }
+}
+exports.FlipImageEffect = FlipImageEffect;
+FlipImageEffect.toolId = "FlipImageEffect";
+/** Configure the [[FlipImageEffect]].
+ * @beta
+ */
+class FlipImageConfig extends core_frontend_1.Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 3; }
+    async run(horizontal, vertical, color) {
+        flipHorizontal = !!horizontal;
+        flipVertical = !!vertical;
+        flipColor = !!color;
+        (0, EffectTools_1.refreshViewportsForEffect)("fdt flip");
+        return true;
+    }
+    async parseAndRun(...input) {
+        const args = (0, parseArgs_1.parseArgs)(input);
+        return this.run(args.getBoolean("h"), args.getBoolean("v"), args.getBoolean("c"));
+    }
+}
+exports.FlipImageConfig = FlipImageConfig;
+FlipImageConfig.toolId = "FlipImageConfig";
+//# sourceMappingURL=FlipImage.js.map

package/lib/effects/FlipImage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FlipImage.js","sourceRoot":"","sources":["../../src/effects/FlipImage.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAgG;AAChG,kDAA+C;AAC/C,+CAAyE;AAEzE,IAAI,cAAc,GAAG,KAAK,CAAC;AAC3B,IAAI,YAAY,GAAG,KAAK,CAAC;AACzB,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB;;;GAGG;AACH,MAAa,eAAgB,SAAQ,2BAAa;IAGhD,IAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;IAC7C,IAAc,wBAAwB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzD,IAAc,MAAM;QAClB,OAAO;YACL,yDAAyD;YACzD,MAAM,EAAE;;;;;;;;;;UAUJ;YACJ,+EAA+E;YAC/E,QAAQ,EAAE;;;;;;;;;;UAUN;YACJ,+HAA+H;YAC/H,0CAA0C;YAC1C,iBAAiB,EAAE,kCAAkC;SACtD,CAAC;IACJ,CAAC;IAES,YAAY,CAAC,OAAiC;QACtD,gEAAgE;QAChE,OAAO,CAAC,WAAW,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,cAAc,IAAI,YAAY,IAAI,SAAS,CAAC;QAEhF,iDAAiD;QACjD,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,2BAAW,CAAC,IAAI,CAAC,CAAC;QAE7C,wBAAwB;QACxB,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE,2BAAW,CAAC,IAAI;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1E,CAAC,CAAC;QACH,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,2BAAW,CAAC,IAAI;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACxE,CAAC,CAAC;QACH,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,aAAa;YACnB,IAAI,EAAE,2BAAW,CAAC,IAAI;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;;AA7DH,0CA8DC;AA7DwB,sBAAM,GAAG,iBAAiB,CAAC;AA+DpD;;GAEG;AACH,MAAa,eAAgB,SAAQ,oBAAI;IAEhC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,UAAoB,EAAE,QAAkB,EAAE,KAAe;QACjF,cAAc,GAAG,CAAC,CAAC,UAAU,CAAC;QAC9B,YAAY,GAAG,CAAC,CAAC,QAAQ,CAAC;QAC1B,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC;QAEpB,IAAA,uCAAyB,EAAC,UAAU,CAAC,CAAC;QACtC,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,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IACpF,CAAC;;AAjBH,0CAkBC;AAjBwB,sBAAM,GAAG,iBAAiB,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\nlet flipHorizontal = false;\nlet flipVertical = false;\nlet flipColor = false;\n\n/** An extremely simple and mostly useless effect intended to demonstrate the basics of creating a screen-space effect.\n * It flips the Viewport's image on the x and/or y axis, and/or inverts the color of each pixel.\n * @beta\n */\nexport class FlipImageEffect extends AddEffectTool {\n  public static override toolId = \"FlipImageEffect\";\n\n  protected get effectName() { return \"flip\"; }\n  protected get textureCoordFromPosition() { return true; }\n\n  protected get source() {\n    return {\n      // Compute texture coordinate for use in fragment shader.\n      vertex: `\n        void effectMain(vec4 pos) {\n          vec2 uv = textureCoordFromPosition(pos);\n          if (u_flipHorizontal)\n            uv.x = 1.0 - uv.x;\n\n          if (u_flipVertical)\n            uv.y = 1.0 - uv.y;\n\n          v_uv = uv;\n        }`,\n      // Sample the original image to flip on x and/or y axis, then invert its color.\n      fragment: `\n        vec4 effectMain() {\n          vec4 color = sampleSourcePixel();\n          if (u_flipColor) {\n            color.r = 1.0 - color.r;\n            color.g = 1.0 - color.g;\n            color.b = 1.0 - color.b;\n          }\n\n          return color;\n        }`,\n      // Because we're moving pixels around, we must tell the render system where the source pixel was originally located - otherwise\n      // element locate will not work correctly.\n      sampleSourcePixel: \"return TEXTURE(u_diffuse, v_uv);\",\n    };\n  }\n\n  protected defineEffect(builder: ScreenSpaceEffectBuilder): void {\n    // Don't bother applying the effect if nothing is to be flipped.\n    builder.shouldApply = (_context) => flipHorizontal || flipVertical || flipColor;\n\n    // Define the varying for the texture coordinate.\n    builder.addVarying(\"v_uv\", VaryingType.Vec2);\n\n    // Hook up the uniforms.\n    builder.addUniform({\n      name: \"u_flipHorizontal\",\n      type: UniformType.Bool,\n      bind: (uniform, _context) => uniform.setUniform1i(flipHorizontal ? 1 : 0),\n    });\n    builder.addUniform({\n      name: \"u_flipVertical\",\n      type: UniformType.Bool,\n      bind: (uniform, _context) => uniform.setUniform1i(flipVertical ? 1 : 0),\n    });\n    builder.addUniform({\n      name: \"u_flipColor\",\n      type: UniformType.Bool,\n      bind: (uniform, _context) => uniform.setUniform1i(flipColor ? 1 : 0),\n    });\n  }\n}\n\n/** Configure the [[FlipImageEffect]].\n * @beta\n */\nexport class FlipImageConfig extends Tool {\n  public static override toolId = \"FlipImageConfig\";\n  public static override get minArgs() { return 0; }\n  public static override get maxArgs() { return 3; }\n\n  public override async run(horizontal?: boolean, vertical?: boolean, color?: boolean): Promise<boolean> {\n    flipHorizontal = !!horizontal;\n    flipVertical = !!vertical;\n    flipColor = !!color;\n\n    refreshViewportsForEffect(\"fdt flip\");\n    return true;\n  }\n\n  public override async parseAndRun(...input: string[]): Promise<boolean> {\n    const args = parseArgs(input);\n    return this.run(args.getBoolean(\"h\"), args.getBoolean(\"v\"), args.getBoolean(\"c\"));\n  }\n}\n"]}

package/lib/effects/LensDistortion.d.ts

@@ -0,0 +1,35 @@
+/** @packageDocumentation
+ * @module Effects
+ */
+import { ScreenSpaceEffectBuilder, Tool } from "@itwin/core-frontend";
+import { AddEffectTool } from "./EffectTools";
+/** Adds a screen-space effect to the selected [[Viewport]] to simulate the lens distortion produced by real-world cameras with very wide fields of view.
+ * Based on https://www.decarpentier.nl/lens-distortion
+ * The effect is improved considerably by enabling anti-aliasing (e.g., via [RenderSystem.Options.antialiasSamples]($frontend) at startup, or using the `fdt aasamples` key-in`).
+ * @note Because this effect applies a non-linear transform to each pixel, operations like snapping to geometry will not work properly. Element locate will work however - @see [ScreenSpaceEffectSource.sampleSourcePixel]($frontend).
+ * @beta
+ */
+export declare class LensDistortionEffect extends AddEffectTool {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get textureCoordFromPosition(): boolean;
+    protected get source(): {
+        vertex: string;
+        fragment: string;
+        sampleSourcePixel: string;
+    };
+    protected defineEffect(builder: ScreenSpaceEffectBuilder): void;
+}
+/** Configures the [[LensDistortionEffect]].
+ * @beta
+ */
+export declare class LensDistortionConfig extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    static strength: number;
+    static cylindricalRatio: number;
+    run(strength?: number, ratio?: number): Promise<boolean>;
+    parseAndRun(...input: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=LensDistortion.d.ts.map

package/lib/effects/LensDistortion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LensDistortion.d.ts","sourceRoot":"","sources":["../../src/effects/LensDistortion.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,wBAAwB,EAAE,IAAI,EAA4B,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAA6B,MAAM,eAAe,CAAC;AAGzE;;;;;GAKG;AACH,qBAAa,oBAAqB,SAAQ,aAAa;IACrD,OAAuB,MAAM,SAA0B;IAEvD,SAAS,KAAK,UAAU,WAA+B;IACvD,SAAS,KAAK,wBAAwB,YAAmB;IAEzD,SAAS,KAAK,MAAM;;;;MA8BnB;IAED,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI;CAiChE;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,IAAI;IAC5C,OAAuB,MAAM,SAA0B;IACvD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAc,QAAQ,SAAO;IAC7B,OAAc,gBAAgB,SAAO;IAEf,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAOxD,WAAW,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAIxE"}

package/lib/effects/LensDistortion.js

@@ -0,0 +1,110 @@
+"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.LensDistortionConfig = exports.LensDistortionEffect = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_frontend_1 = require("@itwin/core-frontend");
+const EffectTools_1 = require("./EffectTools");
+const parseArgs_1 = require("../tools/parseArgs");
+/** Adds a screen-space effect to the selected [[Viewport]] to simulate the lens distortion produced by real-world cameras with very wide fields of view.
+ * Based on https://www.decarpentier.nl/lens-distortion
+ * The effect is improved considerably by enabling anti-aliasing (e.g., via [RenderSystem.Options.antialiasSamples]($frontend) at startup, or using the `fdt aasamples` key-in`).
+ * @note Because this effect applies a non-linear transform to each pixel, operations like snapping to geometry will not work properly. Element locate will work however - @see [ScreenSpaceEffectSource.sampleSourcePixel]($frontend).
+ * @beta
+ */
+class LensDistortionEffect extends EffectTools_1.AddEffectTool {
+    get effectName() { return "lensdistortion"; }
+    get textureCoordFromPosition() { return true; }
+    get source() {
+        return {
+            vertex: `
+        void effectMain(vec4 position) {
+          vec2 uv = textureCoordFromPosition(position);
+          float scaledHeight = strength * height;
+          float cylAspectRatio = aspectRatio * cylindricalRatio;
+          float aspectDiagSq = aspectRatio * aspectRatio + 1.0;
+          float diagSq = scaledHeight * scaledHeight * aspectDiagSq;
+          vec2 signedUV = (2.0 * uv + vec2(-1.0, -1.0));
+
+          float z = 0.5 * sqrt(diagSq + 1.0) + 0.5;
+          float ny = (z - 1.0) / (cylAspectRatio * cylAspectRatio + 1.0);
+
+          vUVDot = sqrt(ny) * vec2(cylAspectRatio, 1.0) * signedUV;
+          vUV = vec3(0.5, 0.5, 1.0) * z + vec3(-0.5, -0.5, 0.0);
+          vUV.xy += uv;
+        }`,
+            // We simply shift pixels - we don't alter their colors.
+            fragment: `
+        vec4 effectMain() {
+          return sampleSourcePixel();
+        }`,
+            // Because we're moving pixels around, we must tell the render system where the source pixel was originally located - otherwise
+            // element locate will not work correctly.
+            sampleSourcePixel: `
+        vec3 uv = dot(vUVDot, vUVDot) * vec3(-0.5, -0.5, -1.0) + vUV;
+        return TEXTURE_PROJ(u_diffuse, uv);
+      `,
+        };
+    }
+    defineEffect(builder) {
+        // Lens distortion is only applicable to views with the camera enabled.
+        builder.shouldApply = (context) => context.viewport.isCameraOn;
+        builder.addVarying("vUV", core_frontend_1.VaryingType.Vec3);
+        builder.addVarying("vUVDot", core_frontend_1.VaryingType.Vec2);
+        builder.addUniform({
+            name: "strength",
+            type: core_frontend_1.UniformType.Float,
+            bind: (uniform) => uniform.setUniform1f(LensDistortionConfig.strength),
+        });
+        builder.addUniform({
+            name: "cylindricalRatio",
+            type: core_frontend_1.UniformType.Float,
+            bind: (uniform) => uniform.setUniform1f(LensDistortionConfig.cylindricalRatio),
+        });
+        builder.addUniform({
+            name: "aspectRatio",
+            type: core_frontend_1.UniformType.Float,
+            bind: (uniform, context) => uniform.setUniform1f(context.viewport.viewRect.aspect),
+        });
+        builder.addUniform({
+            name: "height",
+            type: core_frontend_1.UniformType.Float,
+            bind: (uniform, context) => {
+                (0, core_bentley_1.assert)(context.viewport.view.isCameraEnabled());
+                const fov = context.viewport.view.camera.lens.radians;
+                const height = Math.tan(fov / 2) / context.viewport.viewRect.aspect;
+                uniform.setUniform1f(height);
+            },
+        });
+    }
+}
+exports.LensDistortionEffect = LensDistortionEffect;
+LensDistortionEffect.toolId = "LensDistortionEffect";
+/** Configures the [[LensDistortionEffect]].
+ * @beta
+ */
+class LensDistortionConfig extends core_frontend_1.Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 2; }
+    async run(strength, ratio) {
+        LensDistortionConfig.strength = strength !== null && strength !== void 0 ? strength : 0.5;
+        LensDistortionConfig.cylindricalRatio = ratio !== null && ratio !== void 0 ? ratio : 0.5;
+        (0, EffectTools_1.refreshViewportsForEffect)("fdt lensdistortion");
+        return true;
+    }
+    async parseAndRun(...input) {
+        const args = (0, parseArgs_1.parseArgs)(input);
+        return this.run(args.getFloat("s"), args.getFloat("r"));
+    }
+}
+exports.LensDistortionConfig = LensDistortionConfig;
+LensDistortionConfig.toolId = "LensDistortionConfig";
+LensDistortionConfig.strength = 0.5;
+LensDistortionConfig.cylindricalRatio = 0.5;
+//# sourceMappingURL=LensDistortion.js.map

package/lib/effects/LensDistortion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LensDistortion.js","sourceRoot":"","sources":["../../src/effects/LensDistortion.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,wDAAgG;AAChG,+CAAyE;AACzE,kDAA+C;AAE/C;;;;;GAKG;AACH,MAAa,oBAAqB,SAAQ,2BAAa;IAGrD,IAAc,UAAU,KAAK,OAAO,gBAAgB,CAAC,CAAC,CAAC;IACvD,IAAc,wBAAwB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzD,IAAc,MAAM;QAClB,OAAO;YACL,MAAM,EAAE;;;;;;;;;;;;;;;UAeJ;YACJ,wDAAwD;YACxD,QAAQ,EAAE;;;UAGN;YACJ,+HAA+H;YAC/H,0CAA0C;YAC1C,iBAAiB,EAAE;;;OAGlB;SACF,CAAC;IACJ,CAAC;IAES,YAAY,CAAC,OAAiC;QACtD,uEAAuE;QACvE,OAAO,CAAC,WAAW,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC;QAE/D,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,2BAAW,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,2BAAW,CAAC,IAAI,CAAC,CAAC;QAE/C,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,2BAAW,CAAC,KAAK;YACvB,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,oBAAoB,CAAC,QAAQ,CAAC;SACvE,CAAC,CAAC;QACH,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,oBAAoB,CAAC,gBAAgB,CAAC;SAC/E,CAAC,CAAC;QACH,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,aAAa;YACnB,IAAI,EAAE,2BAAW,CAAC,KAAK;YACvB,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;SACnF,CAAC,CAAC;QACH,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,2BAAW,CAAC,KAAK;YACvB,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;gBACzB,IAAA,qBAAM,EAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;gBAChD,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;gBACtD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACpE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAC/B,CAAC;SACF,CAAC,CAAC;IACL,CAAC;;AAtEH,oDAuEC;AAtEwB,2BAAM,GAAG,sBAAsB,CAAC;AAwEzD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,oBAAI;IAErC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAKlC,KAAK,CAAC,GAAG,CAAC,QAAiB,EAAE,KAAc;QACzD,oBAAoB,CAAC,QAAQ,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,GAAG,CAAC;QAChD,oBAAoB,CAAC,gBAAgB,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,GAAG,CAAC;QACrD,IAAA,uCAAyB,EAAC,oBAAoB,CAAC,CAAC;QAChD,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,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1D,CAAC;;AAlBH,oDAmBC;AAlBwB,2BAAM,GAAG,sBAAsB,CAAC;AAIzC,6BAAQ,GAAG,GAAG,CAAC;AACf,qCAAgB,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 { assert } from \"@itwin/core-bentley\";\nimport { ScreenSpaceEffectBuilder, Tool, UniformType, VaryingType } from \"@itwin/core-frontend\";\nimport { AddEffectTool, refreshViewportsForEffect } from \"./EffectTools\";\nimport { parseArgs } from \"../tools/parseArgs\";\n\n/** Adds a screen-space effect to the selected [[Viewport]] to simulate the lens distortion produced by real-world cameras with very wide fields of view.\n * Based on https://www.decarpentier.nl/lens-distortion\n * The effect is improved considerably by enabling anti-aliasing (e.g., via [RenderSystem.Options.antialiasSamples]($frontend) at startup, or using the `fdt aasamples` key-in`).\n * @note Because this effect applies a non-linear transform to each pixel, operations like snapping to geometry will not work properly. Element locate will work however - @see [ScreenSpaceEffectSource.sampleSourcePixel]($frontend).\n * @beta\n */\nexport class LensDistortionEffect extends AddEffectTool {\n  public static override toolId = \"LensDistortionEffect\";\n\n  protected get effectName() { return \"lensdistortion\"; }\n  protected get textureCoordFromPosition() { return true; }\n\n  protected get source() {\n    return {\n      vertex: `\n        void effectMain(vec4 position) {\n          vec2 uv = textureCoordFromPosition(position);\n          float scaledHeight = strength * height;\n          float cylAspectRatio = aspectRatio * cylindricalRatio;\n          float aspectDiagSq = aspectRatio * aspectRatio + 1.0;\n          float diagSq = scaledHeight * scaledHeight * aspectDiagSq;\n          vec2 signedUV = (2.0 * uv + vec2(-1.0, -1.0));\n\n          float z = 0.5 * sqrt(diagSq + 1.0) + 0.5;\n          float ny = (z - 1.0) / (cylAspectRatio * cylAspectRatio + 1.0);\n\n          vUVDot = sqrt(ny) * vec2(cylAspectRatio, 1.0) * signedUV;\n          vUV = vec3(0.5, 0.5, 1.0) * z + vec3(-0.5, -0.5, 0.0);\n          vUV.xy += uv;\n        }`,\n      // We simply shift pixels - we don't alter their colors.\n      fragment: `\n        vec4 effectMain() {\n          return sampleSourcePixel();\n        }`,\n      // Because we're moving pixels around, we must tell the render system where the source pixel was originally located - otherwise\n      // element locate will not work correctly.\n      sampleSourcePixel: `\n        vec3 uv = dot(vUVDot, vUVDot) * vec3(-0.5, -0.5, -1.0) + vUV;\n        return TEXTURE_PROJ(u_diffuse, uv);\n      `,\n    };\n  }\n\n  protected defineEffect(builder: ScreenSpaceEffectBuilder): void {\n    // Lens distortion is only applicable to views with the camera enabled.\n    builder.shouldApply = (context) => context.viewport.isCameraOn;\n\n    builder.addVarying(\"vUV\", VaryingType.Vec3);\n    builder.addVarying(\"vUVDot\", VaryingType.Vec2);\n\n    builder.addUniform({\n      name: \"strength\",\n      type: UniformType.Float,\n      bind: (uniform) => uniform.setUniform1f(LensDistortionConfig.strength),\n    });\n    builder.addUniform({\n      name: \"cylindricalRatio\",\n      type: UniformType.Float,\n      bind: (uniform) => uniform.setUniform1f(LensDistortionConfig.cylindricalRatio),\n    });\n    builder.addUniform({\n      name: \"aspectRatio\",\n      type: UniformType.Float,\n      bind: (uniform, context) => uniform.setUniform1f(context.viewport.viewRect.aspect),\n    });\n    builder.addUniform({\n      name: \"height\",\n      type: UniformType.Float,\n      bind: (uniform, context) => {\n        assert(context.viewport.view.isCameraEnabled());\n        const fov = context.viewport.view.camera.lens.radians;\n        const height = Math.tan(fov / 2) / context.viewport.viewRect.aspect;\n        uniform.setUniform1f(height);\n      },\n    });\n  }\n}\n\n/** Configures the [[LensDistortionEffect]].\n * @beta\n */\nexport class LensDistortionConfig extends Tool {\n  public static override toolId = \"LensDistortionConfig\";\n  public static override get minArgs() { return 0; }\n  public static override get maxArgs() { return 2; }\n\n  public static strength = 0.5;\n  public static cylindricalRatio = 0.5;\n\n  public override async run(strength?: number, ratio?: number): Promise<boolean> {\n    LensDistortionConfig.strength = strength ?? 0.5;\n    LensDistortionConfig.cylindricalRatio = ratio ?? 0.5;\n    refreshViewportsForEffect(\"fdt lensdistortion\");\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\"), args.getFloat(\"r\"));\n  }\n}\n"]}

package/lib/effects/Random.d.ts

@@ -0,0 +1,25 @@
+/** @packageDocumentation
+ * @module Effects
+ */
+import { Point3d, Range1d, Range3d } from "@itwin/core-geometry";
+/** Generate integer in [min, max].
+ * @beta
+ */
+export declare function randomInteger(min: number, max: number): number;
+/** Generate random integer in [range.low, range.high].
+ * @beta
+ */
+export declare function randomIntegerInRange(range: Range1d): number;
+/** Generate random floating-point number in [min, max).
+ * @beta
+ */
+export declare function randomFloat(min: number, max: number): number;
+/** Generate random floating-point number in [range.low, range.high).
+ * @beta
+ */
+export declare function randomFloatInRange(range: Range1d): number;
+/** Generate a random position in the specified range.
+ * @beta
+ */
+export declare function randomPositionInRange(range: Range3d): Point3d;
+//# sourceMappingURL=Random.d.ts.map

package/lib/effects/Random.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Random.d.ts","sourceRoot":"","sources":["../../src/effects/Random.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAEjE;;GAEG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAE3D;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAEzD;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAK7D"}

package/lib/effects/Random.js

@@ -0,0 +1,50 @@
+"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.randomPositionInRange = exports.randomFloatInRange = exports.randomFloat = exports.randomIntegerInRange = exports.randomInteger = void 0;
+const core_geometry_1 = require("@itwin/core-geometry");
+/** Generate integer in [min, max].
+ * @beta
+ */
+function randomInteger(min, max) {
+    return Math.floor(Math.random() * (max - min + 1)) + min;
+}
+exports.randomInteger = randomInteger;
+/** Generate random integer in [range.low, range.high].
+ * @beta
+ */
+function randomIntegerInRange(range) {
+    return Math.floor(Math.random() * (range.high - range.low + 1)) + range.low;
+}
+exports.randomIntegerInRange = randomIntegerInRange;
+/** Generate random floating-point number in [min, max).
+ * @beta
+ */
+function randomFloat(min, max) {
+    return Math.random() * (max - min) + min;
+}
+exports.randomFloat = randomFloat;
+/** Generate random floating-point number in [range.low, range.high).
+ * @beta
+ */
+function randomFloatInRange(range) {
+    return randomFloat(range.low, range.high);
+}
+exports.randomFloatInRange = randomFloatInRange;
+/** Generate a random position in the specified range.
+ * @beta
+ */
+function randomPositionInRange(range) {
+    const x = randomFloat(range.low.x, range.high.x);
+    const y = randomFloat(range.low.y, range.high.y);
+    const z = randomFloat(range.low.z, range.high.z);
+    return new core_geometry_1.Point3d(x, y, z);
+}
+exports.randomPositionInRange = randomPositionInRange;
+//# sourceMappingURL=Random.js.map

package/lib/effects/Random.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Random.js","sourceRoot":"","sources":["../../src/effects/Random.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAiE;AAEjE;;GAEG;AACH,SAAgB,aAAa,CAAC,GAAW,EAAE,GAAW;IACpD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;AAC3D,CAAC;AAFD,sCAEC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAAC,KAAc;IACjD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC;AAC9E,CAAC;AAFD,oDAEC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,GAAW,EAAE,GAAW;IAClD,OAAO,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;AAC3C,CAAC;AAFD,kCAEC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,KAAc;IAC/C,OAAO,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC;AAFD,gDAEC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,KAAc;IAClD,MAAM,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjD,MAAM,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjD,MAAM,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjD,OAAO,IAAI,uBAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9B,CAAC;AALD,sDAKC","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 { Point3d, Range1d, Range3d } from \"@itwin/core-geometry\";\n\n/** Generate integer in [min, max].\n * @beta\n */\nexport function randomInteger(min: number, max: number): number {\n  return Math.floor(Math.random() * (max - min + 1)) + min;\n}\n\n/** Generate random integer in [range.low, range.high].\n * @beta\n */\nexport function randomIntegerInRange(range: Range1d): number {\n  return Math.floor(Math.random() * (range.high - range.low + 1)) + range.low;\n}\n\n/** Generate random floating-point number in [min, max).\n * @beta\n */\nexport function randomFloat(min: number, max: number): number {\n  return Math.random() * (max - min) + min;\n}\n\n/** Generate random floating-point number in [range.low, range.high).\n * @beta\n */\nexport function randomFloatInRange(range: Range1d): number {\n  return randomFloat(range.low, range.high);\n}\n\n/** Generate a random position in the specified range.\n * @beta\n */\nexport function randomPositionInRange(range: Range3d): Point3d {\n  const x = randomFloat(range.low.x, range.high.x);\n  const y = randomFloat(range.low.y, range.high.y);\n  const z = randomFloat(range.low.z, range.high.z);\n  return new Point3d(x, y, z);\n}\n"]}

package/lib/effects/Saturation.d.ts

@@ -0,0 +1,31 @@
+/** @packageDocumentation
+ * @module Effects
+ */
+import { ScreenSpaceEffectBuilder, Tool } from "@itwin/core-frontend";
+import { AddEffectTool } from "./EffectTools";
+/** Adjusts the saturation of colors in a viewport.
+ * @beta
+ */
+export declare class SaturationEffect extends AddEffectTool {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get textureCoordFromPosition(): boolean;
+    protected get source(): {
+        vertex: string;
+        fragment: string;
+    };
+    protected defineEffect(builder: ScreenSpaceEffectBuilder): void;
+}
+/** Configures the [[SaturationEffect]].
+ * @beta
+ */
+export declare class SaturationConfig extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** Multiplier applied to the saturation of each color in the source image. */
+    static multiplier: number;
+    run(multiplier?: number): Promise<boolean>;
+    parseAndRun(...input: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=Saturation.d.ts.map

package/lib/effects/Saturation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Saturation.d.ts","sourceRoot":"","sources":["../../src/effects/Saturation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,IAAI,EAA4B,MAAM,sBAAsB,CAAC;AAEhG,OAAO,EAAE,aAAa,EAA6B,MAAM,eAAe,CAAC;AAEzE;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,aAAa;IACjD,OAAuB,MAAM,SAAsB;IAEnD,SAAS,KAAK,UAAU,WAA2B;IACnD,SAAS,KAAK,wBAAwB,YAAmB;IAEzD,SAAS,KAAK,MAAM;;;MAkCnB;IAED,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI;CAQhE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,IAAI;IACxC,OAAuB,MAAM,SAAsB;IACnD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,8EAA8E;IAC9E,OAAc,UAAU,SAAO;IAET,GAAG,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAM1C,WAAW,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAIxE"}

package/lib/effects/Saturation.js

@@ -0,0 +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 !== null && multiplier !== void 0 ? 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/effects/Saturation.js.map

@@ -0,0 +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,aAAV,UAAU,cAAV,UAAU,GAAI,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"]}

package/lib/effects/Snow.d.ts

@@ -0,0 +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>;
+}
+//# sourceMappingURL=Snow.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Snow.d.ts","sourceRoot":"","sources":["../../src/effects/Snow.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAW,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAE3E,OAAO,EACL,eAAe,EAAE,SAAS,EAA0E,aAAa,EAAE,IAAI,EAAE,QAAQ,EAClI,MAAM,sBAAsB,CAAC;AAI9B;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD,oDAAoD;IACpD,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IAEV,8CAA8C;IAC9C,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,sKAAsK;IACtK,YAAY,EAAE,MAAM,CAAC;IACrB,2EAA2E;IAC3E,SAAS,EAAE,OAAO,CAAC;IACnB,wEAAwE;IACxE,iBAAiB,EAAE,OAAO,CAAC;IAC3B,kGAAkG;IAClG,aAAa,EAAE,OAAO,CAAC;IACvB,2JAA2J;IAC3J,iBAAiB,EAAE,OAAO,CAAC;IAC3B,+CAA+C;IAC/C,YAAY,EAAE,MAAM,CAAC;CACtB;AAYD;;;;GAIG;AACH,qBAAa,aAAc,YAAW,SAAS;IAC7C,oCAAoC;IACpC,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,sDAAsD;IACtD,SAAgB,OAAO,EAAE,YAAY,CAAC;IACtC,oHAAoH;IACpH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAU;IACtC,yCAAyC;IACzC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,8CAA8C;IAC9C,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,sEAAsE;IACtE,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;IAErC,OAAO;IAuCA,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IA0B/C,8DAA8D;IACvD,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI;IAQnD,sDAAsD;IACtD,OAAO,CAAC,IAAI;IAaZ,OAAO,CAAC,eAAe;IA4CvB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAsC;IAEzE;;;OAGG;WACiB,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAkBhF;AAED;;;GAGG;AACH,qBAAa,UAAW,SAAQ,IAAI;IAClC,OAAuB,MAAM,SAAgB;IAEvB,GAAG,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAQvC,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOvE"}