@itwin/frontend-devtools 3.0.0-dev.78 → 3.0.0-dev.82

package/lib/esm/widgets/MemoryTracker.js

@@ -0,0 +1,239 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widgets
+ */
+import { assert, BeTimePoint } from "@itwin/core-bentley";
+import { DisclosedTileTreeSet, IModelApp, RenderMemory, } from "@itwin/core-frontend";
+import { createComboBox } from "../ui/ComboBox";
+function collectTileTreeMemory(stats, owner) {
+    const tree = owner.tileTree;
+    if (undefined !== tree)
+        tree.collectStatistics(stats);
+}
+// Includes None (-1) at index 0
+const memLabels = [
+    "None",
+    "Viewed Tile Trees",
+    "Selected Tiles",
+    "All Tile Trees",
+    "Render Target",
+    "Viewport",
+    "System",
+    "All",
+];
+function collectStatisticsForViewedTileTrees(vp, stats) {
+    vp.collectStatistics(stats);
+    const trees = new DisclosedTileTreeSet();
+    vp.discloseTileTrees(trees);
+    return trees.size;
+}
+function collectStatisticsForSelectedTiles(vp, stats) {
+    var _a;
+    const trees = new Set();
+    const selectedTiles = (_a = IModelApp.tileAdmin.getTilesForViewport(vp)) === null || _a === void 0 ? void 0 : _a.selected;
+    if (selectedTiles) {
+        for (const tile of selectedTiles) {
+            trees.add(tile.tree);
+            tile.collectStatistics(stats);
+        }
+    }
+    return trees.size;
+}
+function collectStatisticsForAllTileTrees(vp, stats) {
+    let numTrees = 0;
+    vp.view.iModel.tiles.forEachTreeOwner((owner) => {
+        collectTileTreeMemory(stats, owner);
+        if (undefined !== owner.tileTree)
+            ++numTrees;
+    });
+    return numTrees;
+}
+const calcMem = [
+    (stats, vp) => collectStatisticsForViewedTileTrees(vp, stats),
+    (stats, vp) => collectStatisticsForSelectedTiles(vp, stats),
+    (stats, vp) => collectStatisticsForAllTileTrees(vp, stats),
+    (stats, vp) => {
+        vp.target.collectStatistics(stats);
+        return 0;
+    },
+    (stats, vp) => {
+        vp.target.collectStatistics(stats);
+        return collectStatisticsForViewedTileTrees(vp, stats);
+    },
+    (stats, vp) => {
+        vp.target.renderSystem.collectStatistics(stats);
+        return 0;
+    },
+    (stats, vp) => {
+        vp.target.renderSystem.collectStatistics(stats);
+        for (const x of IModelApp.viewManager)
+            x.target.collectStatistics(stats);
+        return collectStatisticsForAllTileTrees(vp, stats);
+    },
+];
+// ###TODO...
+const purgeMem = [
+    undefined,
+    (olderThan) => IModelApp.viewManager.purgeTileTrees(olderThan ? olderThan : BeTimePoint.now()),
+];
+/** @internal */
+export function formatMemory(numBytes) {
+    let suffix = "b";
+    if (numBytes >= 1024) {
+        numBytes /= 1024;
+        suffix = "kb";
+        if (numBytes >= 1024) {
+            numBytes /= 1024;
+            suffix = "mb";
+        }
+    }
+    return numBytes.toFixed(2) + suffix;
+}
+class MemoryPanel {
+    constructor(parent, label, labels) {
+        this._elems = [];
+        this._label = label;
+        this._labels = labels;
+        this._div = document.createElement("div");
+        this._header = document.createElement("label");
+        this._header.style.fontWeight = "bold";
+        this._div.appendChild(this._header);
+        const numElems = labels.length;
+        for (let i = 0; i < numElems; i++) {
+            const elem = document.createElement("label");
+            this._elems.push(elem);
+            this._div.appendChild(elem);
+        }
+        parent.appendChild(this._div);
+    }
+    update(stats, total) {
+        assert(this._labels.length === stats.length);
+        assert(this._labels.length === this._elems.length);
+        this._header.innerHTML = `${this._label}: ${formatMemory(total)}`;
+        for (let i = 0; i < this._labels.length; i++) {
+            const elem = this._elems[i];
+            const stat = stats[i];
+            if (0 === stat.totalBytes) {
+                elem.style.display = "none";
+                continue;
+            }
+            elem.style.display = "block";
+            elem.innerHTML = `${this._labels[i]} (${stat.count}): ${formatMemory(stat.totalBytes)}`; // + "\n(max: " + formatMemory(stat.maxBytes) + ")";
+        }
+    }
+}
+/** Displays GPU memory allocated to tile trees - either all tile trees in the system, or only those associated with a specific Viewport.
+ * @beta
+ */
+export class MemoryTracker {
+    constructor(parent, vp) {
+        this._stats = new RenderMemory.Statistics();
+        this._memIndex = -1 /* None */;
+        this._vp = vp;
+        this._div = document.createElement("div");
+        this._div.style.display = "none";
+        this._div.style.textAlign = "right";
+        this.addSelector(parent);
+        const table = document.createElement("table");
+        table.style.width = "100%";
+        table.setAttribute("border", "1");
+        this._div.appendChild(table);
+        const row0 = document.createElement("tr");
+        const cell00 = document.createElement("td");
+        const cell01 = document.createElement("td");
+        cell00.style.width = cell01.style.width = "50%";
+        row0.appendChild(cell00);
+        row0.appendChild(cell01);
+        table.appendChild(row0);
+        const row1 = document.createElement("tr");
+        const cell10 = document.createElement("td");
+        const cell11 = document.createElement("td");
+        cell10.style.width = cell11.style.width = "50%";
+        row1.appendChild(cell10);
+        row1.appendChild(cell11);
+        table.appendChild(row1);
+        this._textures = new MemoryPanel(cell00, "Textures", ["Surface Textures", "Vertex Tables", "Feature Tables", "Feature Overrides", "Clip Volumes", "Planar Classifiers", "Shadow Maps", "Texture Attachments", "Thematic Textures"]);
+        this._buffers = new MemoryPanel(cell01, "Buffers", ["Surfaces", "Visible Edges", "Silhouettes", "Polyline Edges", "Polylines", "Point Strings", "Point Clouds", "Instances", "Terrain", "Reality Mesh"]);
+        this._totalElem = this.addStatistics(cell10);
+        this._totalTreesElem = this.addStatistics(cell11);
+        this._purgeButton = this.addPurgeButton(this._div);
+        parent.appendChild(this._div);
+    }
+    dispose() {
+        this.clearInterval();
+    }
+    addSelector(parent) {
+        const entries = [];
+        for (let i = -1 /* None */; i < 7 /* COUNT */; i++)
+            entries.push({ name: memLabels[i + 1], value: i });
+        createComboBox({
+            parent,
+            name: "Track Memory: ",
+            id: "memTracker_type",
+            value: -1 /* None */,
+            handler: (select) => this.change(Number.parseInt(select.value, 10)),
+            entries,
+        });
+    }
+    addPurgeButton(parent) {
+        const div = document.createElement("div");
+        div.style.textAlign = "center";
+        const button = document.createElement("button");
+        button.innerText = "Purge";
+        button.addEventListener("click", () => this.purge());
+        div.appendChild(button);
+        parent.appendChild(div);
+        return button;
+    }
+    addStatistics(parent) {
+        const div = document.createElement("div");
+        const text = document.createElement("text");
+        text.style.fontWeight = "bold";
+        div.appendChild(text);
+        parent.appendChild(div);
+        return text;
+    }
+    clearInterval() {
+        if (undefined !== this._curIntervalId) {
+            clearInterval(this._curIntervalId);
+            this._curIntervalId = undefined;
+        }
+    }
+    change(newIndex) {
+        if (newIndex === this._memIndex)
+            return;
+        this._memIndex = newIndex;
+        if (-1 /* None */ === newIndex) {
+            this.clearInterval();
+            this._div.style.display = "none";
+            return;
+        }
+        if (undefined === this._curIntervalId) {
+            this._curIntervalId = setInterval(() => this.update(), 1000);
+            this._div.style.display = "block";
+        }
+        this._purgeButton.disabled = undefined === purgeMem[this._memIndex];
+        this.update();
+    }
+    update() {
+        const calc = calcMem[this._memIndex];
+        this._stats.clear();
+        const numTrees = calc(this._stats, this._vp);
+        this._totalElem.innerText = `Total: ${formatMemory(this._stats.totalBytes)}`;
+        this._totalTreesElem.innerText = `Total Tile Trees: ${numTrees}`;
+        this._textures.update(this._stats.consumers, this._stats.totalBytes - this._stats.buffers.totalBytes);
+        this._buffers.update(this._stats.buffers.consumers, this._stats.buffers.totalBytes);
+    }
+    purge() {
+        const purge = purgeMem[this._memIndex];
+        if (undefined !== purge) {
+            purge();
+            this._vp.invalidateScene(); // to trigger reloading of tiles we actually do want to continue drawing
+            this.update();
+        }
+    }
+}
+//# sourceMappingURL=MemoryTracker.js.map

