@itwin/frontend-devtools 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/tools/RenderSystemTools.js

@@ -1,70 +1,70 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToggleDPIForLODTool = exports.CompileShadersTool = exports.LoseWebGLContextTool = exports.RenderSystemDebugControlTool = void 0;
-/** @packageDocumentation
- * @module Tools
- */
-const core_frontend_1 = require("@itwin/core-frontend");
-const parseToggle_1 = require("./parseToggle");
-/** Executes some code against a RenderSystemDebugControl obtained from the IModelApp's RenderSystem.
- * @beta
- */
-class RenderSystemDebugControlTool extends core_frontend_1.Tool {
-    async run(_args) {
-        const control = core_frontend_1.IModelApp.renderSystem.debugControl;
-        if (undefined !== control)
-            this.execute(control);
-        return true;
-    }
-}
-exports.RenderSystemDebugControlTool = RenderSystemDebugControlTool;
-/** Forces webgl context loss.
- * @beta
- */
-class LoseWebGLContextTool extends RenderSystemDebugControlTool {
-    execute(control) {
-        control.loseContext();
-    }
-}
-exports.LoseWebGLContextTool = LoseWebGLContextTool;
-LoseWebGLContextTool.toolId = "LoseWebGLContext";
-/** Compiles all registered shader programs for which compilation has not already been attempted.
- * This is useful for uncovering/debugging platform-specific shader issues.
- * @beta
- */
-class CompileShadersTool extends RenderSystemDebugControlTool {
-    execute(control) {
-        const compiled = control.compileAllShaders();
-        core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(compiled ? core_frontend_1.OutputMessagePriority.Info : core_frontend_1.OutputMessagePriority.Error, `${compiled ? "No" : "Some"} compilation errors occurred.`));
-    }
-}
-exports.CompileShadersTool = CompileShadersTool;
-CompileShadersTool.toolId = "CompileShaders";
-/** Toggles whether or not device pixel ratio should be taken into account when computing LOD for tiles and decoration graphics.
- * @see [RenderSystem.Options.dpiAwareLOD]($frontend)
- * @beta
- */
-class ToggleDPIForLODTool extends RenderSystemDebugControlTool {
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 1; }
-    execute(control) {
-        const enable = this._enable ?? !control.dpiAwareLOD;
-        control.dpiAwareLOD = enable;
-        core_frontend_1.IModelApp.viewManager.invalidateViewportScenes();
-    }
-    async parseAndRun(...args) {
-        const enable = (0, parseToggle_1.parseToggle)(args[0]);
-        if (typeof enable !== "string") {
-            this._enable = enable;
-            await this.run([]);
-        }
-        return true;
-    }
-}
-exports.ToggleDPIForLODTool = ToggleDPIForLODTool;
-ToggleDPIForLODTool.toolId = "ToggleDPIForLOD";
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToggleDPIForLODTool = exports.CompileShadersTool = exports.LoseWebGLContextTool = exports.RenderSystemDebugControlTool = void 0;
+/** @packageDocumentation
+ * @module Tools
+ */
+const core_frontend_1 = require("@itwin/core-frontend");
+const parseToggle_1 = require("./parseToggle");
+/** Executes some code against a RenderSystemDebugControl obtained from the IModelApp's RenderSystem.
+ * @beta
+ */
+class RenderSystemDebugControlTool extends core_frontend_1.Tool {
+    async run(_args) {
+        const control = core_frontend_1.IModelApp.renderSystem.debugControl;
+        if (undefined !== control)
+            this.execute(control);
+        return true;
+    }
+}
+exports.RenderSystemDebugControlTool = RenderSystemDebugControlTool;
+/** Forces webgl context loss.
+ * @beta
+ */
+class LoseWebGLContextTool extends RenderSystemDebugControlTool {
+    execute(control) {
+        control.loseContext();
+    }
+}
+LoseWebGLContextTool.toolId = "LoseWebGLContext";
+exports.LoseWebGLContextTool = LoseWebGLContextTool;
+/** Compiles all registered shader programs for which compilation has not already been attempted.
+ * This is useful for uncovering/debugging platform-specific shader issues.
+ * @beta
+ */
+class CompileShadersTool extends RenderSystemDebugControlTool {
+    execute(control) {
+        const compiled = control.compileAllShaders();
+        core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(compiled ? core_frontend_1.OutputMessagePriority.Info : core_frontend_1.OutputMessagePriority.Error, `${compiled ? "No" : "Some"} compilation errors occurred.`));
+    }
+}
+CompileShadersTool.toolId = "CompileShaders";
+exports.CompileShadersTool = CompileShadersTool;
+/** Toggles whether or not device pixel ratio should be taken into account when computing LOD for tiles and decoration graphics.
+ * @see [RenderSystem.Options.dpiAwareLOD]($frontend)
+ * @beta
+ */
+class ToggleDPIForLODTool extends RenderSystemDebugControlTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    execute(control) {
+        const enable = this._enable ?? !control.dpiAwareLOD;
+        control.dpiAwareLOD = enable;
+        core_frontend_1.IModelApp.viewManager.invalidateViewportScenes();
+    }
+    async parseAndRun(...args) {
+        const enable = (0, parseToggle_1.parseToggle)(args[0]);
+        if (typeof enable !== "string") {
+            this._enable = enable;
+            await this.run([]);
+        }
+        return true;
+    }
+}
+ToggleDPIForLODTool.toolId = "ToggleDPIForLOD";
+exports.ToggleDPIForLODTool = ToggleDPIForLODTool;
 //# sourceMappingURL=RenderSystemTools.js.map