package/lib/esm/widgets/MemoryTracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemoryTracker.js","sourceRoot":"","sources":["../../../src/widgets/MemoryTracker.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EACL,oBAAoB,EAAE,SAAS,EAAE,YAAY,GAC9C,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAiB,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAE/D,SAAS,qBAAqB,CAAC,KAA8B,EAAE,KAAoB;IACjF,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC;IAC5B,IAAI,SAAS,KAAK,IAAI;QACpB,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;AAClC,CAAC;AAoBD,gCAAgC;AAChC,MAAM,SAAS,GAAG;IAChB,MAAM;IACN,mBAAmB;IACnB,gBAAgB;IAChB,gBAAgB;IAChB,eAAe;IACf,UAAU;IACV,QAAQ;IACR,KAAK;CACN,CAAC;AAEF,SAAS,mCAAmC,CAAC,EAAY,EAAE,KAA8B;IACvF,EAAE,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC5B,MAAM,KAAK,GAAG,IAAI,oBAAoB,EAAE,CAAC;IACzC,EAAE,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC5B,OAAO,KAAK,CAAC,IAAI,CAAC;AACpB,CAAC;AAED,SAAS,iCAAiC,CAAC,EAAY,EAAE,KAA8B;;IACrF,MAAM,KAAK,GAAG,IAAI,GAAG,EAAY,CAAC;IAClC,MAAM,aAAa,GAAG,MAAA,SAAS,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,CAAC,0CAAE,QAAQ,CAAC;IAC5E,IAAI,aAAa,EAAE;QACjB,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE;YAChC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrB,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;SAC/B;KACF;IAED,OAAO,KAAK,CAAC,IAAI,CAAC;AACpB,CAAC;AAED,SAAS,gCAAgC,CAAC,EAAY,EAAE,KAA8B;IACpF,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,KAAK,EAAE,EAAE;QAC9C,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACpC,IAAI,SAAS,KAAK,KAAK,CAAC,QAAQ;YAC9B,EAAE,QAAQ,CAAC;IACf,CAAC,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,OAAO,GAAc;IACzB,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,mCAAmC,CAAC,EAAE,EAAE,KAAK,CAAC;IAC7D,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,iCAAiC,CAAC,EAAE,EAAE,KAAK,CAAC;IAC3D,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,gCAAgC,CAAC,EAAE,EAAE,KAAK,CAAC;IAC1D,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;QACZ,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,CAAC,CAAC;IACX,CAAC;IACD,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;QACZ,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,mCAAmC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IACD,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;QACZ,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAChD,OAAO,CAAC,CAAC;IACX,CAAC;IACD,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;QACZ,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAChD,KAAK,MAAM,CAAC,IAAI,SAAS,CAAC,WAAW;YACnC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAEpC,OAAO,gCAAgC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;CACF,CAAC;AAEF,aAAa;AACb,MAAM,QAAQ,GAAgC;IAC5C,SAAS;IACT,CAAC,SAAU,EAAE,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;CAChG,CAAC;AAEF,gBAAgB;AAChB,MAAM,UAAU,YAAY,CAAC,QAAgB;IAC3C,IAAI,MAAM,GAAG,GAAG,CAAC;IACjB,IAAI,QAAQ,IAAI,IAAI,EAAE;QACpB,QAAQ,IAAI,IAAI,CAAC;QACjB,MAAM,GAAG,IAAI,CAAC;QACd,IAAI,QAAQ,IAAI,IAAI,EAAE;YACpB,QAAQ,IAAI,IAAI,CAAC;YACjB,MAAM,GAAG,IAAI,CAAC;SACf;KACF;IAED,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;AACtC,CAAC;AAED,MAAM,WAAW;IAOf,YAAmB,MAAmB,EAAE,KAAa,EAAE,MAAgB;QAJtD,WAAM,GAAkB,EAAE,CAAC;QAK1C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAE1C,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAE,CAAC;QAChD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;QAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;YACjC,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;SAC7B;QAED,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,KAA+B,EAAE,KAAa;QAC1D,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAEnD,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,GAAG,IAAI,CAAC,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QAElE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU,EAAE;gBACzB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC;gBAC5B,SAAS;aACV;YAED,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;YAC7B,IAAI,CAAC,SAAS,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,MAAM,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,oDAAoD;SAC9I;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,aAAa;IAYxB,YAAmB,MAAmB,EAAE,EAAY;QAXnC,WAAM,GAAG,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;QAIhD,cAAS,iBAAiB;QAQhC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QAEd,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,OAAO,CAAC;QAEpC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAEzB,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC9C,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;QAC3B,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAE7B,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QAChD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACzB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACzB,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAExB,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QAChD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACzB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACzB,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAExB,IAAI,CAAC,SAAS,GAAG,IAAI,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,kBAAkB,EAAE,eAAe,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,cAAc,EAAE,oBAAoB,EAAE,aAAa,EAAE,qBAAqB,EAAE,mBAAmB,CAAC,CAAC,CAAC;QACpO,IAAI,CAAC,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,gBAAgB,EAAE,WAAW,EAAE,eAAe,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;QACzM,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAElD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEnD,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,WAAW,CAAC,MAAmB;QACrC,MAAM,OAAO,GAAoB,EAAE,CAAC;QACpC,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC,gBAAiB,EAAE,CAAC,EAAE;YACjD,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAErD,cAAc,CAAC;YACb,MAAM;YACN,IAAI,EAAE,gBAAgB;YACtB,EAAE,EAAE,iBAAiB;YACrB,KAAK,eAAe;YACpB,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACnE,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAEO,cAAc,CAAC,MAAmB;QACxC,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1C,GAAG,CAAC,KAAK,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE/B,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC;QAC3B,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAErD,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACxB,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAExB,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,aAAa,CAAC,MAAmB;QACvC,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC;QAC/B,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtB,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,aAAa;QACnB,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc,EAAE;YACrC,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACnC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;SACjC;IACH,CAAC;IAEO,MAAM,CAAC,QAAkB;QAC/B,IAAI,QAAQ,KAAK,IAAI,CAAC,SAAS;YAC7B,OAAO;QAET,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,kBAAkB,QAAQ,EAAE;YAC9B,IAAI,CAAC,aAAa,EAAE,CAAC;YACrB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC;YACjC,OAAO;SACR;QAED,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc,EAAE;YACrC,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,CAAC;YAC7D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;SACnC;QAED,IAAI,CAAC,YAAY,CAAC,QAAQ,GAAG,SAAS,KAAK,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEpE,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAEO,MAAM;QACZ,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,CAAC,UAAU,CAAC,SAAS,GAAG,UAAU,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7E,IAAI,CAAC,eAAe,CAAC,SAAS,GAAG,qBAAqB,QAAQ,EAAE,CAAC;QAEjE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACtG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACtF,CAAC;IAEO,KAAK;QACX,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,SAAS,KAAK,KAAK,EAAE;YACvB,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,CAAC,wEAAwE;YACpG,IAAI,CAAC,MAAM,EAAE,CAAC;SACf;IACH,CAAC;CACF","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\n/** @packageDocumentation\n * @module Widgets\n */\n\nimport { assert, BeTimePoint } from \"@itwin/core-bentley\";\nimport {\n  DisclosedTileTreeSet, IModelApp, RenderMemory, TileTree, TileTreeOwner, Viewport,\n} from \"@itwin/core-frontend\";\nimport { ComboBoxEntry, createComboBox } from \"../ui/ComboBox\";\n\nfunction collectTileTreeMemory(stats: RenderMemory.Statistics, owner: TileTreeOwner): void {\n  const tree = owner.tileTree;\n  if (undefined !== tree)\n    tree.collectStatistics(stats);\n}\n\n// Returns the number of tile trees processed.\ntype CalcMem = (stats: RenderMemory.Statistics, vp: Viewport) => number;\ntype PurgeMem = (olderThan?: BeTimePoint) => void;\n\nconst enum MemIndex { // eslint-disable-line no-restricted-syntax\n  None = -1,\n  ViewportTileTrees,\n  SelectedTiles,\n  AllTileTrees,\n  RenderTarget,\n  // eslint-disable-next-line @typescript-eslint/no-shadow\n  Viewport, // RenderTarget + Viewed Tile Trees\n  System,\n  All, // All Tile Trees + System + (RenderTarget for each ViewManager viewport)\n\n  COUNT,\n}\n\n// Includes None (-1) at index 0\nconst memLabels = [\n  \"None\",\n  \"Viewed Tile Trees\",\n  \"Selected Tiles\",\n  \"All Tile Trees\",\n  \"Render Target\",\n  \"Viewport\",\n  \"System\",\n  \"All\",\n];\n\nfunction collectStatisticsForViewedTileTrees(vp: Viewport, stats: RenderMemory.Statistics): number {\n  vp.collectStatistics(stats);\n  const trees = new DisclosedTileTreeSet();\n  vp.discloseTileTrees(trees);\n  return trees.size;\n}\n\nfunction collectStatisticsForSelectedTiles(vp: Viewport, stats: RenderMemory.Statistics): number {\n  const trees = new Set<TileTree>();\n  const selectedTiles = IModelApp.tileAdmin.getTilesForViewport(vp)?.selected;\n  if (selectedTiles) {\n    for (const tile of selectedTiles) {\n      trees.add(tile.tree);\n      tile.collectStatistics(stats);\n    }\n  }\n\n  return trees.size;\n}\n\nfunction collectStatisticsForAllTileTrees(vp: Viewport, stats: RenderMemory.Statistics): number {\n  let numTrees = 0;\n  vp.view.iModel.tiles.forEachTreeOwner((owner) => {\n    collectTileTreeMemory(stats, owner);\n    if (undefined !== owner.tileTree)\n      ++numTrees;\n  });\n  return numTrees;\n}\n\nconst calcMem: CalcMem[] = [\n  (stats, vp) => collectStatisticsForViewedTileTrees(vp, stats),\n  (stats, vp) => collectStatisticsForSelectedTiles(vp, stats),\n  (stats, vp) => collectStatisticsForAllTileTrees(vp, stats),\n  (stats, vp) => {\n    vp.target.collectStatistics(stats);\n    return 0;\n  },\n  (stats, vp) => {\n    vp.target.collectStatistics(stats);\n    return collectStatisticsForViewedTileTrees(vp, stats);\n  },\n  (stats, vp) => {\n    vp.target.renderSystem.collectStatistics(stats);\n    return 0;\n  },\n  (stats, vp) => {\n    vp.target.renderSystem.collectStatistics(stats);\n    for (const x of IModelApp.viewManager)\n      x.target.collectStatistics(stats);\n\n    return collectStatisticsForAllTileTrees(vp, stats);\n  },\n];\n\n// ###TODO...\nconst purgeMem: Array<PurgeMem | undefined> = [\n  undefined,\n  (olderThan?) => IModelApp.viewManager.purgeTileTrees(olderThan ? olderThan : BeTimePoint.now()),\n];\n\n/** @internal */\nexport function formatMemory(numBytes: number): string {\n  let suffix = \"b\";\n  if (numBytes >= 1024) {\n    numBytes /= 1024;\n    suffix = \"kb\";\n    if (numBytes >= 1024) {\n      numBytes /= 1024;\n      suffix = \"mb\";\n    }\n  }\n\n  return numBytes.toFixed(2) + suffix;\n}\n\nclass MemoryPanel {\n  private readonly _label: string;\n  private readonly _labels: string[];\n  private readonly _elems: HTMLElement[] = [];\n  private readonly _div: HTMLDivElement;\n  private readonly _header: HTMLElement;\n\n  public constructor(parent: HTMLElement, label: string, labels: string[]) {\n    this._label = label;\n    this._labels = labels;\n    this._div = document.createElement(\"div\");\n\n    this._header = document.createElement(\"label\")!;\n    this._header.style.fontWeight = \"bold\";\n    this._div.appendChild(this._header);\n\n    const numElems = labels.length;\n    for (let i = 0; i < numElems; i++) {\n      const elem = document.createElement(\"label\");\n      this._elems.push(elem);\n      this._div.appendChild(elem);\n    }\n\n    parent.appendChild(this._div);\n  }\n\n  public update(stats: RenderMemory.Consumers[], total: number): void {\n    assert(this._labels.length === stats.length);\n    assert(this._labels.length === this._elems.length);\n\n    this._header.innerHTML = `${this._label}: ${formatMemory(total)}`;\n\n    for (let i = 0; i < this._labels.length; i++) {\n      const elem = this._elems[i];\n      const stat = stats[i];\n      if (0 === stat.totalBytes) {\n        elem.style.display = \"none\";\n        continue;\n      }\n\n      elem.style.display = \"block\";\n      elem.innerHTML = `${this._labels[i]} (${stat.count}): ${formatMemory(stat.totalBytes)}`; // + \"\\n(max: \" + formatMemory(stat.maxBytes) + \")\";\n    }\n  }\n}\n\n/** Displays GPU memory allocated to tile trees - either all tile trees in the system, or only those associated with a specific Viewport.\n * @beta\n */\nexport class MemoryTracker {\n  private readonly _stats = new RenderMemory.Statistics();\n  private readonly _vp: Viewport;\n  private readonly _div: HTMLDivElement;\n  private _curIntervalId?: NodeJS.Timer;\n  private _memIndex = MemIndex.None;\n  private readonly _totalElem: HTMLElement;\n  private readonly _totalTreesElem: HTMLElement;\n  private readonly _purgeButton: HTMLButtonElement;\n  private readonly _textures: MemoryPanel;\n  private readonly _buffers: MemoryPanel;\n\n  public constructor(parent: HTMLElement, vp: Viewport) {\n    this._vp = vp;\n\n    this._div = document.createElement(\"div\");\n    this._div.style.display = \"none\";\n    this._div.style.textAlign = \"right\";\n\n    this.addSelector(parent);\n\n    const table = document.createElement(\"table\");\n    table.style.width = \"100%\";\n    table.setAttribute(\"border\", \"1\");\n    this._div.appendChild(table);\n\n    const row0 = document.createElement(\"tr\");\n    const cell00 = document.createElement(\"td\");\n    const cell01 = document.createElement(\"td\");\n    cell00.style.width = cell01.style.width = \"50%\";\n    row0.appendChild(cell00);\n    row0.appendChild(cell01);\n    table.appendChild(row0);\n\n    const row1 = document.createElement(\"tr\");\n    const cell10 = document.createElement(\"td\");\n    const cell11 = document.createElement(\"td\");\n    cell10.style.width = cell11.style.width = \"50%\";\n    row1.appendChild(cell10);\n    row1.appendChild(cell11);\n    table.appendChild(row1);\n\n    this._textures = new MemoryPanel(cell00, \"Textures\", [\"Surface Textures\", \"Vertex Tables\", \"Feature Tables\", \"Feature Overrides\", \"Clip Volumes\", \"Planar Classifiers\", \"Shadow Maps\", \"Texture Attachments\", \"Thematic Textures\"]);\n    this._buffers = new MemoryPanel(cell01, \"Buffers\", [\"Surfaces\", \"Visible Edges\", \"Silhouettes\", \"Polyline Edges\", \"Polylines\", \"Point Strings\", \"Point Clouds\", \"Instances\", \"Terrain\", \"Reality Mesh\"]);\n    this._totalElem = this.addStatistics(cell10);\n    this._totalTreesElem = this.addStatistics(cell11);\n\n    this._purgeButton = this.addPurgeButton(this._div);\n\n    parent.appendChild(this._div);\n  }\n\n  public dispose(): void {\n    this.clearInterval();\n  }\n\n  private addSelector(parent: HTMLElement): void {\n    const entries: ComboBoxEntry[] = [];\n    for (let i = MemIndex.None; i < MemIndex.COUNT; i++)\n      entries.push({ name: memLabels[i + 1], value: i });\n\n    createComboBox({\n      parent,\n      name: \"Track Memory: \",\n      id: \"memTracker_type\",\n      value: MemIndex.None,\n      handler: (select) => this.change(Number.parseInt(select.value, 10)),\n      entries,\n    });\n  }\n\n  private addPurgeButton(parent: HTMLElement): HTMLButtonElement {\n    const div = document.createElement(\"div\");\n    div.style.textAlign = \"center\";\n\n    const button = document.createElement(\"button\");\n    button.innerText = \"Purge\";\n    button.addEventListener(\"click\", () => this.purge());\n\n    div.appendChild(button);\n    parent.appendChild(div);\n\n    return button;\n  }\n\n  private addStatistics(parent: HTMLElement): HTMLElement {\n    const div = document.createElement(\"div\");\n    const text = document.createElement(\"text\");\n    text.style.fontWeight = \"bold\";\n    div.appendChild(text);\n    parent.appendChild(div);\n    return text;\n  }\n\n  private clearInterval(): void {\n    if (undefined !== this._curIntervalId) {\n      clearInterval(this._curIntervalId);\n      this._curIntervalId = undefined;\n    }\n  }\n\n  private change(newIndex: MemIndex): void {\n    if (newIndex === this._memIndex)\n      return;\n\n    this._memIndex = newIndex;\n    if (MemIndex.None === newIndex) {\n      this.clearInterval();\n      this._div.style.display = \"none\";\n      return;\n    }\n\n    if (undefined === this._curIntervalId) {\n      this._curIntervalId = setInterval(() => this.update(), 1000);\n      this._div.style.display = \"block\";\n    }\n\n    this._purgeButton.disabled = undefined === purgeMem[this._memIndex];\n\n    this.update();\n  }\n\n  private update(): void {\n    const calc = calcMem[this._memIndex];\n    this._stats.clear();\n    const numTrees = calc(this._stats, this._vp);\n    this._totalElem.innerText = `Total: ${formatMemory(this._stats.totalBytes)}`;\n    this._totalTreesElem.innerText = `Total Tile Trees: ${numTrees}`;\n\n    this._textures.update(this._stats.consumers, this._stats.totalBytes - this._stats.buffers.totalBytes);\n    this._buffers.update(this._stats.buffers.consumers, this._stats.buffers.totalBytes);\n  }\n\n  private purge(): void {\n    const purge = purgeMem[this._memIndex];\n    if (undefined !== purge) {\n      purge();\n      this._vp.invalidateScene(); // to trigger reloading of tiles we actually do want to continue drawing\n      this.update();\n    }\n  }\n}\n"]}

package/lib/esm/widgets/TileMemoryBreakdown.d.ts

@@ -0,0 +1,31 @@
+/** @packageDocumentation
+ * @module Widgets
+ */
+/** Breaks down the GPU memory allocated to tiles into categories displayed in two panes.
+ * The left-hand pane obtains its information from [TileAdmin]($frontend), displaying the number of selected and unselected tiles that are consuming graphics memory along with the amount of memory consumed.
+ * The right-hand pane computes its information from the set of all [TileTree]($frontend)s, broken down into groups:
+ * - "Selected" - tiles that have been selected for display in at least one viewport.
+ * - "Ancestors" - tiles not selected for display, but have descendents selected for display.
+ * - "Descendants" - tiles not selected for display, but have ancestors selected for display.
+ * - "Orphans" - tiles not selected for display that have no ancestors nor descendants selected for display.
+ * - "Total" - totals of the above categories.
+ *
+ * Each row of data shows `(number of tiles) Group Name: amount of memory consumed by group`.
+ * The number of tiles in each group includes only those tiles that are consuming a non-zero amount of GPU memory.
+ * The widget includes a checkbox to toggle tracking and display of these statistics.
+ * @beta
+ */
+export declare class TileMemoryBreakdown {
+    private readonly _tracer;
+    private readonly _div;
+    private _curIntervalId?;
+    private readonly _statsElements;
+    private readonly _totalsElements;
+    /** Construct a new breakdown widget as a child of the specified parent element. */
+    constructor(parent: HTMLElement);
+    dispose(): void;
+    private toggle;
+    private clearInterval;
+    private update;
+}
+//# sourceMappingURL=TileMemoryBreakdown.d.ts.map