package/lib/cjs/tools/RenderSystemTools.js.map

@@ -1 +1 @@
-{"version":3,"file":"RenderSystemTools.js","sourceRoot":"","sources":["../../../src/tools/RenderSystemTools.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,wDAA8H;AAC9H,+CAA4C;AAE5C;;GAEG;AACH,MAAsB,4BAA6B,SAAQ,oBAAI;IAC7C,KAAK,CAAC,GAAG,CAAC,KAAY;QACpC,MAAM,OAAO,GAAG,yBAAS,CAAC,YAAY,CAAC,YAAY,CAAC;QACpD,IAAI,SAAS,KAAK,OAAO;YACvB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAExB,OAAO,IAAI,CAAC;IACd,CAAC;CAGF;AAVD,oEAUC;AAED;;GAEG;AACH,MAAa,oBAAqB,SAAQ,4BAA4B;IAE7D,OAAO,CAAC,OAAiC;QAC9C,OAAO,CAAC,WAAW,EAAE,CAAC;IACxB,CAAC;;AAJH,oDAKC;AAJwB,2BAAM,GAAG,kBAAkB,CAAC;AAMrD;;;GAGG;AACH,MAAa,kBAAmB,SAAQ,4BAA4B;IAE3D,OAAO,CAAC,OAAiC;QAC9C,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC7C,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,qCAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,qCAAqB,CAAC,KAAK,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,+BAA+B,CAAC,CAAC,CAAC;IACnM,CAAC;;AALH,gDAMC;AALwB,yBAAM,GAAG,gBAAgB,CAAC;AAOnD;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,4BAA4B;IAE5D,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAI3C,OAAO,CAAC,OAAiC;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;QACpD,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC;QAC7B,yBAAS,CAAC,WAAW,CAAC,wBAAwB,EAAE,CAAC;IACnD,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACpB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AArBH,kDAsBC;AArBwB,0BAAM,GAAG,iBAAiB,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\r\n/** @packageDocumentation\r\n * @module Tools\r\n */\r\n\r\nimport { IModelApp, NotifyMessageDetails, OutputMessagePriority, RenderSystemDebugControl, Tool } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\n/** Executes some code against a RenderSystemDebugControl obtained from the IModelApp's RenderSystem.\r\n * @beta\r\n */\r\nexport abstract class RenderSystemDebugControlTool extends Tool {\r\n  public override async run(_args: any[]): Promise<boolean> {\r\n    const control = IModelApp.renderSystem.debugControl;\r\n    if (undefined !== control)\r\n      this.execute(control);\r\n\r\n    return true;\r\n  }\r\n\r\n  protected abstract execute(_control: RenderSystemDebugControl): void;\r\n}\r\n\r\n/** Forces webgl context loss.\r\n * @beta\r\n */\r\nexport class LoseWebGLContextTool extends RenderSystemDebugControlTool {\r\n  public static override toolId = \"LoseWebGLContext\";\r\n  public execute(control: RenderSystemDebugControl): void {\r\n    control.loseContext();\r\n  }\r\n}\r\n\r\n/** Compiles all registered shader programs for which compilation has not already been attempted.\r\n * This is useful for uncovering/debugging platform-specific shader issues.\r\n * @beta\r\n */\r\nexport class CompileShadersTool extends RenderSystemDebugControlTool {\r\n  public static override toolId = \"CompileShaders\";\r\n  public execute(control: RenderSystemDebugControl): void {\r\n    const compiled = control.compileAllShaders();\r\n    IModelApp.notifications.outputMessage(new NotifyMessageDetails(compiled ? OutputMessagePriority.Info : OutputMessagePriority.Error, `${compiled ? \"No\" : \"Some\"} compilation errors occurred.`));\r\n  }\r\n}\r\n\r\n/** Toggles whether or not device pixel ratio should be taken into account when computing LOD for tiles and decoration graphics.\r\n * @see [RenderSystem.Options.dpiAwareLOD]($frontend)\r\n * @beta\r\n */\r\nexport class ToggleDPIForLODTool extends RenderSystemDebugControlTool {\r\n  public static override toolId = \"ToggleDPIForLOD\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  private _enable?: boolean;\r\n\r\n  public execute(control: RenderSystemDebugControl): void {\r\n    const enable = this._enable ?? !control.dpiAwareLOD;\r\n    control.dpiAwareLOD = enable;\r\n    IModelApp.viewManager.invalidateViewportScenes();\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const enable = parseToggle(args[0]);\r\n    if (typeof enable !== \"string\") {\r\n      this._enable = enable;\r\n      await this.run([]);\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"RenderSystemTools.js","sourceRoot":"","sources":["../../../src/tools/RenderSystemTools.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,wDAA8H;AAC9H,+CAA4C;AAE5C;;GAEG;AACH,MAAsB,4BAA6B,SAAQ,oBAAI;IAC7C,KAAK,CAAC,GAAG,CAAC,KAAY;QACpC,MAAM,OAAO,GAAG,yBAAS,CAAC,YAAY,CAAC,YAAY,CAAC;QACpD,IAAI,SAAS,KAAK,OAAO;YACvB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAExB,OAAO,IAAI,CAAC;IACd,CAAC;CAGF;AAVD,oEAUC;AAED;;GAEG;AACH,MAAa,oBAAqB,SAAQ,4BAA4B;IAE7D,OAAO,CAAC,OAAiC;QAC9C,OAAO,CAAC,WAAW,EAAE,CAAC;IACxB,CAAC;;AAHsB,2BAAM,GAAG,kBAAkB,CAAC;AADxC,oDAAoB;AAOjC;;;GAGG;AACH,MAAa,kBAAmB,SAAQ,4BAA4B;IAE3D,OAAO,CAAC,OAAiC;QAC9C,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC7C,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,qCAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,qCAAqB,CAAC,KAAK,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,+BAA+B,CAAC,CAAC,CAAC;IACnM,CAAC;;AAJsB,yBAAM,GAAG,gBAAgB,CAAC;AADtC,gDAAkB;AAQ/B;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,4BAA4B;IAE5D,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAI3C,OAAO,CAAC,OAAiC;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;QACpD,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC;QAC7B,yBAAS,CAAC,WAAW,CAAC,wBAAwB,EAAE,CAAC;IACnD,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACpB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AApBsB,0BAAM,GAAG,iBAAiB,CAAC;AADvC,kDAAmB","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\r\n/** @packageDocumentation\r\n * @module Tools\r\n */\r\n\r\nimport { IModelApp, NotifyMessageDetails, OutputMessagePriority, RenderSystemDebugControl, Tool } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\n/** Executes some code against a RenderSystemDebugControl obtained from the IModelApp's RenderSystem.\r\n * @beta\r\n */\r\nexport abstract class RenderSystemDebugControlTool extends Tool {\r\n  public override async run(_args: any[]): Promise<boolean> {\r\n    const control = IModelApp.renderSystem.debugControl;\r\n    if (undefined !== control)\r\n      this.execute(control);\r\n\r\n    return true;\r\n  }\r\n\r\n  protected abstract execute(_control: RenderSystemDebugControl): void;\r\n}\r\n\r\n/** Forces webgl context loss.\r\n * @beta\r\n */\r\nexport class LoseWebGLContextTool extends RenderSystemDebugControlTool {\r\n  public static override toolId = \"LoseWebGLContext\";\r\n  public execute(control: RenderSystemDebugControl): void {\r\n    control.loseContext();\r\n  }\r\n}\r\n\r\n/** Compiles all registered shader programs for which compilation has not already been attempted.\r\n * This is useful for uncovering/debugging platform-specific shader issues.\r\n * @beta\r\n */\r\nexport class CompileShadersTool extends RenderSystemDebugControlTool {\r\n  public static override toolId = \"CompileShaders\";\r\n  public execute(control: RenderSystemDebugControl): void {\r\n    const compiled = control.compileAllShaders();\r\n    IModelApp.notifications.outputMessage(new NotifyMessageDetails(compiled ? OutputMessagePriority.Info : OutputMessagePriority.Error, `${compiled ? \"No\" : \"Some\"} compilation errors occurred.`));\r\n  }\r\n}\r\n\r\n/** Toggles whether or not device pixel ratio should be taken into account when computing LOD for tiles and decoration graphics.\r\n * @see [RenderSystem.Options.dpiAwareLOD]($frontend)\r\n * @beta\r\n */\r\nexport class ToggleDPIForLODTool extends RenderSystemDebugControlTool {\r\n  public static override toolId = \"ToggleDPIForLOD\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  private _enable?: boolean;\r\n\r\n  public execute(control: RenderSystemDebugControl): void {\r\n    const enable = this._enable ?? !control.dpiAwareLOD;\r\n    control.dpiAwareLOD = enable;\r\n    IModelApp.viewManager.invalidateViewportScenes();\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const enable = parseToggle(args[0]);\r\n    if (typeof enable !== \"string\") {\r\n      this._enable = enable;\r\n      await this.run([]);\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}

package/lib/cjs/tools/RenderTargetTools.d.ts

@@ -1,108 +1,108 @@
-/** @packageDocumentation
- * @module Tools
- */
-import { RenderTargetDebugControl, ScreenViewport, Tool } from "@itwin/core-frontend";
-/** Executes some code against a RenderTargetDebugControl obtained from the selected viewport.
- * @beta
- */
-export declare abstract class RenderTargetDebugControlTool extends Tool {
-    run(_args: any[]): Promise<boolean>;
-    protected abstract execute(_control: RenderTargetDebugControl, _vp: ScreenViewport): void;
-}
-declare type DebugControlBoolean = "displayDrapeFrustum" | "drawForReadPixels" | "displayRealityTileRanges" | "displayRealityTileRanges" | "displayRealityTilePreload" | "freezeRealityTiles" | "logRealityTiles" | "vcSupportIntersectingVolumes" | "displayNormalMaps";
-/** Toggles some aspect of a RenderTargetDebugControl for the selected viewport.
- * @beta
- */
-export declare abstract class RenderTargetDebugControlToggleTool extends RenderTargetDebugControlTool {
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    private _enable?;
-    protected abstract get aspect(): DebugControlBoolean;
-    protected execute(control: RenderTargetDebugControl, vp: ScreenViewport): void;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Toggles between normal rendering and rendering as if drawing to an off-screen framebuffer for element locate. Useful for debugging locate issues.
- * @beta
- */
-export declare class ToggleReadPixelsTool extends RenderTargetDebugControlToggleTool {
-    static toolId: string;
-    get aspect(): DebugControlBoolean;
-}
-/** Turn on the display of the draping frustum.
- * @beta
- */
-export declare class ToggleDrapeFrustumTool extends RenderTargetDebugControlToggleTool {
-    static toolId: string;
-    get aspect(): DebugControlBoolean;
-}
-/** Control whether all geometry renders, or only instanced or batched geometry.
- * Allowed argument: "instanced", "batched", "all". Defaults to "all" if no arguments supplied.
- * @beta
- */
-export declare class TogglePrimitiveVisibilityTool extends RenderTargetDebugControlTool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    private _visibility;
-    execute(control: RenderTargetDebugControl, vp: ScreenViewport): void;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Turn on display of reality tile boundaries.
- * @beta
- */
-export declare class ToggleRealityTileBounds extends RenderTargetDebugControlToggleTool {
-    static toolId: string;
-    get aspect(): DebugControlBoolean;
-}
-/** Turn on display of reality tile preload debugging.
- * @beta
- */
-export declare class ToggleRealityTilePreload extends RenderTargetDebugControlToggleTool {
-    static toolId: string;
-    get aspect(): DebugControlBoolean;
-}
-/** Freeze loading of reality tiles.
- * @beta
- */
-export declare class ToggleRealityTileFreeze extends RenderTargetDebugControlToggleTool {
-    static toolId: string;
-    get aspect(): DebugControlBoolean;
-}
-/** Turn on logging of console tile selection and loading (to console).
- * @beta
- */
-export declare class ToggleRealityTileLogging extends RenderTargetDebugControlToggleTool {
-    static toolId: string;
-    get aspect(): DebugControlBoolean;
-}
-/** Toggles support for intersecting volume classifiers.
- * @beta
- */
-export declare class ToggleVolClassIntersect extends RenderTargetDebugControlToggleTool {
-    static toolId: string;
-    get aspect(): DebugControlBoolean;
-}
-/** Set the number of antialiasing samples to use (<=1 for no antialiasing).
- * @beta
- */
-export declare class SetAASamplesTool extends RenderTargetDebugControlTool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    private _aaSamples;
-    private _changeAll;
-    execute(_control: RenderTargetDebugControl, vp: ScreenViewport): void;
-    /** Runs this tool, setting the number of antialiasing samples to use (<=1 for no antialiasing).
-     * @param args contains the arguments used by the tool's run method: args[0] contains the number of samples; optionally args[1] can contain the word "all" in order to set those number of samples for all viewports.
-     */
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Toggles support for normal maps.
- * @beta
- */
-export declare class ToggleNormalMaps extends RenderTargetDebugControlToggleTool {
-    static toolId: string;
-    get aspect(): DebugControlBoolean;
-}
-export {};
+/** @packageDocumentation
+ * @module Tools
+ */
+import { RenderTargetDebugControl, ScreenViewport, Tool } from "@itwin/core-frontend";
+/** Executes some code against a RenderTargetDebugControl obtained from the selected viewport.
+ * @beta
+ */
+export declare abstract class RenderTargetDebugControlTool extends Tool {
+    run(_args: any[]): Promise<boolean>;
+    protected abstract execute(_control: RenderTargetDebugControl, _vp: ScreenViewport): void;
+}
+type DebugControlBoolean = "displayDrapeFrustum" | "drawForReadPixels" | "displayRealityTileRanges" | "displayRealityTileRanges" | "displayRealityTilePreload" | "freezeRealityTiles" | "logRealityTiles" | "vcSupportIntersectingVolumes" | "displayNormalMaps";
+/** Toggles some aspect of a RenderTargetDebugControl for the selected viewport.
+ * @beta
+ */
+export declare abstract class RenderTargetDebugControlToggleTool extends RenderTargetDebugControlTool {
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private _enable?;
+    protected abstract get aspect(): DebugControlBoolean;
+    protected execute(control: RenderTargetDebugControl, vp: ScreenViewport): void;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Toggles between normal rendering and rendering as if drawing to an off-screen framebuffer for element locate. Useful for debugging locate issues.
+ * @beta
+ */
+export declare class ToggleReadPixelsTool extends RenderTargetDebugControlToggleTool {
+    static toolId: string;
+    get aspect(): DebugControlBoolean;
+}
+/** Turn on the display of the draping frustum.
+ * @beta
+ */
+export declare class ToggleDrapeFrustumTool extends RenderTargetDebugControlToggleTool {
+    static toolId: string;
+    get aspect(): DebugControlBoolean;
+}
+/** Control whether all geometry renders, or only instanced or batched geometry.
+ * Allowed argument: "instanced", "batched", "all". Defaults to "all" if no arguments supplied.
+ * @beta
+ */
+export declare class TogglePrimitiveVisibilityTool extends RenderTargetDebugControlTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private _visibility;
+    execute(control: RenderTargetDebugControl, vp: ScreenViewport): void;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Turn on display of reality tile boundaries.
+ * @beta
+ */
+export declare class ToggleRealityTileBounds extends RenderTargetDebugControlToggleTool {
+    static toolId: string;
+    get aspect(): DebugControlBoolean;
+}
+/** Turn on display of reality tile preload debugging.
+ * @beta
+ */
+export declare class ToggleRealityTilePreload extends RenderTargetDebugControlToggleTool {
+    static toolId: string;
+    get aspect(): DebugControlBoolean;
+}
+/** Freeze loading of reality tiles.
+ * @beta
+ */
+export declare class ToggleRealityTileFreeze extends RenderTargetDebugControlToggleTool {
+    static toolId: string;
+    get aspect(): DebugControlBoolean;
+}
+/** Turn on logging of console tile selection and loading (to console).
+ * @beta
+ */
+export declare class ToggleRealityTileLogging extends RenderTargetDebugControlToggleTool {
+    static toolId: string;
+    get aspect(): DebugControlBoolean;
+}
+/** Toggles support for intersecting volume classifiers.
+ * @beta
+ */
+export declare class ToggleVolClassIntersect extends RenderTargetDebugControlToggleTool {
+    static toolId: string;
+    get aspect(): DebugControlBoolean;
+}
+/** Set the number of antialiasing samples to use (<=1 for no antialiasing).
+ * @beta
+ */
+export declare class SetAASamplesTool extends RenderTargetDebugControlTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private _aaSamples;
+    private _changeAll;
+    execute(_control: RenderTargetDebugControl, vp: ScreenViewport): void;
+    /** Runs this tool, setting the number of antialiasing samples to use (<=1 for no antialiasing).
+     * @param args contains the arguments used by the tool's run method: args[0] contains the number of samples; optionally args[1] can contain the word "all" in order to set those number of samples for all viewports.
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Toggles support for normal maps.
+ * @beta
+ */
+export declare class ToggleNormalMaps extends RenderTargetDebugControlToggleTool {
+    static toolId: string;
+    get aspect(): DebugControlBoolean;
+}
+export {};
 //# sourceMappingURL=RenderTargetTools.d.ts.map

package/lib/cjs/tools/RenderTargetTools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RenderTargetTools.d.ts","sourceRoot":"","sources":["../../../src/tools/RenderTargetTools.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAkC,wBAAwB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAGtH;;GAEG;AACH,8BAAsB,4BAA6B,SAAQ,IAAI;IACvC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IASzD,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,wBAAwB,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI;CAC1F;AAED,aAAK,mBAAmB,GACtB,qBAAqB,GAAG,mBAAmB,GAAG,0BAA0B,GAAG,0BAA0B,GACrG,2BAA2B,GAAG,oBAAoB,GAAG,iBAAiB,GAAG,8BAA8B,GAAG,mBAAmB,CAAC;AAEhI;;GAEG;AACH,8BAAsB,kCAAmC,SAAQ,4BAA4B;IAC3F,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAO,CAAC,OAAO,CAAC,CAAU;IAE1B,SAAS,CAAC,QAAQ,KAAK,MAAM,IAAI,mBAAmB,CAAC;IAErD,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,wBAAwB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;IAMxD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CASvE;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,kCAAkC;IAC1E,OAAuB,MAAM,SAAsB;IACnD,IAAW,MAAM,IAAI,mBAAmB,CAAgC;CACzE;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,kCAAkC;IAC5E,OAAuB,MAAM,SAAwB;IACrD,IAAW,MAAM,IAAI,mBAAmB,CAAkC;CAC3E;AAED;;;GAGG;AACH,qBAAa,6BAA8B,SAAQ,4BAA4B;IAC7E,OAAuB,MAAM,SAA+B;IAC5D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAO,CAAC,WAAW,CAA2B;IAEvC,OAAO,CAAC,OAAO,EAAE,wBAAwB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;IAKrD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAkBvE;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,kCAAkC;IAC7E,OAAuB,MAAM,SAA6B;IAC1D,IAAW,MAAM,IAAI,mBAAmB,CAAuC;CAChF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,kCAAkC;IAC9E,OAAuB,MAAM,SAA8B;IAC3D,IAAW,MAAM,IAAI,mBAAmB,CAAwC;CACjF;AACD;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,kCAAkC;IAC7E,OAAuB,MAAM,SAA6B;IAC1D,IAAW,MAAM,IAAI,mBAAmB,CAAiC;CAC1E;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,kCAAkC;IAC9E,OAAuB,MAAM,SAA8B;IAC3D,IAAW,MAAM,IAAI,mBAAmB,CAA8B;CACvE;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,kCAAkC;IAC7E,OAAuB,MAAM,SAAuB;IACpD,IAAW,MAAM,IAAI,mBAAmB,CAA2C;CACpF;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,4BAA4B;IAChE,OAAuB,MAAM,SAAkB;IAC/C,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,UAAU,CAAS;IAEpB,OAAO,CAAC,QAAQ,EAAE,wBAAwB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;IAO5E;;OAEG;IACmB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOvE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,kCAAkC;IACtE,OAAuB,MAAM,SAAsB;IACnD,IAAW,MAAM,IAAI,mBAAmB,CAAgC;CACzE"}
+{"version":3,"file":"RenderTargetTools.d.ts","sourceRoot":"","sources":["../../../src/tools/RenderTargetTools.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAkC,wBAAwB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAGtH;;GAEG;AACH,8BAAsB,4BAA6B,SAAQ,IAAI;IACvC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IASzD,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,wBAAwB,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI;CAC1F;AAED,KAAK,mBAAmB,GACtB,qBAAqB,GAAG,mBAAmB,GAAG,0BAA0B,GAAG,0BAA0B,GACrG,2BAA2B,GAAG,oBAAoB,GAAG,iBAAiB,GAAG,8BAA8B,GAAG,mBAAmB,CAAC;AAEhI;;GAEG;AACH,8BAAsB,kCAAmC,SAAQ,4BAA4B;IAC3F,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAO,CAAC,OAAO,CAAC,CAAU;IAE1B,SAAS,CAAC,QAAQ,KAAK,MAAM,IAAI,mBAAmB,CAAC;IAErD,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,wBAAwB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;IAMxD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CASvE;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,kCAAkC;IAC1E,OAAuB,MAAM,SAAsB;IACnD,IAAW,MAAM,IAAI,mBAAmB,CAAgC;CACzE;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,kCAAkC;IAC5E,OAAuB,MAAM,SAAwB;IACrD,IAAW,MAAM,IAAI,mBAAmB,CAAkC;CAC3E;AAED;;;GAGG;AACH,qBAAa,6BAA8B,SAAQ,4BAA4B;IAC7E,OAAuB,MAAM,SAA+B;IAC5D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAO,CAAC,WAAW,CAA2B;IAEvC,OAAO,CAAC,OAAO,EAAE,wBAAwB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;IAKrD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAkBvE;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,kCAAkC;IAC7E,OAAuB,MAAM,SAA6B;IAC1D,IAAW,MAAM,IAAI,mBAAmB,CAAuC;CAChF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,kCAAkC;IAC9E,OAAuB,MAAM,SAA8B;IAC3D,IAAW,MAAM,IAAI,mBAAmB,CAAwC;CACjF;AACD;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,kCAAkC;IAC7E,OAAuB,MAAM,SAA6B;IAC1D,IAAW,MAAM,IAAI,mBAAmB,CAAiC;CAC1E;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,kCAAkC;IAC9E,OAAuB,MAAM,SAA8B;IAC3D,IAAW,MAAM,IAAI,mBAAmB,CAA8B;CACvE;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,kCAAkC;IAC7E,OAAuB,MAAM,SAAuB;IACpD,IAAW,MAAM,IAAI,mBAAmB,CAA2C;CACpF;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,4BAA4B;IAChE,OAAuB,MAAM,SAAkB;IAC/C,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,UAAU,CAAS;IAEpB,OAAO,CAAC,QAAQ,EAAE,wBAAwB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;IAO5E;;OAEG;IACmB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOvE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,kCAAkC;IACtE,OAAuB,MAAM,SAAsB;IACnD,IAAW,MAAM,IAAI,mBAAmB,CAAgC;CACzE"}