package/lib/esm/widgets/TileMemoryBreakdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TileMemoryBreakdown.d.ts","sourceRoot":"","sources":["../../../src/widgets/TileMemoryBreakdown.ts"],"names":[],"mappings":"AAIA;;GAEG;AAwHH;;;;;;;;;;;;;GAaG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAiB;IACtC,OAAO,CAAC,cAAc,CAAC,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqB;IACpD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqB;IAErD,mFAAmF;gBAChE,MAAM,EAAE,WAAW;IA0C/B,OAAO,IAAI,IAAI;IAItB,OAAO,CAAC,MAAM;IAWd,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,MAAM;CAyBf"}

package/lib/esm/widgets/TileMemoryBreakdown.js

@@ -0,0 +1,201 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widgets
+ */
+import { IModelApp, RenderMemory } from "@itwin/core-frontend";
+import { createCheckBox } from "../ui/CheckBox";
+import { formatMemory } from "./MemoryTracker";
+var TileMemorySelector;
+(function (TileMemorySelector) {
+    TileMemorySelector[TileMemorySelector["Selected"] = 0] = "Selected";
+    TileMemorySelector[TileMemorySelector["Ancestors"] = 1] = "Ancestors";
+    TileMemorySelector[TileMemorySelector["Descendants"] = 2] = "Descendants";
+    TileMemorySelector[TileMemorySelector["Orphaned"] = 3] = "Orphaned";
+    TileMemorySelector[TileMemorySelector["Total"] = 4] = "Total";
+    TileMemorySelector[TileMemorySelector["Count"] = 5] = "Count";
+})(TileMemorySelector || (TileMemorySelector = {}));
+class TileMemoryTracer {
+    constructor() {
+        this._stats = new RenderMemory.Statistics();
+        this._processedTiles = new Set();
+        this.counters = [];
+        this.numSelected = 0;
+        for (let i = 0; i < TileMemorySelector.Count; i++)
+            this.counters.push({ numTiles: 0, bytesUsed: 0 });
+    }
+    update() {
+        var _a;
+        this.reset();
+        const imodels = new Set();
+        const selectedTiles = new Set();
+        for (const vp of IModelApp.viewManager) {
+            imodels.add(vp.iModel);
+            const tiles = (_a = IModelApp.tileAdmin.getTilesForViewport(vp)) === null || _a === void 0 ? void 0 : _a.selected;
+            if (tiles)
+                for (const tile of tiles)
+                    selectedTiles.add(tile);
+        }
+        for (const selected of selectedTiles)
+            this.add(selected, TileMemorySelector.Selected);
+        for (const selected of selectedTiles) {
+            this.processParent(selected.parent);
+            this.processChildren(selected.children);
+        }
+        for (const imodel of imodels) {
+            imodel.tiles.forEachTreeOwner((owner) => {
+                const tree = owner.tileTree;
+                if (tree)
+                    this.processOrphan(tree.rootTile);
+            });
+        }
+        this.counters[TileMemorySelector.Total].numTiles = this.counters.reduce((accum, counter) => accum + counter.numTiles, 0);
+        this.counters[TileMemorySelector.Total].bytesUsed = this.counters.reduce((accum, counter) => accum + counter.bytesUsed, 0);
+    }
+    reset() {
+        this._processedTiles.clear();
+        this.numSelected = 0;
+        for (const counter of this.counters)
+            counter.numTiles = counter.bytesUsed = 0;
+    }
+    add(tile, selector) {
+        this._processedTiles.add(tile);
+        this._stats.clear();
+        tile.collectStatistics(this._stats, false);
+        const bytesUsed = this._stats.totalBytes;
+        if (bytesUsed > 0) {
+            const counter = this.counters[selector];
+            ++counter.numTiles;
+            counter.bytesUsed += bytesUsed;
+        }
+    }
+    processParent(parent) {
+        if (parent && !this._processedTiles.has(parent)) {
+            this.add(parent, TileMemorySelector.Ancestors);
+            this.processParent(parent.parent);
+        }
+    }
+    processChildren(children) {
+        if (!children)
+            return;
+        for (const child of children) {
+            if (!this._processedTiles.has(child)) {
+                this.add(child, TileMemorySelector.Descendants);
+                this.processChildren(child.children);
+            }
+        }
+    }
+    processOrphan(tile) {
+        if (!this._processedTiles.has(tile))
+            this.add(tile, TileMemorySelector.Orphaned);
+        const children = tile.children;
+        if (children)
+            for (const child of children)
+                this.processOrphan(child);
+    }
+}
+const statsLabels = ["Selected", "Ancestors", "Descendants", "Orphaned", "Total"];
+function format(count, label, bytesUsed) {
+    return `${count} ${label}: ${formatMemory(bytesUsed)}`;
+}
+/** Breaks down the GPU memory allocated to tiles into categories displayed in two panes.
+ * The left-hand pane obtains its information from [TileAdmin]($frontend), displaying the number of selected and unselected tiles that are consuming graphics memory along with the amount of memory consumed.
+ * The right-hand pane computes its information from the set of all [TileTree]($frontend)s, broken down into groups:
+ * - "Selected" - tiles that have been selected for display in at least one viewport.
+ * - "Ancestors" - tiles not selected for display, but have descendents selected for display.
+ * - "Descendants" - tiles not selected for display, but have ancestors selected for display.
+ * - "Orphans" - tiles not selected for display that have no ancestors nor descendants selected for display.
+ * - "Total" - totals of the above categories.
+ *
+ * Each row of data shows `(number of tiles) Group Name: amount of memory consumed by group`.
+ * The number of tiles in each group includes only those tiles that are consuming a non-zero amount of GPU memory.
+ * The widget includes a checkbox to toggle tracking and display of these statistics.
+ * @beta
+ */
+export class TileMemoryBreakdown {
+    /** Construct a new breakdown widget as a child of the specified parent element. */
+    constructor(parent) {
+        this._tracer = new TileMemoryTracer();
+        this._statsElements = [];
+        this._totalsElements = [];
+        createCheckBox({
+            parent,
+            name: "Tile Memory Breakdown",
+            id: "tileMemoryBreakdown",
+            handler: (_cb) => this.toggle(),
+        });
+        parent.appendChild(this._div = document.createElement("div"));
+        this._div.style.display = "none";
+        this._div.style.textAlign = "right";
+        const table = document.createElement("table");
+        table.style.width = "100%";
+        table.setAttribute("border", "1");
+        this._div.appendChild(table);
+        const row = document.createElement("tr");
+        const leftCell = document.createElement("td");
+        const rightCell = document.createElement("td");
+        leftCell.style.width = rightCell.style.width = "50%";
+        row.appendChild(leftCell);
+        row.appendChild(rightCell);
+        table.appendChild(row);
+        for (let i = 0; i < TileMemorySelector.Count; i++) {
+            const div = document.createElement("div");
+            const elem = document.createElement("text");
+            this._statsElements.push(elem);
+            div.appendChild(elem);
+            rightCell.appendChild(div);
+        }
+        for (let i = 0; i < 3; i++) {
+            const div = document.createElement("div");
+            const elem = document.createElement("text");
+            this._totalsElements.push(elem);
+            div.appendChild(elem);
+            leftCell.appendChild(div);
+        }
+    }
+    dispose() {
+        this.clearInterval();
+    }
+    toggle() {
+        if (undefined !== this._curIntervalId) {
+            this._div.style.display = "none";
+            this.clearInterval();
+        }
+        else {
+            this._div.style.display = "block";
+            this.update();
+            this._curIntervalId = setInterval(() => this.update(), 500);
+        }
+    }
+    clearInterval() {
+        if (undefined !== this._curIntervalId) {
+            clearInterval(this._curIntervalId);
+            this._curIntervalId = undefined;
+        }
+    }
+    update() {
+        this._tracer.update();
+        for (let i = 0; i < this._statsElements.length; i++) {
+            const counter = this._tracer.counters[i];
+            this._statsElements[i].innerText = format(counter.numTiles, statsLabels[i], counter.bytesUsed);
+        }
+        let numUnselected = 0;
+        let unselectedBytes = 0;
+        for (const unselected of IModelApp.tileAdmin.unselectedLoadedTiles) {
+            ++numUnselected;
+            unselectedBytes += unselected.bytesUsed;
+        }
+        let numSelected = 0;
+        let selectedBytes = 0;
+        for (const selected of IModelApp.tileAdmin.selectedLoadedTiles) {
+            ++numSelected;
+            selectedBytes += selected.bytesUsed;
+        }
+        this._totalsElements[0].innerText = format(numSelected, "Selected", selectedBytes);
+        this._totalsElements[1].innerText = format(numUnselected, "Unselected", unselectedBytes);
+        this._totalsElements[2].innerText = format(numSelected + numUnselected, "Total", IModelApp.tileAdmin.totalTileContentBytes);
+    }
+}
+//# sourceMappingURL=TileMemoryBreakdown.js.map

package/lib/esm/widgets/TileMemoryBreakdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TileMemoryBreakdown.js","sourceRoot":"","sources":["../../../src/widgets/TileMemoryBreakdown.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAoB,YAAY,EAAQ,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAO/C,IAAK,kBAOJ;AAPD,WAAK,kBAAkB;IACrB,mEAAQ,CAAA;IACR,qEAAS,CAAA;IACT,yEAAW,CAAA;IACX,mEAAQ,CAAA;IACR,6DAAK,CAAA;IACL,6DAAK,CAAA;AACP,CAAC,EAPI,kBAAkB,KAAlB,kBAAkB,QAOtB;AAED,MAAM,gBAAgB;IAMpB;QALiB,WAAM,GAAG,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;QACvC,oBAAe,GAAG,IAAI,GAAG,EAAQ,CAAC;QACnC,aAAQ,GAAwB,EAAE,CAAC;QAC5C,gBAAW,GAAG,CAAC,CAAC;QAGrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,KAAK,EAAE,CAAC,EAAE;YAC/C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC;IAEM,MAAM;;QACX,IAAI,CAAC,KAAK,EAAE,CAAC;QAEb,MAAM,OAAO,GAAG,IAAI,GAAG,EAAoB,CAAC;QAC5C,MAAM,aAAa,GAAG,IAAI,GAAG,EAAQ,CAAC;QACtC,KAAK,MAAM,EAAE,IAAI,SAAS,CAAC,WAAW,EAAE;YACtC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;YACvB,MAAM,KAAK,GAAG,MAAA,SAAS,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,CAAC,0CAAE,QAAQ,CAAC;YACpE,IAAI,KAAK;gBACP,KAAK,MAAM,IAAI,IAAI,KAAK;oBACtB,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SAC7B;QAED,KAAK,MAAM,QAAQ,IAAI,aAAa;YAClC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAElD,KAAK,MAAM,QAAQ,IAAI,aAAa,EAAE;YACpC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACpC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SACzC;QAED,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,KAAK,EAAE,EAAE;gBACtC,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC;gBAC5B,IAAI,IAAI;oBACN,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACtC,CAAC,CAAC,CAAC;SACJ;QAED,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QACzH,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAC7H,CAAC;IAEO,KAAK;QACX,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;QACrB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ;YACjC,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,SAAS,GAAG,CAAC,CAAC;IAC7C,CAAC;IAEO,GAAG,CAAC,IAAU,EAAE,QAA4B;QAClD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAE3C,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;QACzC,IAAI,SAAS,GAAG,CAAC,EAAE;YACjB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACxC,EAAE,OAAO,CAAC,QAAQ,CAAC;YACnB,OAAO,CAAC,SAAS,IAAI,SAAS,CAAC;SAChC;IACH,CAAC;IAEO,aAAa,CAAC,MAAwB;QAC5C,IAAI,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC/C,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;YAC/C,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SACnC;IACH,CAAC;IAEO,eAAe,CAAC,QAA4B;QAClD,IAAI,CAAC,QAAQ;YACX,OAAO;QAET,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBACpC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;gBAChD,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;aACtC;SACF;IACH,CAAC;IAEO,aAAa,CAAC,IAAU;QAC9B,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC;YACjC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAE9C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,QAAQ;YACV,KAAK,MAAM,KAAK,IAAI,QAAQ;gBAC1B,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;CACF;AAED,MAAM,WAAW,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;AAElF,SAAS,MAAM,CAAC,KAAa,EAAE,KAAa,EAAE,SAAiB;IAC7D,OAAO,GAAG,KAAK,IAAI,KAAK,KAAK,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;AACzD,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,mBAAmB;IAO9B,mFAAmF;IACnF,YAAmB,MAAmB;QAPrB,YAAO,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAGjC,mBAAc,GAAkB,EAAE,CAAC;QACnC,oBAAe,GAAkB,EAAE,CAAC;QAInD,cAAc,CAAC;YACb,MAAM;YACN,IAAI,EAAE,uBAAuB;YAC7B,EAAE,EAAE,qBAAqB;YACzB,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE;SAChC,CAAC,CAAC;QAEH,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,OAAO,CAAC;QAEpC,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC9C,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;QAC3B,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAE7B,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,SAAS,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC/C,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACrD,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC1B,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC3B,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;YACjD,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAC5C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACtB,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SAC5B;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1B,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAC5C,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACtB,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SAC3B;IACH,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,MAAM;QACZ,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc,EAAE;YACrC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC;YACjC,IAAI,CAAC,aAAa,EAAE,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;YAClC,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC,CAAC;SAC7D;IACH,CAAC;IAEO,aAAa;QACnB,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc,EAAE;YACrC,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACnC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;SACjC;IACH,CAAC;IAEO,MAAM;QACZ,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACnD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACzC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;SAChG;QAED,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,IAAI,eAAe,GAAG,CAAC,CAAC;QACxB,KAAK,MAAM,UAAU,IAAI,SAAS,CAAC,SAAS,CAAC,qBAAqB,EAAE;YAClE,EAAE,aAAa,CAAC;YAChB,eAAe,IAAI,UAAU,CAAC,SAAS,CAAC;SACzC;QAED,IAAI,WAAW,GAAG,CAAC,CAAC;QACpB,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,SAAS,CAAC,mBAAmB,EAAE;YAC9D,EAAE,WAAW,CAAC;YACd,aAAa,IAAI,QAAQ,CAAC,SAAS,CAAC;SACrC;QAED,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,CAAC,WAAW,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;QACnF,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,CAAC,aAAa,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;QACzF,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,CAAC,WAAW,GAAG,aAAa,EAAE,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAC9H,CAAC;CACF","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 Widgets\n */\n\nimport { IModelApp, IModelConnection, RenderMemory, Tile } from \"@itwin/core-frontend\";\nimport { createCheckBox } from \"../ui/CheckBox\";\nimport { formatMemory } from \"./MemoryTracker\";\n\ninterface TileMemoryCounter {\n  numTiles: number;\n  bytesUsed: number;\n}\n\nenum TileMemorySelector {\n  Selected, // Tiles selected for display by at least one viewport.\n  Ancestors, // Ancestors of selected tiles, themselves not selected for display by any viewport.\n  Descendants, // Descendants of selected tiles, themselves not selected for display by any viewport.\n  Orphaned, // Tiles not selected for display having no ancestors nor descendants selected for display.\n  Total, // Total of all the above\n  Count,\n}\n\nclass TileMemoryTracer {\n  private readonly _stats = new RenderMemory.Statistics();\n  private readonly _processedTiles = new Set<Tile>();\n  public readonly counters: TileMemoryCounter[] = [];\n  public numSelected = 0;\n\n  public constructor() {\n    for (let i = 0; i < TileMemorySelector.Count; i++)\n      this.counters.push({ numTiles: 0, bytesUsed: 0 });\n  }\n\n  public update(): void {\n    this.reset();\n\n    const imodels = new Set<IModelConnection>();\n    const selectedTiles = new Set<Tile>();\n    for (const vp of IModelApp.viewManager) {\n      imodels.add(vp.iModel);\n      const tiles = IModelApp.tileAdmin.getTilesForViewport(vp)?.selected;\n      if (tiles)\n        for (const tile of tiles)\n          selectedTiles.add(tile);\n    }\n\n    for (const selected of selectedTiles)\n      this.add(selected, TileMemorySelector.Selected);\n\n    for (const selected of selectedTiles) {\n      this.processParent(selected.parent);\n      this.processChildren(selected.children);\n    }\n\n    for (const imodel of imodels) {\n      imodel.tiles.forEachTreeOwner((owner) => {\n        const tree = owner.tileTree;\n        if (tree)\n          this.processOrphan(tree.rootTile);\n      });\n    }\n\n    this.counters[TileMemorySelector.Total].numTiles = this.counters.reduce((accum, counter) => accum + counter.numTiles, 0);\n    this.counters[TileMemorySelector.Total].bytesUsed = this.counters.reduce((accum, counter) => accum + counter.bytesUsed, 0);\n  }\n\n  private reset(): void {\n    this._processedTiles.clear();\n    this.numSelected = 0;\n    for (const counter of this.counters)\n      counter.numTiles = counter.bytesUsed = 0;\n  }\n\n  private add(tile: Tile, selector: TileMemorySelector): void {\n    this._processedTiles.add(tile);\n    this._stats.clear();\n    tile.collectStatistics(this._stats, false);\n\n    const bytesUsed = this._stats.totalBytes;\n    if (bytesUsed > 0) {\n      const counter = this.counters[selector];\n      ++counter.numTiles;\n      counter.bytesUsed += bytesUsed;\n    }\n  }\n\n  private processParent(parent: Tile | undefined): void {\n    if (parent && !this._processedTiles.has(parent)) {\n      this.add(parent, TileMemorySelector.Ancestors);\n      this.processParent(parent.parent);\n    }\n  }\n\n  private processChildren(children: Tile[] | undefined): void {\n    if (!children)\n      return;\n\n    for (const child of children) {\n      if (!this._processedTiles.has(child)) {\n        this.add(child, TileMemorySelector.Descendants);\n        this.processChildren(child.children);\n      }\n    }\n  }\n\n  private processOrphan(tile: Tile): void {\n    if (!this._processedTiles.has(tile))\n      this.add(tile, TileMemorySelector.Orphaned);\n\n    const children = tile.children;\n    if (children)\n      for (const child of children)\n        this.processOrphan(child);\n  }\n}\n\nconst statsLabels = [\"Selected\", \"Ancestors\", \"Descendants\", \"Orphaned\", \"Total\"];\n\nfunction format(count: number, label: string, bytesUsed: number): string {\n  return `${count} ${label}: ${formatMemory(bytesUsed)}`;\n}\n\n/** Breaks down the GPU memory allocated to tiles into categories displayed in two panes.\n * The left-hand pane obtains its information from [TileAdmin]($frontend), displaying the number of selected and unselected tiles that are consuming graphics memory along with the amount of memory consumed.\n * The right-hand pane computes its information from the set of all [TileTree]($frontend)s, broken down into groups:\n * - \"Selected\" - tiles that have been selected for display in at least one viewport.\n * - \"Ancestors\" - tiles not selected for display, but have descendents selected for display.\n * - \"Descendants\" - tiles not selected for display, but have ancestors selected for display.\n * - \"Orphans\" - tiles not selected for display that have no ancestors nor descendants selected for display.\n * - \"Total\" - totals of the above categories.\n *\n * Each row of data shows `(number of tiles) Group Name: amount of memory consumed by group`.\n * The number of tiles in each group includes only those tiles that are consuming a non-zero amount of GPU memory.\n * The widget includes a checkbox to toggle tracking and display of these statistics.\n * @beta\n */\nexport class TileMemoryBreakdown {\n  private readonly _tracer = new TileMemoryTracer();\n  private readonly _div: HTMLDivElement;\n  private _curIntervalId?: NodeJS.Timer;\n  private readonly _statsElements: HTMLElement[] = [];\n  private readonly _totalsElements: HTMLElement[] = [];\n\n  /** Construct a new breakdown widget as a child of the specified parent element. */\n  public constructor(parent: HTMLElement) {\n    createCheckBox({\n      parent,\n      name: \"Tile Memory Breakdown\",\n      id: \"tileMemoryBreakdown\",\n      handler: (_cb) => this.toggle(),\n    });\n\n    parent.appendChild(this._div = document.createElement(\"div\"));\n    this._div.style.display = \"none\";\n    this._div.style.textAlign = \"right\";\n\n    const table = document.createElement(\"table\");\n    table.style.width = \"100%\";\n    table.setAttribute(\"border\", \"1\");\n    this._div.appendChild(table);\n\n    const row = document.createElement(\"tr\");\n    const leftCell = document.createElement(\"td\");\n    const rightCell = document.createElement(\"td\");\n    leftCell.style.width = rightCell.style.width = \"50%\";\n    row.appendChild(leftCell);\n    row.appendChild(rightCell);\n    table.appendChild(row);\n\n    for (let i = 0; i < TileMemorySelector.Count; i++) {\n      const div = document.createElement(\"div\");\n      const elem = document.createElement(\"text\");\n      this._statsElements.push(elem);\n      div.appendChild(elem);\n      rightCell.appendChild(div);\n    }\n\n    for (let i = 0; i < 3; i++) {\n      const div = document.createElement(\"div\");\n      const elem = document.createElement(\"text\");\n      this._totalsElements.push(elem);\n      div.appendChild(elem);\n      leftCell.appendChild(div);\n    }\n  }\n\n  public dispose(): void {\n    this.clearInterval();\n  }\n\n  private toggle(): void {\n    if (undefined !== this._curIntervalId) {\n      this._div.style.display = \"none\";\n      this.clearInterval();\n    } else {\n      this._div.style.display = \"block\";\n      this.update();\n      this._curIntervalId = setInterval(() => this.update(), 500);\n    }\n  }\n\n  private clearInterval(): void {\n    if (undefined !== this._curIntervalId) {\n      clearInterval(this._curIntervalId);\n      this._curIntervalId = undefined;\n    }\n  }\n\n  private update(): void {\n    this._tracer.update();\n    for (let i = 0; i < this._statsElements.length; i++) {\n      const counter = this._tracer.counters[i];\n      this._statsElements[i].innerText = format(counter.numTiles, statsLabels[i], counter.bytesUsed);\n    }\n\n    let numUnselected = 0;\n    let unselectedBytes = 0;\n    for (const unselected of IModelApp.tileAdmin.unselectedLoadedTiles) {\n      ++numUnselected;\n      unselectedBytes += unselected.bytesUsed;\n    }\n\n    let numSelected = 0;\n    let selectedBytes = 0;\n    for (const selected of IModelApp.tileAdmin.selectedLoadedTiles) {\n      ++numSelected;\n      selectedBytes += selected.bytesUsed;\n    }\n\n    this._totalsElements[0].innerText = format(numSelected, \"Selected\", selectedBytes);\n    this._totalsElements[1].innerText = format(numUnselected, \"Unselected\", unselectedBytes);\n    this._totalsElements[2].innerText = format(numSelected + numUnselected, \"Total\", IModelApp.tileAdmin.totalTileContentBytes);\n  }\n}\n"]}

package/lib/esm/widgets/TileStatisticsTracker.d.ts

@@ -0,0 +1,22 @@
+/** @packageDocumentation
+ * @module Widgets
+ */
+import { Viewport } from "@itwin/core-frontend";
+/** Outputs statistics related to tile requests including the current number of active, pending, selected, and ready tile requests; as well as cumulative statistics for the session including the number of failed, timed-out, empty, and elided tile requests.
+ * @beta
+ */
+export declare class TileStatisticsTracker {
+    private readonly _statElements;
+    private readonly _div;
+    private readonly _vp;
+    private _curIntervalId?;
+    constructor(parent: HTMLElement, vp: Viewport);
+    dispose(): void;
+    private addMaxActive;
+    private updateMaxActive;
+    private clearInterval;
+    private toggle;
+    private update;
+    private reset;
+}
+//# sourceMappingURL=TileStatisticsTracker.d.ts.map

package/lib/esm/widgets/TileStatisticsTracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TileStatisticsTracker.d.ts","sourceRoot":"","sources":["../../../src/widgets/TileStatisticsTracker.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAwB,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAwCtE;;GAEG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAiB;IACtC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAW;IAC/B,OAAO,CAAC,cAAc,CAAC,CAAe;gBAEnB,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,QAAQ;IAgD7C,OAAO,IAAI,IAAI;IAItB,OAAO,CAAC,YAAY;IAsBpB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,MAAM;IAad,OAAO,CAAC,MAAM;IASd,OAAO,CAAC,KAAK;CAId"}